bfn-webauthn-server - npm Package Compare versions

Comparing version 0.2.1 to 0.2.2

package.json

 {
   "name": "bfn-webauthn-server",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "Boot Fidelity Webauthn Server Library",
@@ -5,0 +5,0 @@ "main": "index.js",

readme.md

@@ -17,10 +17,82 @@ # bfn-webauthn-server
 
+## Example
+
+**Verify Attestation Response:**
+``` js
+var simpleWebAuthn = require('bfn-webauthn-server');
+
+var exampleAttestationResponse = {
+	credential: {
+		"id": "csR4ANRLKorPuJENvQQW8egUJYh-8ZWIqiGloO032Oc",
+		"type": "public-key",
+		"rawId": "csR4ANRLKorPuJENvQQW8egUJYh-8ZWIqiGloO032Oc",
+		"response": {
+			"clientDataJSON": "eyJjaGFsbGVuZ2UiOiI3YjFtNm4yS2dNQ......IsInR5cGUiOiJ3ZWJhdXRobi5jcmVhdGUifQ",
+			"attestationObject": "o2NmbXRmcGFja2VkZ2F0dFN0...DvLFRA5Bn3dGgzy"
+		}
+	},
+	expectedChallenge: "58dCluFFQKrmrJzbPt_O5VNWUBoHoW4gY01eZ_M2PjRYLZMgiUE86Krd7Jc",
+	expectedOrigin: "https://example.com",
+	expectedRPID: "example.com",
+};
+
+simpleWebAuthn.verifyAttestationResponse(exampleAttestationResponse).then(function(verification){
+	if (!verification || !verification.verified || !verification.authenticatorInfo || !verification.authenticatorInfo.base64CredentialID || !verification.authenticatorInfo.base64PublicKey || typeof verification.authenticatorInfo.counter !== 'number') {
+		console.log('not verified');
+	} else {
+		console.log('verified');
+	}
+}).catch(function(e){
+	console.log('Error', e);
+});
+```
+
+**Verify Assertion Response:**
+``` js
+var simpleWebAuthn = require('bfn-webauthn-server');
+
+var exampleAssertionResponse = {
+	"id": "csR4ANRLKorPuJENvQQW8egUJYh-8ZWIqiGloO032Oc",
+	"rawId": "csR4ANRLKorPuJENvQQW8egUJYh-8ZWIqiGloO032Oc",
+	"response": {
+		"clientDataJSON": "eyJjaGFsbGVuZ2UiOiI3YjFtNm4yS2dNQ......IsInR5cGUiOiJ3ZWJhdXRobi5jcmVhdGUifQ",
+		"signature": "IQLxgOSZP3npllWWth8Yj......JkuZXhoCP3NifZw",
+		"authenticatorData": "o2NmbXRmcGFja2VkZ2F0dFN0...DvLFRA5Bn3dGgzy"
+	},
+	"type": "public-key"
+};
+
+var err, verification;
+
+try {
+	verification = simpleWebAuthn.verifyAssertionResponse(exampleAssertionResponse);
+} catch (e) {
+	err = e;
+	verification = false;
+}
+
+if (err) {
+	console.log('Error', e);
+} else if (!verification || !verification.verified || !verification.authenticatorInfo || !verification.authenticatorInfo.base64CredentialID || typeof verification.authenticatorInfo.counter !== 'number') {
+	console.log('not verified');
+} else {
+	console.log('verified');
+}
+```
+
+## Supported Attestation Formats
+
+Supports [all six WebAuthn attestation formats](https://w3c.github.io/webauthn/#sctn-defined-attestation-formats), including:
+
+- **Packed**
+- **TPM**
+- **Android Key**
+- **Android SafetyNet**
+- **FIDO U2F**
+- **None**
+
 ## Supported Node Version
 
 * 6.17.1
-  
-## TODO
 
-- Test
-
 ## License
@@ -27,0 +99,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

120755

increased by1.97%

Number of lines in readme file

103

increased by232.26%

No dependency changes