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 246 247 248 249 250 251 252 253 254 255 256 257 258 259
|
package amqp
import (
"context"
"fmt"
"github.com/Azure/go-amqp/internal/debug"
"github.com/Azure/go-amqp/internal/encoding"
"github.com/Azure/go-amqp/internal/frames"
)
// SASL Mechanisms
const (
saslMechanismPLAIN encoding.Symbol = "PLAIN"
saslMechanismANONYMOUS encoding.Symbol = "ANONYMOUS"
saslMechanismEXTERNAL encoding.Symbol = "EXTERNAL"
saslMechanismXOAUTH2 encoding.Symbol = "XOAUTH2"
)
// SASLType represents a SASL configuration to use during authentication.
type SASLType func(c *Conn) error
// ConnSASLPlain enables SASL PLAIN authentication for the connection.
//
// SASL PLAIN transmits credentials in plain text and should only be used
// on TLS/SSL enabled connection.
func SASLTypePlain(username, password string) SASLType {
// TODO: how widely used is hostname? should it be supported
return func(c *Conn) error {
// make handlers map if no other mechanism has
if c.saslHandlers == nil {
c.saslHandlers = make(map[encoding.Symbol]stateFunc)
}
// add the handler the the map
c.saslHandlers[saslMechanismPLAIN] = func(ctx context.Context) (stateFunc, error) {
// send saslInit with PLAIN payload
init := &frames.SASLInit{
Mechanism: "PLAIN",
InitialResponse: []byte("\x00" + username + "\x00" + password),
Hostname: "",
}
fr := frames.Frame{
Type: frames.TypeSASL,
Body: init,
}
debug.Log(1, "TX (ConnSASLPlain %p): %s", c, fr)
timeout, err := c.getWriteTimeout(ctx)
if err != nil {
return nil, err
}
if err = c.writeFrame(timeout, fr); err != nil {
return nil, err
}
// go to c.saslOutcome to handle the server response
return c.saslOutcome, nil
}
return nil
}
}
// ConnSASLAnonymous enables SASL ANONYMOUS authentication for the connection.
func SASLTypeAnonymous() SASLType {
return func(c *Conn) error {
// make handlers map if no other mechanism has
if c.saslHandlers == nil {
c.saslHandlers = make(map[encoding.Symbol]stateFunc)
}
// add the handler the the map
c.saslHandlers[saslMechanismANONYMOUS] = func(ctx context.Context) (stateFunc, error) {
init := &frames.SASLInit{
Mechanism: saslMechanismANONYMOUS,
InitialResponse: []byte("anonymous"),
}
fr := frames.Frame{
Type: frames.TypeSASL,
Body: init,
}
debug.Log(1, "TX (ConnSASLAnonymous %p): %s", c, fr)
timeout, err := c.getWriteTimeout(ctx)
if err != nil {
return nil, err
}
if err = c.writeFrame(timeout, fr); err != nil {
return nil, err
}
// go to c.saslOutcome to handle the server response
return c.saslOutcome, nil
}
return nil
}
}
// ConnSASLExternal enables SASL EXTERNAL authentication for the connection.
// The value for resp is dependent on the type of authentication (empty string is common for TLS).
// See https://datatracker.ietf.org/doc/html/rfc4422#appendix-A for additional info.
func SASLTypeExternal(resp string) SASLType {
return func(c *Conn) error {
// make handlers map if no other mechanism has
if c.saslHandlers == nil {
c.saslHandlers = make(map[encoding.Symbol]stateFunc)
}
// add the handler the the map
c.saslHandlers[saslMechanismEXTERNAL] = func(ctx context.Context) (stateFunc, error) {
init := &frames.SASLInit{
Mechanism: saslMechanismEXTERNAL,
InitialResponse: []byte(resp),
}
fr := frames.Frame{
Type: frames.TypeSASL,
Body: init,
}
debug.Log(1, "TX (ConnSASLExternal %p): %s", c, fr)
timeout, err := c.getWriteTimeout(ctx)
if err != nil {
return nil, err
}
if err = c.writeFrame(timeout, fr); err != nil {
return nil, err
}
// go to c.saslOutcome to handle the server response
return c.saslOutcome, nil
}
return nil
}
}
// ConnSASLXOAUTH2 enables SASL XOAUTH2 authentication for the connection.
//
// The saslMaxFrameSizeOverride parameter allows the limit that governs the maximum frame size this client will allow
// itself to generate to be raised for the sasl-init frame only. Set this when the size of the size of the SASL XOAUTH2
// initial client response (which contains the username and bearer token) would otherwise breach the 512 byte min-max-frame-size
// (http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-transport-v1.0-os.html#definition-MIN-MAX-FRAME-SIZE). Pass -1
// to keep the default.
//
// SASL XOAUTH2 transmits the bearer in plain text and should only be used
// on TLS/SSL enabled connection.
func SASLTypeXOAUTH2(username, bearer string, saslMaxFrameSizeOverride uint32) SASLType {
return func(c *Conn) error {
// make handlers map if no other mechanism has
if c.saslHandlers == nil {
c.saslHandlers = make(map[encoding.Symbol]stateFunc)
}
response, err := saslXOAUTH2InitialResponse(username, bearer)
if err != nil {
return err
}
handler := saslXOAUTH2Handler{
conn: c,
maxFrameSizeOverride: saslMaxFrameSizeOverride,
response: response,
}
// add the handler the the map
c.saslHandlers[saslMechanismXOAUTH2] = handler.init
return nil
}
}
type saslXOAUTH2Handler struct {
conn *Conn
maxFrameSizeOverride uint32
response []byte
errorResponse []byte // https://developers.google.com/gmail/imap/xoauth2-protocol#error_response
}
func (s saslXOAUTH2Handler) init(ctx context.Context) (stateFunc, error) {
originalPeerMaxFrameSize := s.conn.peerMaxFrameSize
if s.maxFrameSizeOverride > s.conn.peerMaxFrameSize {
s.conn.peerMaxFrameSize = s.maxFrameSizeOverride
}
timeout, err := s.conn.getWriteTimeout(ctx)
if err != nil {
return nil, err
}
err = s.conn.writeFrame(timeout, frames.Frame{
Type: frames.TypeSASL,
Body: &frames.SASLInit{
Mechanism: saslMechanismXOAUTH2,
InitialResponse: s.response,
},
})
s.conn.peerMaxFrameSize = originalPeerMaxFrameSize
if err != nil {
return nil, err
}
return s.step, nil
}
func (s saslXOAUTH2Handler) step(ctx context.Context) (stateFunc, error) {
// read challenge or outcome frame
fr, err := s.conn.readFrame()
if err != nil {
return nil, err
}
switch v := fr.Body.(type) {
case *frames.SASLOutcome:
// check if auth succeeded
if v.Code != encoding.CodeSASLOK {
return nil, fmt.Errorf("SASL XOAUTH2 auth failed with code %#00x: %s : %s",
v.Code, v.AdditionalData, s.errorResponse)
}
// return to c.negotiateProto
s.conn.saslComplete = true
return s.conn.negotiateProto, nil
case *frames.SASLChallenge:
if s.errorResponse == nil {
s.errorResponse = v.Challenge
timeout, err := s.conn.getWriteTimeout(ctx)
if err != nil {
return nil, err
}
// The SASL protocol requires clients to send an empty response to this challenge.
err = s.conn.writeFrame(timeout, frames.Frame{
Type: frames.TypeSASL,
Body: &frames.SASLResponse{
Response: []byte{},
},
})
if err != nil {
return nil, err
}
return s.step, nil
} else {
return nil, fmt.Errorf("SASL XOAUTH2 unexpected additional error response received during "+
"exchange. Initial error response: %s, additional response: %s", s.errorResponse, v.Challenge)
}
default:
return nil, fmt.Errorf("sasl: unexpected frame type %T", fr.Body)
}
}
func saslXOAUTH2InitialResponse(username string, bearer string) ([]byte, error) {
if len(bearer) == 0 {
return []byte{}, fmt.Errorf("unacceptable bearer token")
}
for _, char := range bearer {
if char < '\x20' || char > '\x7E' {
return []byte{}, fmt.Errorf("unacceptable bearer token")
}
}
for _, char := range username {
if char == '\x01' {
return []byte{}, fmt.Errorf("unacceptable username")
}
}
return []byte("user=" + username + "\x01auth=Bearer " + bearer + "\x01\x01"), nil
}
|