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
|
// 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 session
import (
"context"
"encoding/base64"
"fmt"
"net/http"
"github.com/apache/arrow-go/v18/arrow/flight"
"google.golang.org/protobuf/proto"
)
const StatelessSessionCookieName string = "arrow_flight_session"
// NewStatelessServerSessionManager creates a new StatelessServerSessionManager.
//
// The tokens it produces contain the entire session state, so sessions can
// be maintained across multiple backends.
// Token contents are considered opaque but are NOT encrypted.
func NewStatelessServerSessionManager() *statelessServerSessionManager {
return &statelessServerSessionManager{}
}
type statelessServerSessionManager struct{}
func (manager *statelessServerSessionManager) CreateSession(ctx context.Context) (ServerSession, error) {
return NewStatelessServerSession(nil), nil
}
func (manager *statelessServerSessionManager) GetSession(ctx context.Context) (ServerSession, error) {
session, err := GetSessionFromContext(ctx)
if err == nil {
return session, nil
}
session, err = getSessionFromIncomingCookie(ctx)
if err == nil {
return session, err
}
if err == http.ErrNoCookie {
return nil, ErrNoSession
}
return nil, fmt.Errorf("failed to get current session from cookie: %w", err)
}
func (manager *statelessServerSessionManager) CloseSession(session ServerSession) error {
return nil
}
// NewStatelessServerSession creates a new instance of a server session that can serialize its entire state.
// A map is provided containing the initial state. If it is nil, a new empty state will be created.
func NewStatelessServerSession(options map[string]*flight.SessionOptionValue) *statelessServerSession {
if options == nil {
options = make(map[string]*flight.SessionOptionValue)
}
return &statelessServerSession{
serverSession: serverSession{options: options},
}
}
type statelessServerSession struct {
serverSession
}
// First encode session contents using protobuf binary marshaller.
// Then base64 encode the resulting bytes for client compatibility.
func (session *statelessServerSession) Token() string {
session.mu.RLock()
defer session.mu.RUnlock()
payload := flight.GetSessionOptionsResult{SessionOptions: session.options}
b, err := proto.Marshal(&payload)
if err != nil {
panic(fmt.Sprintf("failed to marshal stateless token: %s", err))
}
return base64.StdEncoding.EncodeToString(b)
}
// Reconstruct the session from its fully encoded token representation
func decodeStatelessToken(token string) (*statelessServerSession, error) {
decoded, err := base64.StdEncoding.DecodeString(token)
if err != nil {
return nil, err
}
var parsed flight.GetSessionOptionsResult
if err := proto.Unmarshal(decoded, &parsed); err != nil {
return nil, err
}
return NewStatelessServerSession(parsed.SessionOptions), nil
}
// Check the provided context for a cookie in the incoming gRPC metadata containing the
// stateless session token. Decode the token payload to reconstruct the session.
func getSessionFromIncomingCookie(ctx context.Context) (*statelessServerSession, error) {
cookie, err := GetIncomingCookieByName(ctx, StatelessSessionCookieName)
if err != nil {
return nil, err
}
return decodeStatelessToken(cookie.Value)
}
|