- Publicity: Public Only All
webauthn-procs.tcl
Support for WebAuthn/FIDO2
This file defines the following Objects and Classes: ::webauthn::WebAuthn
, ::webauthn::WebAuthn
- Location:
- packages/webauthn/tcl/webauthn-procs.tcl
Procedures in this file
- Class ::webauthn::WebAuthn (public)
- Object ::webauthn::passkey (public)
- webauthn::JQ (private)
- webauthn::WebAuthn instproc assert_clientdata_json (protected)
- webauthn::WebAuthn instproc assert_rpidhash (protected)
- webauthn::WebAuthn instproc init (protected)
- webauthn::WebAuthn instproc login_url (public)
- webauthn::WebAuthn instproc logout (public)
- webauthn::WebAuthn instproc lookup_user_id (protected)
- webauthn::WebAuthn instproc name (public)
- webauthn::WebAuthn instproc new_challenge (public)
- webauthn::WebAuthn instproc origin (public)
- webauthn::WebAuthn instproc return_err (public)
- webauthn::WebAuthn instproc state_key (protected)
- webauthn::WebAuthn instproc store (public)
- webauthn::WebAuthn instproc {auth assertion_verify} (public)
- webauthn::WebAuthn instproc {auth issue_options} (public)
- webauthn::WebAuthn instproc {reg attestation_verify} (public)
- webauthn::validRpIdP (private)
Detailed information
Class ::webauthn::WebAuthn (public)
::nx::Class ::webauthn::WebAuthnrp_id: The WebAuthn Relying Party ID (domain), e.g. 'openacs.org' or 'login.example.com'; Must be a registrable domain / host that matches the site origin rules. after_successful_login_url: Where to redirect after login if no return_url exists in state. login_failure_url: Where to send users on failure if you don’t want to show debug output.
- Testcases:
- No testcase defined.
Object ::webauthn::passkey (public)
::webauthn::WebAuthn ::webauthn::passkey
- ::webauthn::passkey origin
- ::webauthn::passkey return_err ?-status /value/? /error/ /detail/
- ::webauthn::passkey login_url ?-return_url /value/?
- ::webauthn::passkey reg ...
- ::webauthn::passkey name
- ::webauthn::passkey auth ...
- ::webauthn::passkey logout
- ::webauthn::passkey new_challenge ?nbytes?
- ::webauthn::passkey store
- ::webauthn::passkey pp ?-list? ?-prefix /value/? /dict/
- Testcases:
- No testcase defined.
webauthn::JQ (private)
webauthn::JQ s
Perform quoting for JavaScript literals.
- Parameters:
- s (required)
- Returns:
- JSON-escaped string content (WITHOUT surrounding quotes).
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
webauthn::WebAuthn method assert_clientdata_json (protected)
<instance of webauthn::WebAuthn> assert_clientdata_json \
[ -clientData_raw clientData_raw ] \
[ -expected_type expected_type ] \
[ -expected_challenge expected_challenge ] \
[ -expected_origin expected_origin ]clientDataJSON is bytes (as received). We decode and validate: - type - challenge - origin
- Switches:
- -clientData_raw (optional)
- -expected_type (optional)
- -expected_challenge (optional)
- -expected_origin (optional)
- Testcases:
- No testcase defined.
webauthn::WebAuthn method assert_rpidhash (protected)
<instance of webauthn::WebAuthn> assert_rpidhash \
[ -rpIdHash rpIdHash ] [ -rpId rpId ] [ -context context ]
- Switches:
- -rpIdHash (optional)
- -rpId (optional)
- -context (optional)
- Testcases:
- No testcase defined.
webauthn::WebAuthn method init (protected)
<instance of webauthn::WebAuthn> init
- Testcases:
- No testcase defined.
webauthn::WebAuthn method login_url (public)
<instance of webauthn::WebAuthn> login_url \
[ -return_url return_url ]Compatibility function with other external_registry objects
- Switches:
- -return_url (optional, defaults to
"/")- Testcases:
- No testcase defined.
webauthn::WebAuthn method logout (public)
<instance of webauthn::WebAuthn> logoutCompatibility function with other external_registry objects
- Testcases:
- No testcase defined.
webauthn::WebAuthn method lookup_user_id (protected)
<instance of webauthn::WebAuthn> lookup_user_id \
[ -credential_id credential_id ]
- Switches:
- -credential_id (optional)
- Testcases:
- No testcase defined.
webauthn::WebAuthn method name (public)
<instance of webauthn::WebAuthn> namecompatibility with xo::Authorize
- Testcases:
- No testcase defined.
webauthn::WebAuthn method new_challenge (public)
<instance of webauthn::WebAuthn> new_challenge [ nbytes ]
- Parameters:
- nbytes (optional, defaults to
"32")- Testcases:
- No testcase defined.
webauthn::WebAuthn method origin (public)
<instance of webauthn::WebAuthn> originReturns the "origin" field provided to the attestation.
- Testcases:
- No testcase defined.
webauthn::WebAuthn method return_err (public)
<instance of webauthn::WebAuthn> return_err [ -status status ] \
error detail
- Switches:
- -status (optional, defaults to
"400")- Parameters:
- error (required)
- detail (required)
- Testcases:
- No testcase defined.
webauthn::WebAuthn method state_key (protected)
<instance of webauthn::WebAuthn> state_key purpose state
- Parameters:
- purpose (required)
- state (required)
- Testcases:
- No testcase defined.
webauthn::WebAuthn method store (public)
<instance of webauthn::WebAuthn> store
- Testcases:
- No testcase defined.
webauthn::WebAuthn method auth assertion_verify (public)
<instance of webauthn::WebAuthn> auth assertion_verify \
[ -st st ] [ -req req ]
- Switches:
- -st (optional)
- -req (optional)
- Testcases:
- No testcase defined.
webauthn::WebAuthn method auth issue_options (public)
<instance of webauthn::WebAuthn> auth issue_options \
[ -return_url return_url ]
- Switches:
- -return_url (optional, defaults to
"/")- Testcases:
- No testcase defined.
webauthn::WebAuthn method reg attestation_verify (public)
<instance of webauthn::WebAuthn> reg attestation_verify \
[ -st st ] [ -req req ]
- Switches:
- -st (optional)
- -req (optional)
- Testcases:
- No testcase defined.
webauthn::validRpIdP (private)
webauthn::validRpIdP rpid
Validate the provided rpid (Relying Party ID)
- Parameters:
- rpid (required)
- Returns:
- boolean value
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
