Clean-up & refactor

stanza/sasl_auth.go

@@ -3,8 +3,20 @@ package stanza
 import "encoding/xml"
 
 // ============================================================================
-// SASLSuccess
 
+// SASLAuth implements SASL Authentication initiation.
+// Reference: https://tools.ietf.org/html/rfc6120#section-6.4.2
+type SASLAuth struct {
+	XMLName   xml.Name `xml:"urn:ietf:params:xml:ns:xmpp-sasl auth"`
+	Mechanism string   `xml:"mechanism,attr"`
+	Value     string   `xml:",innerxml"`
+}
+
+// ============================================================================
+
+// SASLSuccess implements SASL Success nonza, sent by server as a result of the
+// SASL auth negotiation.
+// Reference: https://tools.ietf.org/html/rfc6120#section-6.4.6
 type SASLSuccess struct {
 	XMLName xml.Name `xml:"urn:ietf:params:xml:ns:xmpp-sasl success"`
 }
@@ -13,6 +25,7 @@ func (SASLSuccess) Name() string {
 	return "sasl:success"
 }
 
+// SASLSuccess decoding
 type saslSuccessDecoder struct{}
 
 var saslSuccess saslSuccessDecoder
@@ -24,8 +37,8 @@ func (saslSuccessDecoder) decode(p *xml.Decoder, se xml.StartElement) (SASLSucce
 }
 
 // ============================================================================
-// SASLFailure
 
+// SASLFailure
 type SASLFailure struct {
 	XMLName xml.Name `xml:"urn:ietf:params:xml:ns:xmpp-sasl failure"`
 	Any     xml.Name // error reason is a subelement
@@ -35,6 +48,7 @@ func (SASLFailure) Name() string {
 	return "sasl:failure"
 }
 
+// SASLFailure decoding
 type saslFailureDecoder struct{}
 
 var saslFailure saslFailureDecoder
@@ -45,35 +59,46 @@ func (saslFailureDecoder) decode(p *xml.Decoder, se xml.StartElement) (SASLFailu
 	return packet, err
 }
 
-// ============================================================================
+// ===========================================================================
+// Resource binding
 
-type Auth struct {
-	XMLName   xml.Name `xml:"urn:ietf:params:xml:ns:xmpp-sasl auth"`
-	Mechanism string   `xml:"mecanism,attr"`
-	Value     string   `xml:",innerxml"`
-}
-
-type BindBind struct {
+// Bind is an IQ payload used during session negotiation to bind user resource
+// to the current XMPP stream.
+// Reference: https://tools.ietf.org/html/rfc6120#section-7
+type Bind struct {
 	XMLName  xml.Name `xml:"urn:ietf:params:xml:ns:xmpp-bind bind"`
 	Resource string   `xml:"resource,omitempty"`
 	Jid      string   `xml:"jid,omitempty"`
 }
 
-func (b *BindBind) Namespace() string {
+func (b *Bind) Namespace() string {
 	return b.XMLName.Space
 }
 
-// Session is obsolete in RFC 6121.
-// Added for compliance with RFC 3121.
-// Remove when ejabberd purely conforms to RFC 6121.
-type sessionSession struct {
+// ============================================================================
+// Session (Obsolete)
+
+// Session is both a stream feature and an obsolete IQ Payload, used to bind a
+// resource to the current XMPP stream on RFC 3121 only XMPP servers.
+// Session is obsolete in RFC 6121. It is added to Fluux XMPP for compliance
+// with RFC 3121.
+// Reference: https://xmpp.org/rfcs/rfc3921.html#session
+//
+// This is the draft defining how to handle the transition:
+//    https://tools.ietf.org/html/draft-cridland-xmpp-session-01
+type StreamSession struct {
 	XMLName  xml.Name `xml:"urn:ietf:params:xml:ns:xmpp-session session"`
-	Optional xml.Name // If it does exist, it mean we are not required to open session
+	Optional bool     // If element does exist, it mean we are not required to open session
+}
+
+func (s *StreamSession) Namespace() string {
+	return s.XMLName.Space
 }
 
 // ============================================================================
 // Registry init
 
 func init() {
-	TypeRegistry.MapExtension(PKTIQ, xml.Name{"urn:ietf:params:xml:ns:xmpp-bind", "bind"}, BindBind{})
+	TypeRegistry.MapExtension(PKTIQ, xml.Name{"urn:ietf:params:xml:ns:xmpp-bind", "bind"}, Bind{})
+	TypeRegistry.MapExtension(PKTIQ, xml.Name{"urn:ietf:params:xml:ns:xmpp-session", "bind"}, StreamSession{})
 }

stanza/sasl_auth_test.go

@@ -0,0 +1,29 @@
+package stanza_test
+
+import (
+	"encoding/xml"
+	"testing"
+
+	"gosrc.io/xmpp/stanza"
+)
+
+// Check that we can detect optional session from advertised stream features
+func TestSession(t *testing.T) {
+	streamFeatures := stanza.StreamFeatures{Session: stanza.StreamSession{Optional: true}}
+
+	data, err := xml.Marshal(streamFeatures)
+	if err != nil {
+		t.Errorf("cannot marshal xml structure: %s", err)
+	}
+
+	parsedStream := stanza.StreamFeatures{}
+	if err = xml.Unmarshal(data, &parsedStream); err != nil {
+		t.Errorf("Unmarshal(%s) returned error", data)
+	}
+
+	if !parsedStream.Session.Optional {
+		t.Error("Session should be optional")
+	}
+}
+
+// TODO Test Sasl mechanism

stanza/stream.go

@@ -17,9 +17,10 @@ type StreamFeatures struct {
 	// Stream features
 	StartTLS         tlsStartTLS
 	Mechanisms       saslMechanisms
-	Bind             BindBind
-	Session          sessionSession
+	Bind             Bind
 	StreamManagement streamManagement
+	// Obsolete
+	Session StreamSession
 	// ProcessOne Stream Features
 	P1Push   p1Push
 	P1Rebind p1Rebind