.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 "Data::Password::zxcvbn::Match::Spatial 3pm"
.TH Data::Password::zxcvbn::Match::Spatial 3pm "2020-07-13" "perl v5.30.3" "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"
Data::Password::zxcvbn::Match::Spatial \- match class for sequences of nearby keys
.SH "VERSION"
.IX Header "VERSION"
version 1.0.4
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class represents the guess that a certain substring of a password
can be obtained by moving a finger in a continuous line on a keyboard.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.ie n .SS """graph_name"""
.el .SS "\f(CWgraph_name\fP"
.IX Subsection "graph_name"
The name of the keyboard / adjacency graph used for this match
.ie n .SS """graph_meta"""
.el .SS "\f(CWgraph_meta\fP"
.IX Subsection "graph_meta"
Hashref, spatial information about the graph:
.IP "\(bu" 4
\&\f(CW\*(C`starting_positions\*(C'\fR
.Sp
the number of keys in the keyboard, or starting nodes in the graph
.IP "\(bu" 4
\&\f(CW\*(C`average_degree\*(C'\fR
.Sp
the average number of neighbouring keys, or average out-degree of the graph
.ie n .SS """shifted_count"""
.el .SS "\f(CWshifted_count\fP"
.IX Subsection "shifted_count"
How many of the keys need to be \*(L"shifted\*(R" to produce the token
.ie n .SS """turns"""
.el .SS "\f(CWturns\fP"
.IX Subsection "turns"
How many times the finger must have changed direction to produce the
token
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """estimate_guesses"""
.el .SS "\f(CWestimate_guesses\fP"
.IX Subsection "estimate_guesses"
The number of guesses grows super-linearly with the length of the
pattern, the number of \*(L"turns\*(R", and the amount of shifted
keys.
.ie n .SS """make"""
.el .SS "\f(CWmake\fP"
.IX Subsection "make"
.Vb 6
\&  my @matches = @{ Data::Password::zxcvbn::Match::Spatial\->make(
\&    $password,
\&    { # this is the default
\&      graphs => \e%Data::Password::zxcvbn::AdjacencyGraph::graphs,
\&    },
\&  ) };
.Ve
.PP
Scans the \f(CW$password\fR for substrings that can be produced by typing
on the keyboards described by the \f(CW\*(C`graphs\*(C'\fR.
.PP
The data structure needed for \f(CW\*(C`graphs\*(C'\fR is a bit complicated; look at
the \f(CW\*(C`build\-keyboard\-adjacency\-graphs\*(C'\fR script in the
distribution's
repository <https://bitbucket.org/broadbean/p5-data-password-zxcvbn/src/master/maint/build-keyboard-adjacency-graphs>.
.ie n .SS """feedback_warning"""
.el .SS "\f(CWfeedback_warning\fP"
.IX Subsection "feedback_warning"
.ie n .SS """feedback_suggestions"""
.el .SS "\f(CWfeedback_suggestions\fP"
.IX Subsection "feedback_suggestions"
This class suggests that short keyboard patterns are easy to guess,
and to use longer and less straight ones.
.ie n .SS """fields_for_json"""
.el .SS "\f(CWfields_for_json\fP"
.IX Subsection "fields_for_json"
The \s-1JSON\s0 serialisation for matches of this class will contain \f(CW\*(C`token
i j guesses guesses_log10 graph_name shifted_count turns\*(C'\fR.
.SH "AUTHOR"
.IX Header "AUTHOR"
Gianni Ceccarelli <gianni.ceccarelli@broadbean.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2018 by BroadBean \s-1UK,\s0 a CareerBuilder Company.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.