Extend and document the profile object

node-saml · Sep 25, 2018 · 5365e62 · 5365e62
1 parent f82d141
commit 5365e62
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -73,6 +73,26 @@ passport.use(new MultiSamlStrategy(
 );
 ```
 
+#### The profile object:
+
+The profile object referenced above contains the following:
+
+```typescript
+interface Profile {
+  issuer?: string;
+  sessionIndex?: string;
+  nameID?: string;
+  nameIDFormat?: string;
+  nameQualifier?: string;
+  spNameQualifier?: string;
+  mail?: string;
+  email?: string;
+  getAssertionXml(): string;
+  getAssertion(): object;
+  ID?: string;
+}
+```
+
 #### Config parameter details:
 
  * **Core**

diff --git a/lib/passport-saml/saml.js b/lib/passport-saml/saml.js
@@ -718,9 +718,11 @@ SAML.prototype.processValidlySignedAssertion = function(xml, inResponseTo, callb
   var nowMs = new Date().getTime();
   var profile = {};
   var assertion;
+  var parsedAssertion;
   var parser = new xml2js.Parser(parserConfig);
   Q.ninvoke(parser, 'parseString', xml)
   .then(function(doc) {
+	parsedAssertion = doc;
     assertion = doc.Assertion;
 
     var issuer = assertion.Issuer;
@@ -867,6 +869,7 @@ SAML.prototype.processValidlySignedAssertion = function(xml, inResponseTo, callb
     }
 
     profile.getAssertionXml = function() { return xml; };
+    profile.getAssertion = function() { return parsedAssertion; };
 
     callback(null, profile, false);
   })