scram

package

Go to main page

Versions in this module

v1

v1.2.5

Jan 17, 2025

v1.2.4

Jan 16, 2025

v1.2.3

Dec 30, 2024

v1.2.2

Dec 27, 2024

Changes in this version

type Server

+ func (server *Server) LookupCredential(q auth.Query) (auth.Credential, bool, error)

type ServerOption

+ func WithServerCredentialStore(store auth.CredentialStore) ServerOption

v1.2.1

Sep 11, 2024

Changes in this version

+ const SHA1

+ const SHA256

+ const SHA512

+ var ErrChannelBindingNotSupported = errors.New("channel-binding-not-supported")

+ var ErrChannelBindingsDontMatch = errors.New("channel-bindings-dont-match")

+ var ErrExtensionsNotSupported = errors.New("extensions-not-supported")

+ var ErrInvalidEncoding = errors.New("invalid-encoding")

+ var ErrInvalidProof = errors.New("invalid-proof")

+ var ErrInvalidUsernameEncoding = errors.New("invalid-username-encoding")

+ var ErrNoResources = errors.New("no-resources")

+ var ErrOtherError = errors.New("other-error")

+ var ErrServerDoesSupportChannelBinding = errors.New("server-does-not-support-channel-binding")

+ var ErrUnknownUser = errors.New("unknown-user")

+ var ErrUnsupportedChannelBindingType = errors.New("unsupported-channel-binding-type")

+ func IsStandardError(err error) bool

type Message

+ func NewMessageWithError(err error) *Message

type ServerOption

+ func WithServeMechanism(mechanism string) ServerOption

v1.2.0

Sep 3, 2024

Changes in this version

+ const AuthMessageID

+ const ClientKeyID

+ const ClientProofID

+ const ClientSignatureID

+ const IterationCountID

+ const PasswordID

+ const RandomSequenceID

+ const SaltID

+ const SaltedPasswordID

+ const ServerKeyID

+ const ServerSignatureID

+ const StoredKeyID

+ const UsernameID

type Message

+ func NewMessageFromWithHeader(v any) (*Message, error)

+ func (msg *Message) StringWithoutHeader() string

type Server

+ func (server *Server) SetOptions(opts ...ServerOption) error

v1.1.1

Aug 18, 2024

v1.1.0

Aug 18, 2024

Changes in this version

type Client

+ func NewClientFromPayload(payload string) (*Client, error)

+ func NewClientFromPayloadWithHeader(payload string) (*Client, error)

+ func (client *Client) SetOptions(opts ...ClientOption) error

type ClientOption

+ func WithClientPayload(payload mech.Payload) ClientOption

type Message

+ func (msg *Message) Bytes() []byte

v1.0.0

Aug 3, 2024

Changes in this version

+ const AuthorizationIDAttr

+ const ChannelBindingDataAttr

+ const ClientProofAttr

+ const ErrorAttr

+ const FutureExtensibilityAttr

+ const IterationCountAttr

+ const RandomSequenceAttr

+ const SaltAttr

+ const ServerSignatureAttr

+ const UserNameAttr

+ var ErrAuthorization = errors.New("authorization error")

+ var ErrInvalidAttribute = errors.New("invalid attribute")

+ var ErrInvalidMessage = errors.New("invalid message")

+ func AuthMessage(...) string

+ func ClientKey(h HashFunc, saltedPassword []byte) []byte

+ func ClientProof(clientKey, clientSignature string) []byte

+ func ClientSignature(h HashFunc, storedKey, authMessage string) []byte

+ func H(hf HashFunc, data []byte) []byte

+ func HMAC(h HashFunc, key []byte, data []byte) []byte

+ func Hi(h HashFunc, str string, salt []byte, i int) []byte

+ func SaltedPassword(h HashFunc, password string, salt []byte, i int) ([]byte, error)

+ func ServerKey(h HashFunc, saltedPassword string) []byte

+ func ServerSignature(h HashFunc, serverKey, authMessage string) []byte

+ func StoredKey(h HashFunc, clientKey []byte) []byte

+ func XOR(a, b []byte) []byte

+ type Attribute interface

+ Name func() string

+ Value func() string

+ func NewAttribute(name, value string) Attribute

+ type AttributeMap struct

+ func NewAttributeMap() AttributeMap

+ func (m *AttributeMap) Attribute(name string) (string, bool)

+ func (m *AttributeMap) AuthorizationID() (string, bool)

+ func (m *AttributeMap) ChannelBindingData() (string, bool)

+ func (m *AttributeMap) ClientProof() ([]byte, bool)

+ func (m *AttributeMap) DecodeAttribute(name string) ([]byte, bool)

+ func (m *AttributeMap) EncodeAttribute(name string, value []byte)

+ func (m *AttributeMap) Equals(other AttributeMap) bool

+ func (m *AttributeMap) Error() (string, bool)

+ func (m *AttributeMap) FutureFutureExtensibility() (string, bool)

+ func (m *AttributeMap) IterationCount() (int, bool)

+ func (m *AttributeMap) RandomSequence() (string, bool)

+ func (m *AttributeMap) Salt() ([]byte, bool)

+ func (m *AttributeMap) ServerSignature() ([]byte, bool)

+ func (m *AttributeMap) SetAttribute(name, value string)

+ func (m *AttributeMap) SetChannelBindingData(value string)

+ func (m *AttributeMap) SetClientProof(value []byte)

+ func (m *AttributeMap) SetError(value string)

+ func (m *AttributeMap) SetFutureExtensibility(value string)

+ func (m *AttributeMap) SetIterationCount(value int)

+ func (m *AttributeMap) SetRandomSequence(value string)

+ func (m *AttributeMap) SetSalt(value string)

+ func (m *AttributeMap) SetSaltBytes(value []byte)

+ func (m *AttributeMap) SetServerSignature(value []byte)

+ func (m *AttributeMap) SetUsername(value string)

+ func (m *AttributeMap) String() string

+ func (m *AttributeMap) StringWithoutProof() string

+ func (m *AttributeMap) Username() (string, bool)

+ type Client struct

+ func NewClient(opts ...ClientOption) (*Client, error)

+ func NewClientFromMessage(msgStr string) (*Client, error)

+ func NewClientFromMessageWithHeader(msgStr string) (*Client, error)

+ func (client *Client) FinalMessageFrom(serverFirstMsg *Message) (*Message, error)

+ func (client *Client) FirstMessage() (*Message, error)

+ func (client *Client) HashFunc() HashFunc

+ func (client *Client) SetOption(opts ...ClientOption) error

+ func (client *Client) ValidateServerFinalMessage(serverFinalMsg *Message) error

+ type ClientOption func(*Client) error

+ func WithClientAuthzID(authzID string) ClientOption

+ func WithClientChallenge(challenge string) ClientOption

+ func WithClientHashFunc(hashFunc HashFunc) ClientOption

+ func WithClientPassword(password string) ClientOption

+ func WithClientRandomSequence(randomSequence string) ClientOption

+ func WithClientUsername(username string) ClientOption

+ type HashFunc = func() hash.Hash

+ func HashSHA1() HashFunc

+ func HashSHA256() HashFunc

+ func HashSHA512() HashFunc

+ type Message struct

+ func NewMessage(opts ...MessageOption) *Message

+ func NewMessageFrom(v any) (*Message, error)

+ func NewMessageFromError(err error) *Message

+ func NewMessageFromString(msg string) (*Message, error)

+ func NewMessageFromStringWithHeader(msg string) (*Message, error)

+ func (msg *Message) Equals(other *Message) bool

+ func (msg *Message) HasHeader() bool

+ func (msg *Message) ParseString(str string) error

+ func (msg *Message) ParseStringWithHeader(str string) error

+ func (msg *Message) ParseStrings(props []string) error

+ func (msg *Message) ParseStringsWithHeader(props []string) error

+ func (msg *Message) String() string

+ func (msg *Message) StringWithoutProof() string

+ type MessageOption func(*Message)

+ func WithAttribute(name, value string) MessageOption

+ func WithHeader(header *gss.Header) MessageOption

+ type Server struct

+ func NewServer(opts ...ServerOption) (*Server, error)

+ func (server *Server) FinalMessageFrom(clienttMsg *Message) (*Message, error)

+ func (server *Server) FirstMessageFrom(clientMsg *Message) (*Message, error)

+ func (server *Server) HashFunc() HashFunc

+ func (server *Server) SetOption(opts ...ServerOption) error

+ type ServerOption func(*Server) error

+ func WithServerAuthenticators(authenticators cred.Authenticators) ServerOption

+ func WithServerHashFunc(hashFunc HashFunc) ServerOption

+ func WithServerIterationCount(iterationCount int) ServerOption

+ func WithServerRandomSequence(randomSequence string) ServerOption

+ func WithServerSaltString(salt string) ServerOption

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL