Merge pull request #8 from cedarcode/credential_creation_options

feat: offer credential_creation_options to the user for registration …

README.md

@@ -20,15 +20,26 @@ Or install it yourself as:
 
 ## Usage
 
+### Registration
+
+#### Initiation phase
+
 ```ruby
-payload = WebAuthn.registration_payload
+credential_creation_options = WebAuthn.credential_creation_options
 
-# If you want to store your challenge, you can read it like this
-payload[:publicKey][:challenge]
+# Store the newly generated challenge somewhere so you can have it
+# for the validation phase.
+#
+# You can read it from the resulting options:
+credential_creation_options[:challenge]
 
-render json: payload
+# Send `credential_creation_options` to the browser, so that they can be used
+# when calling `navigator.credentials.create({ "publicKey": credentialCreationOptions })`
 ```
 
+#### Validation phase
+
+TBD
 
 ## Development
 

lib/webauthn.rb

@@ -12,14 +12,12 @@ module WebAuthn
  USER_NAME = "web-user".freeze
  CREATE_TYPE = "webauthn.create"
 
- def self.registration_payload
+ def self.credential_creation_options
  {
- publicKey: {
- challenge: Base64.urlsafe_encode64(SecureRandom.random_bytes(16)),
- pubKeyCredParams: [ES256_ALGORITHM],
- rp: { name: RP_NAME },
- user: { name: USER_NAME, displayName: USER_NAME, id: Base64.urlsafe_encode64(USER_ID) }
- }
+ challenge: Base64.urlsafe_encode64(SecureRandom.random_bytes(16)),
+ pubKeyCredParams: [ES256_ALGORITHM],
+ rp: { name: RP_NAME },
+ user: { name: USER_NAME, displayName: USER_NAME, id: Base64.urlsafe_encode64(USER_ID) }
  }
  end
 

spec/webauthn_spec.rb

@@ -3,27 +3,27 @@
  expect(WebAuthn::VERSION).not_to be nil
  end
 
- describe "#registration_payload" do
+ describe "#credential_creation_options" do
  before do
- @payload = WebAuthn.registration_payload
+ @credential_creation_options = WebAuthn.credential_creation_options
  end
 
  it "has a 16 byte length challenge" do
- original_challenge = Base64.urlsafe_decode64(@payload[:publicKey][:challenge])
+ original_challenge = Base64.urlsafe_decode64(@credential_creation_options[:challenge])
  expect(original_challenge.length).to eq(16)
  end
 
  it "has public key params" do
- expect(@payload[:publicKey][:pubKeyCredParams][0][:type]).to eq("public-key")
- expect(@payload[:publicKey][:pubKeyCredParams][0][:alg]).to eq(-7)
+ expect(@credential_creation_options[:pubKeyCredParams][0][:type]).to eq("public-key")
+ expect(@credential_creation_options[:pubKeyCredParams][0][:alg]).to eq(-7)
  end
 
  it "has relying party info" do
- expect(@payload[:publicKey][:rp][:name]).to eq("web-server")
+ expect(@credential_creation_options[:rp][:name]).to eq("web-server")
  end
 
  it "has user info" do
- user_info = @payload[:publicKey][:user]
+ user_info = @credential_creation_options[:user]
  expect(user_info[:name]).to eq("web-user")
  expect(user_info[:displayName]).to eq("web-user")
  expect(user_info[:id]).to eq("MQ==")