Provided by: libfirefox-marionette-perl_1.22-1_all bug

NAME

       Firefox::Marionette::Login - Represents a login from the Firefox Password Manager

VERSION

       Version 1.22

SYNOPSIS

           use Firefox::Marionette();
           use v5.10;

           my $firefox = Firefox::Marionette->new();
           foreach my $login ($firefox->logins()) {
               if ($login->user() eq 'me@example.org') {
                   ...
               }
           }

DESCRIPTION

       This module handles the implementation of a login <https://developer.mozilla.org/en-
       US/docs/Mozilla/Tech/XPCOM/Reference/Interface/nsILoginInfo> from the Firefox Password
       Manager <https://support.mozilla.org/en-US/kb/password-manager-remember-delete-edit-
       logins>

SUBROUTINES/METHODS

   creation_time
       returns the time, in Unix Epoch seconds, when the login was first created.

   creation_in_ms
       returns the time, in Unix Epoch milliseconds, when the login was first created.  This is
       the same time as creation_in_ms but divided by 1000 and turned back into an integer.

   guid
       returns the GUID to uniquely identify the login.

   host
       returns the scheme + hostname (for example "https://example.com") of the page containing
       the login form.

   last_used_time
       returns the time, in Unix Epoch seconds, when the login was last submitted in a form or
       used to begin an HTTP auth session.  This is the same time as last_used_in_ms but divided
       by 1000 and turned back into an integer.

   last_used_in_ms
       returns the time, in Unix Epoch milliseconds, when the login was last submitted in a form
       or used to begin an HTTP auth session.

   origin
       returns the scheme + hostname (for example "https://example.org") of the action
       <https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form#attr-action> attribute of
       the form that is being submitted.

   new
       accepts an optional hash as a parameter.  Allowed keys are below;

       •   creation_in_ms - the time, in Unix Epoch milliseconds, when the login was first
           created.

       •   creation_time - the time, in Unix Epoch seconds, when the login was first created.
           This value will be overridden by the more precise creation_in_ms parameter, if
           provided.

       •   guid - the GUID to uniquely identify the login. This can be any arbitrary string, but
           a format as created by nsIUUIDGenerator <https://developer.mozilla.org/en-
           US/docs/Mozilla/Tech/XPCOM/Reference/Interface/nsIUUIDGenerator> is recommended. For
           example, "{d4e1a1f6-5ea0-40ee-bff5-da57982f21cf}".

       •   host - this is the scheme + hostname (for example "https://example.com") of the page
           containing the login form.

       •   last_used_in_ms returns the time, in Unix Epoch milliseconds, when the login was last
           submitted in a form or used to begin an HTTP auth session.

       •   last_used_time - the time, in Unix Epoch seconds, when the login was last submitted in
           a form or used to begin an HTTP auth session.  This value will be overridden by the
           more precise last_used_in_ms parameter, if provided.

       •   origin - this is the scheme + hostname (for example "https://example.org") of the
           action <https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form#attr-action>
           attribute of the form that is being submitted.  If the action
           <https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form#attr-action> attribute
           has an empty or relative URL, then this value should be the same as the host.  If this
           value is ignored, it will apply for forms with action
           <https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form#attr-action> of all
           values.

       •   password - the password for the login.

       •   password_changed_in_ms - the time, in Unix Epoch milliseconds, when the login's
           password was last modified.

       •   password_changed_time -  the time, in Unix Epoch seconds, when the login's password
           was last modified.  This value will be overridden by the more precise
           password_changed_in_ms parameter, if provided.

       •   password_field - the name <https://developer.mozilla.org/en-
           US/docs/Web/HTML/Element/input#htmlattrdefname> attribute for the password input in a
           form.  This is ignored for http auth logins.

       •   realm - the HTTP Realm for which the login was requested.  This is ignored for HTML
           Form logins.

       •   times_used - the number of times the login was submitted in a form or used to begin an
           HTTP auth session.

       •   user - the user name for the login.

       •   user_field - the name <https://developer.mozilla.org/en-
           US/docs/Web/HTML/Element/input#htmlattrdefname> attribute for the user input in a
           form.  This is ignored for http auth logins.

       This method returns a new "Firefox::Marionette::Login" object.

   password
       returns the password for the login.

   password_changed_time
       returns the time, in Unix Epoch seconds, when the login's password was last modified.
       This is the same time as password_changed_in_ms but divided by 1000 and turned back into
       an integer.

   password_changed_in_ms
       returns the time, in Unix Epoch milliseconds, when the login's password was last modified.

   password_field
       returns the name <https://developer.mozilla.org/en-
       US/docs/Web/HTML/Element/input#htmlattrdefname> attribute for the password input in a form
       or undef for non-form logins.

   realm
       returns the HTTP Realm for which the login was requested. When an HTTP server sends a 401
       result, the WWW-Authenticate header includes a realm to identify the "protection space."
       See RFC 2617. If the result did not include a realm, or it was blank, the hostname is used
       instead. For logins obtained from HTML forms, this field is null.

   times_used
       returns the number of times the login was submitted in a form or used to begin an HTTP
       auth session.

   user
       returns the user name for the login.

   user_field
       returns the name <https://developer.mozilla.org/en-
       US/docs/Web/HTML/Element/input#htmlattrdefname> attribute for the user input in a form or
       undef for non-form logins.

DIAGNOSTICS

       None.

CONFIGURATION AND ENVIRONMENT

       Firefox::Marionette::Login requires no configuration files or environment variables.

DEPENDENCIES

       None.

INCOMPATIBILITIES

       None reported.

BUGS AND LIMITATIONS

       To report a bug, or view the current list of bugs, please visit
       <https://github.com/david-dick/firefox-marionette/issues>

AUTHOR

       David Dick  "<ddick@cpan.org>"

LICENSE AND COPYRIGHT

       Copyright (c) 2021, David Dick "<ddick@cpan.org>". All rights reserved.

       This module is free software; you can redistribute it and/or modify it under the same
       terms as Perl itself. See "perlartistic" in perlartistic.

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.

       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.