[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man3 / Crypt::Blowfish.3

.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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.  | will give a
.\" real vertical bar.  \*(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-|\(bv\*(Tr
.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" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Blowfish 3"
.TH Blowfish 3 "2001-11-12" "perl v5.8.0" "User Contributed Perl Documentation"
.SH "NAME"
Crypt::Blowfish \- Perl Blowfish encryption module
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\&  use Crypt::Blowfish;
\&  my $cipher = new Crypt::Blowfish $key; 
\&  my $ciphertext = $cipher->encrypt($plaintext);
\&  my $plaintext  = $cipher->decrypt($ciphertext);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Blowfish is capable of strong encryption and can use key sizes up
to 56 bytes (a 448 bit key).  You're encouraged to take advantage
of the full key size to ensure the strongest encryption possible
from this module.
.PP
Crypt::Blowfish has the following methods:
.Sp
.Vb 4
\& blocksize()
\& keysize()
\& encrypt()
\& decrypt()
.Ve
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.IP "blocksize" 4
.IX Item "blocksize"
Returns the size (in bytes) of the block cipher.
.Sp
Crypt::Blowfish doesn't return a key size due to its ability
to use variable-length keys. (well, more accurately, it won't
as of 2.09 .. for now, it does.  expect that to change)
.IP "new" 4
.IX Item "new"
.Vb 1
\&        my $cipher = new Crypt::Blowfish $key;
.Ve
.Sp
This creates a new Crypt::Blowfish BlockCipher object, using \f(CW$key\fR,
where \f(CW$key\fR is a key of \f(CW\*(C`keysize()\*(C'\fR bytes (minimum of eight bytes).
.IP "encrypt" 4
.IX Item "encrypt"
.Vb 2
\&        my $cipher = new Crypt::Blowfish $key;
\&        my $ciphertext = $cipher->encrypt($plaintext);
.Ve
.Sp
This function encrypts \f(CW$plaintext\fR and returns the \f(CW$ciphertext\fR
where \f(CW$plaintext\fR and \f(CW$ciphertext\fR must be of \f(CW\*(C`blocksize()\*(C'\fR bytes.
(hint:  Blowfish is an 8 byte block cipher)
.IP "decrypt" 4
.IX Item "decrypt"
.Vb 2
\&        my $cipher = new Crypt::Blowfish $key;
\&        my $plaintext = $cipher->decrypt($ciphertext);
.Ve
.Sp
This function decrypts \f(CW$ciphertext\fR and returns the \f(CW$plaintext\fR
where \f(CW$plaintext\fR and \f(CW$ciphertext\fR must be of \f(CW\*(C`blocksize()\*(C'\fR bytes.
(hint:  see previous hint)
.SH "EXAMPLE"
.IX Header "EXAMPLE"
.Vb 4
\&        my $key = pack("H16", "0123456789ABCDEF");  # min. 8 bytes
\&        my $cipher = new Crypt::Blowfish $key;
\&        my $ciphertext = $cipher->encrypt("plaintex");  # SEE NOTES 
\&        print unpack("H16", $ciphertext), "\en";
.Ve
.SH "PLATFORMS"
.IX Header "PLATFORMS"
.Vb 2
\&        Please see the README document for platforms and performance
\&        tests.
.Ve
.SH "NOTES"
.IX Header "NOTES"
The module is capable of being used with Crypt::CBC.  You're
encouraged to read the perldoc for Crypt::CBC if you intend to
use this module for Cipher Block Chaining modes.  In fact, if
you have any intentions of encrypting more than eight bytes of
data with this, or any other block cipher, you're going to need
\&\fBsome\fR type of block chaining help.  Crypt::CBC tends to be
very good at this.  If you're not going to encrypt more than 
eight bytes, your data \fBmust\fR be \fBexactly\fR eight bytes long.
If need be, do your own padding. \*(L"\e0\*(R" as a null byte is perfectly
valid to use for this.  Additionally, the current maintainer for 
Crypt::Blowfish may or may not release Crypt::CBC_R which 
replaces the default 'RandomIV' initialization vector in 
Crypt::CBC with a random initialization vector.  (to the limits 
of /dev/urandom and associates)  In either case, please email
amused@pobox.com for Crypt::CBC_R.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Crypt::CBC,
Crypt::DES,
Crypt::IDEA
.PP
Bruce Schneier, \fIApplied Cryptography\fR, 1995, Second Edition,
published by John Wiley & Sons, Inc.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
The implementation of the Blowfish algorithm was developed by,
and is copyright of, A.M. Kuchling.
.PP
Other parts of the perl extension and module are
copyright of Systemics Ltd ( http://www.systemics.com/ ). 
.PP
Code revisions, updates, and standalone release are copyright
1999\-2001 W3Works, \s-1LLC\s0.
.SH "AUTHOR"
.IX Header "AUTHOR"
Original algorithm, Bruce Shneier.  Original implementation, A.M.
Kuchling.  Original Perl implementation, Systemics Ltd.  Current
maintenance by W3Works, \s-1LLC\s0.
.PP
Current revision and maintainer:  Dave Paris <amused@pobox.com>
Commit	Line	Data
86530b38 AT	1	.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
	2	.\"
	3	.\" Standard preamble:
	4	.\" ========================================================================
	5	.de Sh \" Subsection heading
	6	.br
	7	.if t .Sp
	8	.ne 5
	9	.PP
	10	\fB\\$1\fR
	11	.PP
	12	..
	13	.de Sp \" Vertical space (when we can't use .PP)
	14	.if t .sp .5v
	15	.if n .sp
	16	..
	17	.de Vb \" Begin verbatim text
	18	.ft CW
	19	.nf
	20	.ne \\$1
	21	..
	22	.de Ve \" End verbatim text
	23	.ft R
	24	.fi
	25	..
	26	.\" Set up some character translations and predefined strings. \*(-- will
	27	.\" give an unbreakable dash, \(PI will give pi, \(L" will give a left
	28	.\" double quote, and \*(R" will give a right double quote. \| will give a
	29	.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
	30	.\" do unbreakable dashes and therefore won't be available. \(C` and \(C'
	31	.\" expand to `' in nroff, nothing in troff, for use with C<>.
	32	.tr \(W-\|\(bv\(Tr
	33	.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
	34	.ie n \{\
	35	. ds -- \(*W-
	36	. ds PI pi
	37	. if (\n(.H=4u)&(1m=24u) .ds -- \(W\h'-12u'\(W\h'-12u'-\" diablo 10 pitch
	38	. if (\n(.H=4u)&(1m=20u) .ds -- \(W\h'-12u'\(W\h'-8u'-\" diablo 12 pitch
	39	. ds L" ""
	40	. ds R" ""
	41	. ds C` ""
	42	. ds C' ""
	43	'br\}
	44	.el\{\
	45	. ds -- \\|\(em\\|
	46	. ds PI \(*p
	47	. ds L" ``
	48	. ds R" ''
	49	'br\}
	50	.\"
	51	.\" If the F register is turned on, we'll generate index entries on stderr for
	52	.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
	53	.\" entries marked with X<> in POD. Of course, you'll have to process the
	54	.\" output yourself in some meaningful fashion.
	55	.if \nF \{\
	56	. de IX
	57	. tm Index:\\$1\t\\n%\t"\\$2"
	58	..
	59	. nr % 0
	60	. rr F
	61	.\}
	62	.\"
	63	.\" For nroff, turn off justification. Always turn off hyphenation; it makes
	64	.\" way too many mistakes in technical documents.
65	.hy 0
66	.if n .na
67	.\"
68	.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69	.\" Fear. Run. Save yourself. No user-serviceable parts.
70	. \" fudge factors for nroff and troff
71	.if n \{\
72	. ds #H 0
73	. ds #V .8m
74	. ds #F .3m
75	. ds #[ \f1
76	. ds #] \fP
77	.\}
78	.if t \{\
79	. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80	. ds #V .6m
81	. ds #F 0
82	. ds #[ \&
83	. ds #] \&
84	.\}
85	. \" simple accents for nroff and troff
86	.if n \{\
87	. ds ' \&
88	. ds ` \&
89	. ds ^ \&
90	. ds , \&
91	. ds ~ ~
92	. ds /
93	.\}
94	.if t \{\
95	. ds ' \\k:\h'-(\\n(.wu8/10-\(#H)'\'\h"\|\\n:u"
96	. ds ` \\k:\h'-(\\n(.wu8/10-\(#H)'\`\h'\|\\n:u'
97	. ds ^ \\k:\h'-(\\n(.wu10/11-\(#H)'^\h'\|\\n:u'
98	. ds , \\k:\h'-(\\n(.wu*8/10)',\h'\|\\n:u'
99	. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'\|\\n:u'
100	. ds / \\k:\h'-(\\n(.wu8/10-\(#H)'\z\(sl\h'\|\\n:u'
101	.\}
102	. \" troff and (daisy-wheel) nroff accents
103	.ds : \\k:\h'-(\\n(.wu8/10-\(#H+.1m+\(#F)'\v'-\(#V'\z.\h'.2m+\(#F'.\h'\|\\n:u'\v'\(#V'
104	.ds 8 \h'\(#H'\(b\h'-\*(#H'
105	.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\(#H)/2u'\v'-.3n'\(#[\z\(de\v'.3n'\h'\|\\n:u'\*(#]
106	.ds d- \h'\(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\(#H'
107	.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'\|\\n:u'
108	.ds th \(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u2/3)'\s-1o\s+1\*(#]
109	.ds Th \(#[\s+2I\s-2\h'-\w'I'u3/5'\v'-.3m'o\v'.3m'\*(#]
110	.ds ae a\h'-(\w'a'u*4/10)'e
111	.ds Ae A\h'-(\w'A'u*4/10)'E
112	. \" corrections for vroff
113	.if v .ds ~ \\k:\h'-(\\n(.wu9/10-\(#H)'\s-2\u~\d\s+2\h'\|\\n:u'
114	.if v .ds ^ \\k:\h'-(\\n(.wu10/11-\(#H)'\v'-.4m'^\v'.4m'\h'\|\\n:u'
115	. \" for low resolution devices (crt and lpr)
116	.if \n(.H>23 .if \n(.V>19 \
117	\{\
118	. ds : e
119	. ds 8 ss
120	. ds o a
121	. ds d- d\h'-1'\(ga
122	. ds D- D\h'-1'\(hy
123	. ds th \o'bp'
124	. ds Th \o'LP'
125	. ds ae ae
126	. ds Ae AE
127	.\}
128	.rm #[ #] #H #V #F C
129	.\" ========================================================================
130	.\"
131	.IX Title "Blowfish 3"
132	.TH Blowfish 3 "2001-11-12" "perl v5.8.0" "User Contributed Perl Documentation"
133	.SH "NAME"
134	Crypt::Blowfish \- Perl Blowfish encryption module
135	.SH "SYNOPSIS"
136	.IX Header "SYNOPSIS"
137	.Vb 4
138	\& use Crypt::Blowfish;
139	\& my $cipher = new Crypt::Blowfish $key;
140	\& my $ciphertext = $cipher->encrypt($plaintext);
141	\& my $plaintext = $cipher->decrypt($ciphertext);
142	.Ve
143	.SH "DESCRIPTION"
144	.IX Header "DESCRIPTION"
145	Blowfish is capable of strong encryption and can use key sizes up
146	to 56 bytes (a 448 bit key). You're encouraged to take advantage
147	of the full key size to ensure the strongest encryption possible
148	from this module.
149	.PP
150	Crypt::Blowfish has the following methods:
151	.Sp
152	.Vb 4
153	\& blocksize()
154	\& keysize()
155	\& encrypt()
156	\& decrypt()
157	.Ve
158	.SH "FUNCTIONS"
159	.IX Header "FUNCTIONS"
160	.IP "blocksize" 4
161	.IX Item "blocksize"
162	Returns the size (in bytes) of the block cipher.
163	.Sp
164	Crypt::Blowfish doesn't return a key size due to its ability
165	to use variable-length keys. (well, more accurately, it won't
166	as of 2.09 .. for now, it does. expect that to change)
167	.IP "new" 4
168	.IX Item "new"
169	.Vb 1
170	\& my $cipher = new Crypt::Blowfish $key;
171	.Ve
172	.Sp
173	This creates a new Crypt::Blowfish BlockCipher object, using \f(CW$key\fR,
174	where \f(CW$key\fR is a key of \f(CW\(C`keysize()\(C'\fR bytes (minimum of eight bytes).
175	.IP "encrypt" 4
176	.IX Item "encrypt"
177	.Vb 2
178	\& my $cipher = new Crypt::Blowfish $key;
179	\& my $ciphertext = $cipher->encrypt($plaintext);
180	.Ve
181	.Sp
182	This function encrypts \f(CW$plaintext\fR and returns the \f(CW$ciphertext\fR
183	where \f(CW$plaintext\fR and \f(CW$ciphertext\fR must be of \f(CW\(C`blocksize()\(C'\fR bytes.
184	(hint: Blowfish is an 8 byte block cipher)
185	.IP "decrypt" 4
186	.IX Item "decrypt"
187	.Vb 2
188	\& my $cipher = new Crypt::Blowfish $key;
189	\& my $plaintext = $cipher->decrypt($ciphertext);
190	.Ve
191	.Sp
192	This function decrypts \f(CW$ciphertext\fR and returns the \f(CW$plaintext\fR
193	where \f(CW$plaintext\fR and \f(CW$ciphertext\fR must be of \f(CW\(C`blocksize()\(C'\fR bytes.
194	(hint: see previous hint)
195	.SH "EXAMPLE"
196	.IX Header "EXAMPLE"
197	.Vb 4
198	\& my $key = pack("H16", "0123456789ABCDEF"); # min. 8 bytes
199	\& my $cipher = new Crypt::Blowfish $key;
200	\& my $ciphertext = $cipher->encrypt("plaintex"); # SEE NOTES
201	\& print unpack("H16", $ciphertext), "\en";
202	.Ve
203	.SH "PLATFORMS"
204	.IX Header "PLATFORMS"
205	.Vb 2
206	\& Please see the README document for platforms and performance
207	\& tests.
208	.Ve
209	.SH "NOTES"
210	.IX Header "NOTES"
211	The module is capable of being used with Crypt::CBC. You're
212	encouraged to read the perldoc for Crypt::CBC if you intend to
213	use this module for Cipher Block Chaining modes. In fact, if
214	you have any intentions of encrypting more than eight bytes of
215	data with this, or any other block cipher, you're going to need
216	\&\fBsome\fR type of block chaining help. Crypt::CBC tends to be
217	very good at this. If you're not going to encrypt more than
218	eight bytes, your data \fBmust\fR be \fBexactly\fR eight bytes long.
219	If need be, do your own padding. \(L"\e0\(R" as a null byte is perfectly
220	valid to use for this. Additionally, the current maintainer for
221	Crypt::Blowfish may or may not release Crypt::CBC_R which
222	replaces the default 'RandomIV' initialization vector in
223	Crypt::CBC with a random initialization vector. (to the limits
224	of /dev/urandom and associates) In either case, please email
225	amused@pobox.com for Crypt::CBC_R.
226	.SH "SEE ALSO"
227	.IX Header "SEE ALSO"
228	Crypt::CBC,
229	Crypt::DES,
230	Crypt::IDEA
231	.PP
232	Bruce Schneier, \fIApplied Cryptography\fR, 1995, Second Edition,
233	published by John Wiley & Sons, Inc.
234	.SH "COPYRIGHT"
235	.IX Header "COPYRIGHT"
236	The implementation of the Blowfish algorithm was developed by,
237	and is copyright of, A.M. Kuchling.
238	.PP
239	Other parts of the perl extension and module are
240	copyright of Systemics Ltd ( http://www.systemics.com/ ).
241	.PP
242	Code revisions, updates, and standalone release are copyright
243	1999\-2001 W3Works, \s-1LLC\s0.
244	.SH "AUTHOR"
245	.IX Header "AUTHOR"
246	Original algorithm, Bruce Shneier. Original implementation, A.M.
247	Kuchling. Original Perl implementation, Systemics Ltd. Current
248	maintenance by W3Works, \s-1LLC\s0.
249	.PP
250	Current revision and maintainer: Dave Paris <amused@pobox.com>