.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" 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
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "Net::Jabber::Key 3"
.TH Net::Jabber::Key 3 2025-12-14 "perl v5.42.0" "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
Net::Jabber::Key \- Jabber Key Library
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&  Net::Jabber::Key is a module that provides a developer easy access
\&  to generating, caching, and comparing keys.
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
.Vb 4
\&  Key.pm is a helper module for the Net::Jabber::Transport.  When the
\&  Transport talks to a Client it sends a key and expects to get that
\&  key back from the Client.  This module provides an API to generate,
\&  cache, and then compare the key send from the Client.
.Ve
.SS "Basic Functions"
.IX Subsection "Basic Functions"
.Vb 1
\&    $Key = new Net::Jabber::Key();
\&
\&    $key = $Key\->Generate();
\&
\&    $key = $Key\->Create("bob\e@jabber.org");
\&
\&    $test = $Key\->Compare("bob\e@jabber.org","some key");
.Ve
.SH METHODS
.IX Header "METHODS"
.SS "Basic Functions"
.IX Subsection "Basic Functions"
.Vb 8
\&    new(debug=>string,       \- creates the Key object.  debug should
\&        debugfh=>FileHandle,   be set to the path for the debug
\&        debuglevel=>integer)   log to be written.  If set to "stdout" 
\&                               then the debug will go there.  Also, you
\&                               can specify a filehandle that already
\&                               exists and use that.  debuglevel controls
\&                               the amount of debug.  0 is none, 1 is
\&                               normal, 2 is all.
\&
\&    Generate() \- returns a key in Digest SHA1 form based on the current
\&                 time and the PID.
\&
\&    Create(cacheString) \- generates a key and caches it with the key 
\&                          of cacheString.  Create returns the key.
\&
\&    Compare(cacheString, \- compares the key stored in the cache under
\&            keyString)     cacheString with the keyString.  Returns 1
\&                           if they match, and 0 otherwise.
.Ve
.SH AUTHOR
.IX Header "AUTHOR"
By Ryan Eatmon in May of 2000 for http://jabber.org.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
This module is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.