1Net::Jabber::Key(3)   User Contributed Perl Documentation  Net::Jabber::Key(3)
2
3
4

NAME

6       Net::Jabber::Key - Jabber Key Library
7

SYNOPSIS

9         Net::Jabber::Key is a module that provides a developer easy access
10         to generating, caching, and comparing keys.
11

DESCRIPTION

13         Key.pm is a helper module for the Net::Jabber::Transport.  When the
14         Transport talks to a Client it sends a key and expects to get that
15         key back from the Client.  This module provides an API to generate,
16         cache, and then compare the key send from the Client.
17
18   Basic Functions
19           $Key = new Net::Jabber::Key();
20
21           $key = $Key->Generate();
22
23           $key = $Key->Create("bob\@jabber.org");
24
25           $test = $Key->Compare("bob\@jabber.org","some key");
26

METHODS

28   Basic Functions
29           new(debug=>string,       - creates the Key object.  debug should
30               debugfh=>FileHandle,   be set to the path for the debug
31               debuglevel=>integer)   log to be written.  If set to "stdout"
32                                      then the debug will go there.  Also, you
33                                      can specify a filehandle that already
34                                      exists and use that.  debuglevel controls
35                                      the amount of debug.  0 is none, 1 is
36                                      normal, 2 is all.
37
38           Generate() - returns a key in Digest SHA1 form based on the current
39                        time and the PID.
40
41           Create(cacheString) - generates a key and caches it with the key
42                                 of cacheString.  Create returns the key.
43
44           Compare(cacheString, - compares the key stored in the cache under
45                   keyString)     cacheString with the keyString.  Returns 1
46                                  if they match, and 0 otherwise.
47

AUTHOR

49       By Ryan Eatmon in May of 2000 for http://jabber.org.
50

52       This module is free software; you can redistribute it and/or modify it
53       under the same terms as Perl itself.
54
55
56
57perl v5.36.0                      2023-01-20               Net::Jabber::Key(3)
Impressum