saslerr

Documentation

Overview

Package saslerr provides error conditions for the XMPP profile of SASL as defined by RFC 6120 §6.5.

Index

• type Condition
  • func (c Condition) MarshalXML(e *xml.Encoder, start xml.StartElement) error
  • func (i Condition) String() string
  • func (c Condition) TokenReader() xml.TokenReader
  • func (c *Condition) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error
  • func (c Condition) WriteXML(w xmlstream.TokenWriter) (int, error)
• type Error
  • func (f Error) Error() string
  • func (f Error) MarshalXML(e *xml.Encoder, start xml.StartElement) error
  • func (f Error) TokenReader() xml.TokenReader
  • func (f *Error) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error
  • func (f Error) WriteXML(w xmlstream.TokenWriter) (int, error)

Types

type Condition

type Condition uint16

Condition represents a SASL error condition that can be encapsulated by a <failure/> element.

const (
	// None is a special condition that is used only if a defined condition was
	// not present. Its use violates the spec.
	ConditionNone                 Condition = iota // none
	ConditionAborted                               // aborted
	ConditionAccountDisabled                       // account-disabled
	ConditionCredentialsExpired                    // credentials-expired
	ConditionEncryptionRequired                    // encryption-required
	ConditionIncorrectEncoding                     // incorrect-encoding
	ConditionInvalidAuthzID                        // invalid-authzid
	ConditionInvalidMechanism                      // invalid-mechanism
	ConditionMalformedRequest                      // malformed-request
	ConditionMechanismTooWeak                      // mechanism-too-weak
	ConditionNotAuthorized                         // not-authorized
	ConditionTemporaryAuthFailure                  // temporary-auth-failure
)

Standard SASL error conditions.

func (Condition) MarshalXML

func (c Condition) MarshalXML(e *xml.Encoder, start xml.StartElement) error

MarshalXML satisfies the xml.Marshaler interface for a Failure.

func (Condition) String

func (i Condition) String() string

func (Condition) TokenReader

func (c Condition) TokenReader() xml.TokenReader

TokenReader implements the xmlstream.Marshaler interface.

func (*Condition) UnmarshalXML

func (c *Condition) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

UnmarshalXML satisfies the xml.Unmarshaler interface.

func (Condition) WriteXML

func (c Condition) WriteXML(w xmlstream.TokenWriter) (int, error)

WriteXML implements the xmlstream.WriterTo interface.

type Error

type Error struct {
	Condition Condition
	Lang      string
	Text      string
}

Error represents a SASL error that is marshalable to XML.

func (Error) Error

func (f Error) Error() string

Error satisfies the error interface for a Failure. It returns the text string if set, or the condition otherwise.

func (Error) MarshalXML

func (f Error) MarshalXML(e *xml.Encoder, start xml.StartElement) error

MarshalXML satisfies the xml.Marshaler interface for a Failure.

func (Error) TokenReader

func (f Error) TokenReader() xml.TokenReader

TokenReader implements the xmlstream.Marshaler interface.

func (*Error) UnmarshalXML

func (f *Error) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

UnmarshalXML satisfies the xml.Unmarshaler interface for a Failure.

If multiple text elements are present in the XML, UnmarshalXML selects the text element with an xml:lang attribute that exactly matches the language tag. If no language tag in the XML matches the behavior is undefined and may change at a later date or depending on the server order of tags.

func (Error) WriteXML

func (f Error) WriteXML(w xmlstream.TokenWriter) (int, error)

WriteXML implements the xmlstream.WriterTo interface.