1.\" Automatically generated by Pod::Man version 1.15
| 1.\" Automatically generated by Pod::Man version 1.15
|
2.\" Mon Jan 13 19:26:53 2003
| 2.\" Mon Feb 3 10:01:38 2003
|
3.\" 4.\" Standard preamble: 5.\" ====================================================================== 6.de Sh \" Subsection heading 7.br 8.if t .Sp 9.ne 5 10.PP 11\fB\\$1\fR 12.PP 13.. 14.de Sp \" Vertical space (when we can't use .PP) 15.if t .sp .5v 16.if n .sp 17.. 18.de Ip \" List item 19.br 20.ie \\n(.$>=3 .ne \\$3 21.el .ne 3 22.IP "\\$1" \\$2 23.. 24.de Vb \" Begin verbatim text 25.ft CW 26.nf 27.ne \\$1 28.. 29.de Ve \" End verbatim text 30.ft R 31 32.fi 33.. 34.\" Set up some character translations and predefined strings. \*(-- will 35.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left 36.\" double quote, and \*(R" will give a right double quote. | will give a 37.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used 38.\" to do unbreakable dashes and therefore won't be available. \*(C` and 39.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<> 40.tr \(*W-|\(bv\*(Tr 41.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' 42.ie n \{\ 43. ds -- \(*W- 44. ds PI pi 45. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch 46. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch 47. ds L" "" 48. ds R" "" 49. ds C` "" 50. ds C' "" 51'br\} 52.el\{\ 53. ds -- \|\(em\| 54. ds PI \(*p 55. ds L" `` 56. ds R" '' 57'br\} 58.\" 59.\" If the F register is turned on, we'll generate index entries on stderr 60.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and 61.\" index entries marked with X<> in POD. Of course, you'll have to process 62.\" the output yourself in some meaningful fashion. 63.if \nF \{\ 64. de IX 65. tm Index:\\$1\t\\n%\t"\\$2" 66.. 67. nr % 0 68. rr F 69.\} 70.\" 71.\" For nroff, turn off justification. Always turn off hyphenation; it 72.\" makes way too many mistakes in technical documents. 73.hy 0 74.if n .na 75.\" 76.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). 77.\" Fear. Run. Save yourself. No user-serviceable parts. 78.bd B 3 79. \" fudge factors for nroff and troff 80.if n \{\ 81. ds #H 0 82. ds #V .8m 83. ds #F .3m 84. ds #[ \f1 85. ds #] \fP 86.\} 87.if t \{\ 88. ds #H ((1u-(\\\\n(.fu%2u))*.13m) 89. ds #V .6m 90. ds #F 0 91. ds #[ \& 92. ds #] \& 93.\} 94. \" simple accents for nroff and troff 95.if n \{\ 96. ds ' \& 97. ds ` \& 98. ds ^ \& 99. ds , \& 100. ds ~ ~ 101. ds / 102.\} 103.if t \{\ 104. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" 105. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' 106. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' 107. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' 108. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' 109. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' 110.\} 111. \" troff and (daisy-wheel) nroff accents 112.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' 113.ds 8 \h'\*(#H'\(*b\h'-\*(#H' 114.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] 115.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' 116.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' 117.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] 118.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] 119.ds ae a\h'-(\w'a'u*4/10)'e 120.ds Ae A\h'-(\w'A'u*4/10)'E 121. \" corrections for vroff 122.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' 123.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' 124. \" for low resolution devices (crt and lpr) 125.if \n(.H>23 .if \n(.V>19 \ 126\{\ 127. ds : e 128. ds 8 ss 129. ds o a 130. ds d- d\h'-1'\(ga 131. ds D- D\h'-1'\(hy 132. ds th \o'bp' 133. ds Th \o'LP' 134. ds ae ae 135. ds Ae AE 136.\} 137.rm #[ #] #H #V #F C 138.\" ====================================================================== 139.\" 140.IX Title "BIO_f_cipher 3"
| 3.\" 4.\" Standard preamble: 5.\" ====================================================================== 6.de Sh \" Subsection heading 7.br 8.if t .Sp 9.ne 5 10.PP 11\fB\\$1\fR 12.PP 13.. 14.de Sp \" Vertical space (when we can't use .PP) 15.if t .sp .5v 16.if n .sp 17.. 18.de Ip \" List item 19.br 20.ie \\n(.$>=3 .ne \\$3 21.el .ne 3 22.IP "\\$1" \\$2 23.. 24.de Vb \" Begin verbatim text 25.ft CW 26.nf 27.ne \\$1 28.. 29.de Ve \" End verbatim text 30.ft R 31 32.fi 33.. 34.\" Set up some character translations and predefined strings. \*(-- will 35.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left 36.\" double quote, and \*(R" will give a right double quote. | will give a 37.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used 38.\" to do unbreakable dashes and therefore won't be available. \*(C` and 39.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<> 40.tr \(*W-|\(bv\*(Tr 41.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' 42.ie n \{\ 43. ds -- \(*W- 44. ds PI pi 45. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch 46. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch 47. ds L" "" 48. ds R" "" 49. ds C` "" 50. ds C' "" 51'br\} 52.el\{\ 53. ds -- \|\(em\| 54. ds PI \(*p 55. ds L" `` 56. ds R" '' 57'br\} 58.\" 59.\" If the F register is turned on, we'll generate index entries on stderr 60.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and 61.\" index entries marked with X<> in POD. Of course, you'll have to process 62.\" the output yourself in some meaningful fashion. 63.if \nF \{\ 64. de IX 65. tm Index:\\$1\t\\n%\t"\\$2" 66.. 67. nr % 0 68. rr F 69.\} 70.\" 71.\" For nroff, turn off justification. Always turn off hyphenation; it 72.\" makes way too many mistakes in technical documents. 73.hy 0 74.if n .na 75.\" 76.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). 77.\" Fear. Run. Save yourself. No user-serviceable parts. 78.bd B 3 79. \" fudge factors for nroff and troff 80.if n \{\ 81. ds #H 0 82. ds #V .8m 83. ds #F .3m 84. ds #[ \f1 85. ds #] \fP 86.\} 87.if t \{\ 88. ds #H ((1u-(\\\\n(.fu%2u))*.13m) 89. ds #V .6m 90. ds #F 0 91. ds #[ \& 92. ds #] \& 93.\} 94. \" simple accents for nroff and troff 95.if n \{\ 96. ds ' \& 97. ds ` \& 98. ds ^ \& 99. ds , \& 100. ds ~ ~ 101. ds / 102.\} 103.if t \{\ 104. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" 105. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' 106. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' 107. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' 108. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' 109. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' 110.\} 111. \" troff and (daisy-wheel) nroff accents 112.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' 113.ds 8 \h'\*(#H'\(*b\h'-\*(#H' 114.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] 115.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' 116.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' 117.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] 118.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] 119.ds ae a\h'-(\w'a'u*4/10)'e 120.ds Ae A\h'-(\w'A'u*4/10)'E 121. \" corrections for vroff 122.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' 123.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' 124. \" for low resolution devices (crt and lpr) 125.if \n(.H>23 .if \n(.V>19 \ 126\{\ 127. ds : e 128. ds 8 ss 129. ds o a 130. ds d- d\h'-1'\(ga 131. ds D- D\h'-1'\(hy 132. ds th \o'bp' 133. ds Th \o'LP' 134. ds ae ae 135. ds Ae AE 136.\} 137.rm #[ #] #H #V #F C 138.\" ====================================================================== 139.\" 140.IX Title "BIO_f_cipher 3"
|
141.TH BIO_f_cipher 3 "0.9.7" "2003-01-13" "OpenSSL"
| 141.TH BIO_f_cipher 3 "0.9.7" "2003-02-03" "OpenSSL"
|
142.UC 143.SH "NAME" 144BIO_f_cipher, BIO_set_cipher, BIO_get_cipher_status, BIO_get_cipher_ctx \- cipher \s-1BIO\s0 filter 145.SH "SYNOPSIS" 146.IX Header "SYNOPSIS" 147.Vb 2 148\& #include <openssl/bio.h> 149\& #include <openssl/evp.h> 150.Ve 151.Vb 5 152\& BIO_METHOD * BIO_f_cipher(void); 153\& void BIO_set_cipher(BIO *b,const EVP_CIPHER *cipher, 154\& unsigned char *key, unsigned char *iv, int enc); 155\& int BIO_get_cipher_status(BIO *b) 156\& int BIO_get_cipher_ctx(BIO *b, EVP_CIPHER_CTX **pctx) 157.Ve 158.SH "DESCRIPTION" 159.IX Header "DESCRIPTION" 160\&\fIBIO_f_cipher()\fR returns the cipher \s-1BIO\s0 method. This is a filter 161\&\s-1BIO\s0 that encrypts any data written through it, and decrypts any data 162read from it. It is a \s-1BIO\s0 wrapper for the cipher routines 163\&\fIEVP_CipherInit()\fR, \fIEVP_CipherUpdate()\fR and \fIEVP_CipherFinal()\fR. 164.PP 165Cipher BIOs do not support \fIBIO_gets()\fR or \fIBIO_puts()\fR. 166.PP 167\&\fIBIO_flush()\fR on an encryption \s-1BIO\s0 that is being written through is 168used to signal that no more data is to be encrypted: this is used 169to flush and possibly pad the final block through the \s-1BIO\s0. 170.PP 171\&\fIBIO_set_cipher()\fR sets the cipher of \s-1BIO\s0 <b> to \fBcipher\fR using key \fBkey\fR 172and \s-1IV\s0 \fBiv\fR. \fBenc\fR should be set to 1 for encryption and zero for 173decryption. 174.PP 175When reading from an encryption \s-1BIO\s0 the final block is automatically 176decrypted and checked when \s-1EOF\s0 is detected. \fIBIO_get_cipher_status()\fR 177is a \fIBIO_ctrl()\fR macro which can be called to determine whether the 178decryption operation was successful. 179.PP 180\&\fIBIO_get_cipher_ctx()\fR is a \fIBIO_ctrl()\fR macro which retrieves the internal 181\&\s-1BIO\s0 cipher context. The retrieved context can be used in conjunction 182with the standard cipher routines to set it up. This is useful when 183\&\fIBIO_set_cipher()\fR is not flexible enough for the applications needs. 184.SH "NOTES" 185.IX Header "NOTES" 186When encrypting \fIBIO_flush()\fR \fBmust\fR be called to flush the final block 187through the \s-1BIO\s0. If it is not then the final block will fail a subsequent 188decrypt. 189.PP 190When decrypting an error on the final block is signalled by a zero 191return value from the read operation. A successful decrypt followed 192by \s-1EOF\s0 will also return zero for the final read. \fIBIO_get_cipher_status()\fR 193should be called to determine if the decrypt was successful. 194.PP 195As always, if \fIBIO_gets()\fR or \fIBIO_puts()\fR support is needed then it can 196be achieved by preceding the cipher \s-1BIO\s0 with a buffering \s-1BIO\s0. 197.SH "RETURN VALUES" 198.IX Header "RETURN VALUES" 199\&\fIBIO_f_cipher()\fR returns the cipher \s-1BIO\s0 method. 200.PP 201\&\fIBIO_set_cipher()\fR does not return a value. 202.PP 203\&\fIBIO_get_cipher_status()\fR returns 1 for a successful decrypt and 0 204for failure. 205.PP 206\&\fIBIO_get_cipher_ctx()\fR currently always returns 1. 207.SH "EXAMPLES" 208.IX Header "EXAMPLES" 209\&\s-1TBA\s0 210.SH "SEE ALSO" 211.IX Header "SEE ALSO" 212\&\s-1TBA\s0
| 142.UC 143.SH "NAME" 144BIO_f_cipher, BIO_set_cipher, BIO_get_cipher_status, BIO_get_cipher_ctx \- cipher \s-1BIO\s0 filter 145.SH "SYNOPSIS" 146.IX Header "SYNOPSIS" 147.Vb 2 148\& #include <openssl/bio.h> 149\& #include <openssl/evp.h> 150.Ve 151.Vb 5 152\& BIO_METHOD * BIO_f_cipher(void); 153\& void BIO_set_cipher(BIO *b,const EVP_CIPHER *cipher, 154\& unsigned char *key, unsigned char *iv, int enc); 155\& int BIO_get_cipher_status(BIO *b) 156\& int BIO_get_cipher_ctx(BIO *b, EVP_CIPHER_CTX **pctx) 157.Ve 158.SH "DESCRIPTION" 159.IX Header "DESCRIPTION" 160\&\fIBIO_f_cipher()\fR returns the cipher \s-1BIO\s0 method. This is a filter 161\&\s-1BIO\s0 that encrypts any data written through it, and decrypts any data 162read from it. It is a \s-1BIO\s0 wrapper for the cipher routines 163\&\fIEVP_CipherInit()\fR, \fIEVP_CipherUpdate()\fR and \fIEVP_CipherFinal()\fR. 164.PP 165Cipher BIOs do not support \fIBIO_gets()\fR or \fIBIO_puts()\fR. 166.PP 167\&\fIBIO_flush()\fR on an encryption \s-1BIO\s0 that is being written through is 168used to signal that no more data is to be encrypted: this is used 169to flush and possibly pad the final block through the \s-1BIO\s0. 170.PP 171\&\fIBIO_set_cipher()\fR sets the cipher of \s-1BIO\s0 <b> to \fBcipher\fR using key \fBkey\fR 172and \s-1IV\s0 \fBiv\fR. \fBenc\fR should be set to 1 for encryption and zero for 173decryption. 174.PP 175When reading from an encryption \s-1BIO\s0 the final block is automatically 176decrypted and checked when \s-1EOF\s0 is detected. \fIBIO_get_cipher_status()\fR 177is a \fIBIO_ctrl()\fR macro which can be called to determine whether the 178decryption operation was successful. 179.PP 180\&\fIBIO_get_cipher_ctx()\fR is a \fIBIO_ctrl()\fR macro which retrieves the internal 181\&\s-1BIO\s0 cipher context. The retrieved context can be used in conjunction 182with the standard cipher routines to set it up. This is useful when 183\&\fIBIO_set_cipher()\fR is not flexible enough for the applications needs. 184.SH "NOTES" 185.IX Header "NOTES" 186When encrypting \fIBIO_flush()\fR \fBmust\fR be called to flush the final block 187through the \s-1BIO\s0. If it is not then the final block will fail a subsequent 188decrypt. 189.PP 190When decrypting an error on the final block is signalled by a zero 191return value from the read operation. A successful decrypt followed 192by \s-1EOF\s0 will also return zero for the final read. \fIBIO_get_cipher_status()\fR 193should be called to determine if the decrypt was successful. 194.PP 195As always, if \fIBIO_gets()\fR or \fIBIO_puts()\fR support is needed then it can 196be achieved by preceding the cipher \s-1BIO\s0 with a buffering \s-1BIO\s0. 197.SH "RETURN VALUES" 198.IX Header "RETURN VALUES" 199\&\fIBIO_f_cipher()\fR returns the cipher \s-1BIO\s0 method. 200.PP 201\&\fIBIO_set_cipher()\fR does not return a value. 202.PP 203\&\fIBIO_get_cipher_status()\fR returns 1 for a successful decrypt and 0 204for failure. 205.PP 206\&\fIBIO_get_cipher_ctx()\fR currently always returns 1. 207.SH "EXAMPLES" 208.IX Header "EXAMPLES" 209\&\s-1TBA\s0 210.SH "SEE ALSO" 211.IX Header "SEE ALSO" 212\&\s-1TBA\s0
|