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
20           $Key = new Net::Jabber::Key();
21
22           $key = $Key->Generate();
23
24           $key = $Key->Create("bob\@jabber.org");
25
26           $test = $Key->Compare("bob\@jabber.org","some key");
27

METHODS

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

AUTHOR

51       By Ryan Eatmon in May of 2000 for http://jabber.org.
52

54       This module is free software; you can redistribute it and/or modify it
55       under the same terms as Perl itself.
56
57
58
59perl v5.8.8                       2004-08-16               Net::Jabber::Key(3)
Impressum