1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
|
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package flight
import (
"context"
"encoding/base64"
"strings"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/metadata"
"google.golang.org/grpc/status"
)
const (
grpcAuthHeader = "auth-token-bin"
basicAuthHeader = "authorization"
basicAuthPrefix = "Basic"
bearerTokenPrefix = "Bearer"
)
// AuthConn wraps the stream from grpc for handshakes to simplify handling
// handshake request and response from the flight.proto forwarding just the
// payloads and errors instead of having to deal with the handshake request
// and response protos directly
type AuthConn interface {
Read() ([]byte, error)
Send([]byte) error
}
type serverAuthConn struct {
stream FlightService_HandshakeServer
}
func (a *serverAuthConn) Read() ([]byte, error) {
in, err := a.stream.Recv()
if err != nil {
return nil, err
}
return in.Payload, nil
}
func (a *serverAuthConn) Send(b []byte) error {
return a.stream.Send(&HandshakeResponse{Payload: b})
}
// ServerAuthHandler defines an interface for the server to perform the handshake.
// The token is expected to be sent as part of the context metadata in subsequent
// requests with a key of "auth-token-bin" which will then call IsValid to validate
type ServerAuthHandler interface {
Authenticate(AuthConn) error
IsValid(token string) (interface{}, error)
}
type authCtxKey struct{}
type wrappedStream struct {
grpc.ServerStream
ctx context.Context
}
func (a *wrappedStream) Context() context.Context { return a.ctx }
// AuthFromContext will return back whatever object was returned from `IsValid` for a
// given request context allowing handlers to retrieve identifying information
// for the current request for use.
func AuthFromContext(ctx context.Context) interface{} {
return ctx.Value(authCtxKey{})
}
type serverWithAuthHandler interface {
GetAuthHandler() ServerAuthHandler
}
func serverAuthUnaryInterceptor(ctx context.Context, req interface{}, srv *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (interface{}, error) {
var auth ServerAuthHandler
if s, ok := srv.Server.(serverWithAuthHandler); ok {
auth = s.GetAuthHandler()
}
if auth == nil {
return handler(ctx, req)
}
var authTok string
md, ok := metadata.FromIncomingContext(ctx)
if ok {
vals := md.Get(grpcAuthHeader)
if len(vals) > 0 {
authTok = vals[0]
}
}
peerIdentity, err := auth.IsValid(authTok)
if err != nil {
return nil, status.Errorf(codes.PermissionDenied, "auth-error: %s", err)
}
return handler(context.WithValue(ctx, authCtxKey{}, peerIdentity), req)
}
func serverAuthStreamInterceptor(srv interface{}, stream grpc.ServerStream, info *grpc.StreamServerInfo, handler grpc.StreamHandler) error {
var auth ServerAuthHandler
if s, ok := srv.(serverWithAuthHandler); ok {
auth = s.GetAuthHandler()
}
if strings.HasSuffix(info.FullMethod, "/Handshake") || auth == nil {
return handler(srv, stream)
}
var authTok string
md, ok := metadata.FromIncomingContext(stream.Context())
if ok {
vals := md.Get(grpcAuthHeader)
if len(vals) > 0 {
authTok = vals[0]
}
}
peerIdentity, err := auth.IsValid(authTok)
if err != nil {
return status.Errorf(codes.Unauthenticated, "auth-error: %s", err)
}
stream = &wrappedStream{ServerStream: stream, ctx: context.WithValue(stream.Context(), authCtxKey{}, peerIdentity)}
return handler(srv, stream)
}
type BasicAuthValidator interface {
Validate(username, password string) (string, error)
IsValid(bearerToken string) (interface{}, error)
}
func createServerBearerTokenUnaryInterceptor(validator BasicAuthValidator) grpc.UnaryServerInterceptor {
return func(ctx context.Context, req interface{}, _ *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (interface{}, error) {
var auth string
md, ok := metadata.FromIncomingContext(ctx)
if ok {
vals := md.Get(basicAuthHeader)
if len(vals) > 0 && strings.HasPrefix(vals[0], bearerTokenPrefix) {
auth = vals[0][len(bearerTokenPrefix)+1:]
}
}
identity, err := validator.IsValid(auth)
if err != nil {
return nil, err
}
return handler(context.WithValue(ctx, authCtxKey{}, identity), req)
}
}
func createServerBearerTokenStreamInterceptor(validator BasicAuthValidator) grpc.StreamServerInterceptor {
return func(srv interface{}, stream grpc.ServerStream, info *grpc.StreamServerInfo, handler grpc.StreamHandler) error {
var auth []string
md, ok := metadata.FromIncomingContext(stream.Context())
if ok {
auth = md.Get(basicAuthHeader)
if len(auth) > 0 {
auth = strings.Split(auth[0], " ")
}
}
if len(auth) == 0 {
return status.Error(codes.Unauthenticated, "must authenticate first")
}
if strings.HasSuffix(info.FullMethod, "/Handshake") {
if auth[0] == basicAuthPrefix {
val, err := base64.RawStdEncoding.DecodeString(auth[1])
if err != nil {
val, err = base64.StdEncoding.DecodeString(auth[1])
if err != nil {
return status.Errorf(codes.Unauthenticated, "invalid basic auth encoding: %s", err)
}
}
creds := strings.SplitN(string(val), ":", 2)
token, err := validator.Validate(creds[0], creds[1])
if err != nil {
return err
}
stream.SetTrailer(metadata.New(map[string]string{basicAuthHeader: strings.Join([]string{bearerTokenPrefix, token}, " ")}))
return handler(srv, stream)
}
return status.Errorf(codes.Unauthenticated, "only Basic Auth implemented")
}
if auth[0] == bearerTokenPrefix {
identity, err := validator.IsValid(auth[1])
if err != nil {
return err
}
return handler(srv, &wrappedStream{ServerStream: stream, ctx: context.WithValue(stream.Context(), authCtxKey{}, identity)})
}
return status.Errorf(codes.Unauthenticated, "Only bearer token auth implemented")
}
}
// CreateServerBearerTokenAuthInterceptors returns grpc interceptors for basic auth handling
// via bearer tokens. validator cannot be nil
//
// Deprecated: use CreateServerBasicAuthMiddleware instead
func CreateServerBearerTokenAuthInterceptors(validator BasicAuthValidator) (grpc.UnaryServerInterceptor, grpc.StreamServerInterceptor) {
if validator == nil {
panic("validator cannot be nil")
}
return createServerBearerTokenUnaryInterceptor(validator), createServerBearerTokenStreamInterceptor(validator)
}
// CreateServerBasicAuthMiddleware returns a ServerMiddleware that can be passed to NewServerWithMiddleware
// in order to automatically add interceptors which will properly enforce auth validation
// as per the passed in BasicAuthValidator.
//
// validator cannot be nil.
func CreateServerBasicAuthMiddleware(validator BasicAuthValidator) ServerMiddleware {
if validator == nil {
panic("validator cannot be nil")
}
return ServerMiddleware{
Unary: createServerBearerTokenUnaryInterceptor(validator),
Stream: createServerBearerTokenStreamInterceptor(validator),
}
}
|