.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Firefox::Marionette::WebAuthn::Authenticator 3pm"
.TH Firefox::Marionette::WebAuthn::Authenticator 3pm 2024-05-15 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Firefox::Marionette::WebAuthn::Authenticator \- Represents a Firefox WebAuthn Authenticator
.SH VERSION
.IX Header "VERSION"
Version 1.57
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&    use Firefox::Marionette();
\&    use Crypt::URandom();
\&
\&    my $user_name = MIME::Base64::encode_base64( Crypt::URandom::urandom( 10 ), q[] ) . q[@example.com];
\&    my $firefox = Firefox::Marionette\->new();
\&    my $authenticator = $firefox\->add_webauthn_authenticator( transport => Firefox::Marionette::WebAuthn::Authenticator::INTERNAL(), protocol => Firefox::Marionette::WebAuthn::Authenticator::CTAP2() );
\&    $firefox\->go(\*(Aqhttps://webauthn.io\*(Aq);
\&    $firefox\->find_id(\*(Aqinput\-email\*(Aq)\->type($user_name);
\&    $firefox\->find_id(\*(Aqregister\-button\*(Aq)\->click();
\&    $firefox\->await(sub { sleep 1; $firefox\->find_class(\*(Aqalert\-success\*(Aq); });
\&    $firefox\->find_id(\*(Aqlogin\-button\*(Aq)\->click();
\&    $firefox\->await(sub { sleep 1; $firefox\->find_class(\*(Aqhero confetti\*(Aq); });
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module handles the implementation of a Virtual Authenticator <https://www.w3.org/TR/webauthn-2/#virtual-authenticators> using the Marionette protocol.
.SH CONSTANTS
.IX Header "CONSTANTS"
.SS BLE
.IX Subsection "BLE"
return 'ble', the transport code for a Bluetooth Low Energy <https://en.wikipedia.org/wiki/Bluetooth_Low_Energy> transport.
.SS CTAP1_U2F
.IX Subsection "CTAP1_U2F"
returns 'ctap1/u2f', the protocol code for an older version of Client to Authenticator Protocol <https://en.wikipedia.org/wiki/Client_to_Authenticator_Protocol>, that is backwards compatible with the Universal 2nd Factor <https://en.wikipedia.org/wiki/Universal_2nd_Factor> open standard.
.SS CTAP2
.IX Subsection "CTAP2"
returns 'ctap2', the protocol code for the Client to Authenticator Protocol <https://en.wikipedia.org/wiki/Client_to_Authenticator_Protocol>.
.SS CTAP2_1
.IX Subsection "CTAP2_1"
returns 'ctap2_1', the protocol code for the next version of the Client to Authenticator Protocol <https://en.wikipedia.org/wiki/Client_to_Authenticator_Protocol>.
.SS HYBRID
.IX Subsection "HYBRID"
returns 'hybrid', the transport code for a hybrid <https://w3c.github.io/webauthn/#dom-authenticatortransport-hybrid> transport.
.SS INTERNAL
.IX Subsection "INTERNAL"
returns 'internal', the transport code for an internal <https://w3c.github.io/webauthn/#dom-authenticatortransport-internal> transport.
.SS NFC
.IX Subsection "NFC"
return 'nfc', the transport code for a Near-field communication <https://en.wikipedia.org/wiki/Near-field_communication> transport.
.SS SMART_CARD
.IX Subsection "SMART_CARD"
returns 'smart\-card', the transport code for a ISO/IEC 7816 <https://en.wikipedia.org/wiki/ISO/IEC_7816> Smart Card <https://w3c.github.io/webauthn/#dom-authenticatortransport-smart-card> transport.
.SS USB
.IX Subsection "USB"
return 'usb', the transport code for a Universal Serial Bus <https://en.wikipedia.org/wiki/USB> transport.
.SH SUBROUTINES/METHODS
.IX Header "SUBROUTINES/METHODS"
.SS new
.IX Subsection "new"
accepts a hash as a parameter.  Allowed keys are below;
.IP \(bu 4
has_resident_key \- boolean value to indicate if the authenticator <https://www.w3.org/TR/webauthn-2/#virtual-authenticators> will support client side discoverable credentials <https://www.w3.org/TR/webauthn-2/#client-side-discoverable-credential>
.IP \(bu 4
has_user_verification \- boolean value to determine if the authenticator <https://www.w3.org/TR/webauthn-2/#virtual-authenticators> supports user verification <https://www.w3.org/TR/webauthn-2/#user-verification>.
.IP \(bu 4
id \- the id of the authenticator.
.IP \(bu 4
is_user_consenting \- boolean value to determine the result of all user consent <https://www.w3.org/TR/webauthn-2/#user-consent> authorization gestures <https://www.w3.org/TR/webauthn-2/#authorization-gesture>, and by extension, any test of user presence <https://www.w3.org/TR/webauthn-2/#test-of-user-presence> performed on the Virtual Authenticator <https://www.w3.org/TR/webauthn-2/#virtual-authenticators>. If set to true, a user consent <https://www.w3.org/TR/webauthn-2/#user-consent> will always be granted. If set to false, it will not be granted.
.IP \(bu 4
is_user_verified \- boolean value to determine the result of User Verification <https://www.w3.org/TR/webauthn-2/#user-verification> performed on the Virtual Authenticator <https://www.w3.org/TR/webauthn-2/#virtual-authenticators>. If set to true, User Verification <https://www.w3.org/TR/webauthn-2/#user-verification> will always succeed. If set to false, it will fail.
.IP \(bu 4
protocol \- the protocol spoken by the authenticator.  This may be CTAP1_U2F, CTAP2 or CTAP2_1.
.IP \(bu 4
transport \- the transport simulated by the authenticator.  This may be BLE, HYBRID, INTERNAL, NFC, SMART_CARD or USB.
.PP
This method returns a new webauthn virtual authenticator object.
.SS has_resident_key
.IX Subsection "has_resident_key"
This method returns a boolean value to indicate if the authenticator <https://www.w3.org/TR/webauthn-2/#virtual-authenticators> will support client side discoverable credentials <https://www.w3.org/TR/webauthn-2/#client-side-discoverable-credential>.
.SS has_user_verification
.IX Subsection "has_user_verification"
This method returns a boolean value to determine if the authenticator <https://www.w3.org/TR/webauthn-2/#virtual-authenticators> supports user verification <https://www.w3.org/TR/webauthn-2/#user-verification>.
.SS is_user_consenting
.IX Subsection "is_user_consenting"
This method returns a boolean value to determine the result of all user consent <https://www.w3.org/TR/webauthn-2/#user-consent> authorization gestures <https://www.w3.org/TR/webauthn-2/#authorization-gesture>, and by extension, any test of user presence <https://www.w3.org/TR/webauthn-2/#test-of-user-presence> performed on the Virtual Authenticator <https://www.w3.org/TR/webauthn-2/#virtual-authenticators>. If set to true, a user consent <https://www.w3.org/TR/webauthn-2/#user-consent> will always be granted. If set to false, it will not be granted.
.SS is_user_verified
.IX Subsection "is_user_verified"
This method returns a boolean value to determine the result of User Verification <https://www.w3.org/TR/webauthn-2/#user-verification> performed on the Virtual Authenticator <https://www.w3.org/TR/webauthn-2/#virtual-authenticators>. If set to true, User Verification <https://www.w3.org/TR/webauthn-2/#user-verification> will always succeed. If set to false, it will fail.
.SS protocol
.IX Subsection "protocol"
This method returns a string containing the protocol spoken by the authenticator.  This may be CTAP1_U2F, CTAP2 or CTAP2_1.
.SS transport
.IX Subsection "transport"
This method returns a string containing the transport simulated by the authenticator.  This may be BLE, HYBRID, INTERNAL, NFC, SMART_CARD or USB.
.SH DIAGNOSTICS
.IX Header "DIAGNOSTICS"
None.
.SH "CONFIGURATION AND ENVIRONMENT"
.IX Header "CONFIGURATION AND ENVIRONMENT"
Firefox::Marionette::WebAuthn::Authenticator requires no configuration files or environment variables.
.SH DEPENDENCIES
.IX Header "DEPENDENCIES"
None.
.SH INCOMPATIBILITIES
.IX Header "INCOMPATIBILITIES"
None reported.
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
To report a bug, or view the current list of bugs, please visit <https://github.com/david\-dick/firefox\-marionette/issues>
.SH AUTHOR
.IX Header "AUTHOR"
David Dick  \f(CW\*(C`<ddick@cpan.org>\*(C'\fR
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright (c) 2024, David Dick \f(CW\*(C`<ddick@cpan.org>\*(C'\fR. All rights reserved.
.PP
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See "perlartistic" in perlartistic.
.SH "DISCLAIMER OF WARRANTY"
.IX Header "DISCLAIMER OF WARRANTY"
BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR, OR CORRECTION.
.PP
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.