| Commit | Line | Data |
|---|
| 3fea05b9 |
1 | .\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10) |
| 2 | .\" |
| 3 | .\" Standard preamble: |
| 4 | .\" ======================================================================== |
| 5 | .de Sp \" Vertical space (when we can't use .PP) |
| 6 | .if t .sp .5v |
| 7 | .if n .sp |
| 8 | .. |
| 9 | .de Vb \" Begin verbatim text |
| 10 | .ft CW |
| 11 | .nf |
| 12 | .ne \\$1 |
| 13 | .. |
| 14 | .de Ve \" End verbatim text |
| 15 | .ft R |
| 16 | .fi |
| 17 | .. |
| 18 | .\" Set up some character translations and predefined strings. \*(-- will |
| 19 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
| 20 | .\" double quote, and \*(R" will give a right double quote. \*(C+ will |
| 21 | .\" give a nicer C++. Capital omega is used to do unbreakable dashes and |
| 22 | .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, |
| 23 | .\" nothing in troff, for use with C<>. |
| 24 | .tr \(*W- |
| 25 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
| 26 | .ie n \{\ |
| 27 | . ds -- \(*W- |
| 28 | . ds PI pi |
| 29 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
| 30 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
| 31 | . ds L" "" |
| 32 | . ds R" "" |
| 33 | . ds C` "" |
| 34 | . ds C' "" |
| 35 | 'br\} |
| 36 | .el\{\ |
| 37 | . ds -- \|\(em\| |
| 38 | . ds PI \(*p |
| 39 | . ds L" `` |
| 40 | . ds R" '' |
| 41 | 'br\} |
| 42 | .\" |
| 43 | .\" Escape single quotes in literal strings from groff's Unicode transform. |
| 44 | .ie \n(.g .ds Aq \(aq |
| 45 | .el .ds Aq ' |
| 46 | .\" |
| 47 | .\" If the F register is turned on, we'll generate index entries on stderr for |
| 48 | .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 49 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
| 50 | .\" output yourself in some meaningful fashion. |
| 51 | .ie \nF \{\ |
| 52 | . de IX |
| 53 | . tm Index:\\$1\t\\n%\t"\\$2" |
| 54 | .. |
| 55 | . nr % 0 |
| 56 | . rr F |
| 57 | .\} |
| 58 | .el \{\ |
| 59 | . de IX |
| 60 | .. |
| 61 | .\} |
| 62 | .\" |
| 63 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
| 64 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
| 65 | . \" fudge factors for nroff and troff |
| 66 | .if n \{\ |
| 67 | . ds #H 0 |
| 68 | . ds #V .8m |
| 69 | . ds #F .3m |
| 70 | . ds #[ \f1 |
| 71 | . ds #] \fP |
| 72 | .\} |
| 73 | .if t \{\ |
| 74 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
| 75 | . ds #V .6m |
| 76 | . ds #F 0 |
| 77 | . ds #[ \& |
| 78 | . ds #] \& |
| 79 | .\} |
| 80 | . \" simple accents for nroff and troff |
| 81 | .if n \{\ |
| 82 | . ds ' \& |
| 83 | . ds ` \& |
| 84 | . ds ^ \& |
| 85 | . ds , \& |
| 86 | . ds ~ ~ |
| 87 | . ds / |
| 88 | .\} |
| 89 | .if t \{\ |
| 90 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
| 91 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
| 92 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
| 93 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
| 94 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
| 95 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
| 96 | .\} |
| 97 | . \" troff and (daisy-wheel) nroff accents |
| 98 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
| 99 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
| 100 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
| 101 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
| 102 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
| 103 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
| 104 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
| 105 | .ds ae a\h'-(\w'a'u*4/10)'e |
| 106 | .ds Ae A\h'-(\w'A'u*4/10)'E |
| 107 | . \" corrections for vroff |
| 108 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
| 109 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
| 110 | . \" for low resolution devices (crt and lpr) |
| 111 | .if \n(.H>23 .if \n(.V>19 \ |
| 112 | \{\ |
| 113 | . ds : e |
| 114 | . ds 8 ss |
| 115 | . ds o a |
| 116 | . ds d- d\h'-1'\(ga |
| 117 | . ds D- D\h'-1'\(hy |
| 118 | . ds th \o'bp' |
| 119 | . ds Th \o'LP' |
| 120 | . ds ae ae |
| 121 | . ds Ae AE |
| 122 | .\} |
| 123 | .rm #[ #] #H #V #F C |
| 124 | .\" ======================================================================== |
| 125 | .\" |
| 126 | .IX Title "Object::Signature 3" |
| 127 | .TH Object::Signature 3 "2006-10-02" "perl v5.8.7" "User Contributed Perl Documentation" |
| 128 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 129 | .\" way too many mistakes in technical documents. |
| 130 | .if n .ad l |
| 131 | .nh |
| 132 | .SH "NAME" |
| 133 | Signature \- Generate cryptographic signatures for objects |
| 134 | .SH "SYNOPSIS" |
| 135 | .IX Header "SYNOPSIS" |
| 136 | .Vb 3 |
| 137 | \& # In your module |
| 138 | \& package My::Module |
| 139 | \& use base \*(AqObject::Signature\*(Aq; |
| 140 | \& |
| 141 | \& # In outside code |
| 142 | \& my $Object = My::Module\->new; |
| 143 | \& print "Object Signature: " . $Object\->signature; |
| 144 | .Ve |
| 145 | .SH "DESCRIPTION" |
| 146 | .IX Header "DESCRIPTION" |
| 147 | Object::Signature is an abstract base class that you can inherit from in |
| 148 | order to allow your objects to generate unique cryptographic signatures. |
| 149 | .PP |
| 150 | The method used to generate the signature is based on Storable and |
| 151 | Digest::MD5. The object is fed to \f(CW\*(C`Storable::nfreeze\*(C'\fR to get a string, |
| 152 | which is then passed to Digest::MD5::md5_hex to get a unique 32 |
| 153 | character hexidecimal signature. |
| 154 | .SH "METHODS" |
| 155 | .IX Header "METHODS" |
| 156 | .SS "signature" |
| 157 | .IX Subsection "signature" |
| 158 | The \f(CW\*(C`signature\*(C'\fR method is the only method added to your class, and will |
| 159 | generate a unique 32 hexidecimal signature for any object it is called on. |
| 160 | .SH "SUPPORT" |
| 161 | .IX Header "SUPPORT" |
| 162 | All bugs should be filed via the bug tracker at |
| 163 | .PP |
| 164 | <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Object\-Signature> |
| 165 | .PP |
| 166 | For other issues, or commercial enhancement or support, contact the author. |
| 167 | .SH "TO DO" |
| 168 | .IX Header "TO DO" |
| 169 | .SS "Incremental Generation" |
| 170 | .IX Subsection "Incremental Generation" |
| 171 | Currently has to generate the entire Storable string before digesting |
| 172 | it. Would be nice if there was a way to incrementally Storablise and Digest |
| 173 | in one pass so that it becomes much more memory efficient for large objects. |
| 174 | .SS "Strengthen the Digest Algorithm" |
| 175 | .IX Subsection "Strengthen the Digest Algorithm" |
| 176 | Once the current (as of 2005) hashing controversy settles down, consider |
| 177 | selecting a newer and more powerful hashing algorithm to replace \s-1MD5\s0. Or |
| 178 | offer alternatives depending on how important the security situation is, |
| 179 | as \s-1MD5\s0 is \fBvery\fR fast (90 meg a second) and many more-secure ones are a |
| 180 | lot slower (more than 10 times slower in some cases). |
| 181 | .PP |
| 182 | On our side is the fact we use Storable. It should be \fBmuch\fR harder to create |
| 183 | collisions when you don't control the string, only the structure \fBbefore\fR |
| 184 | it goes through Storable. |
| 185 | .SH "AUTHORS" |
| 186 | .IX Header "AUTHORS" |
| 187 | Adam Kennedy <adamk@cpan.org> |
| 188 | .SH "COPYRIGHT" |
| 189 | .IX Header "COPYRIGHT" |
| 190 | Copyright 2004 \- 2006 Adam Kennedy. |
| 191 | .PP |
| 192 | This program is free software; you can redistribute |
| 193 | it and/or modify it under the same terms as Perl itself. |
| 194 | .PP |
| 195 | The full text of the license can be found in the |
| 196 | \&\s-1LICENSE\s0 file included with this module. |
projects / catagits/Gitalist.git / blame