239 lines
9.5 KiB
Plaintext
239 lines
9.5 KiB
Plaintext
|
.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
|
||
|
|
.\"
|
||
|
|
.\" Standard preamble:
|
||
|
|
.\" ========================================================================
|
||
|
|
.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. \*(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-
|
||
|
|
.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" ''
|
||
|
|
. ds C`
|
||
|
|
. ds C'
|
||
|
|
'br\}
|
||
|
|
.\"
|
||
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
||
|
|
.ie \n(.g .ds Aq \(aq
|
||
|
|
.el .ds Aq '
|
||
|
|
.\"
|
||
|
|
.\" If the F register is turned on, we'll generate index entries on stderr for
|
||
|
|
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
|
||
|
|
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
||
|
|
.\" output yourself in some meaningful fashion.
|
||
|
|
.\"
|
||
|
|
.\" Avoid warning from groff about undefined register 'F'.
|
||
|
|
.de IX
|
||
|
|
..
|
||
|
|
.nr rF 0
|
||
|
|
.if \n(.g .if rF .nr rF 1
|
||
|
|
.if (\n(rF:(\n(.g==0)) \{
|
||
|
|
. if \nF \{
|
||
|
|
. de IX
|
||
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
||
|
|
..
|
||
|
|
. if !\nF==2 \{
|
||
|
|
. nr % 0
|
||
|
|
. nr F 2
|
||
|
|
. \}
|
||
|
|
. \}
|
||
|
|
.\}
|
||
|
|
.rr rF
|
||
|
|
.\"
|
||
|
|
.\" 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 "EVP 7ossl"
|
||
|
|
.TH EVP 7ossl "2024-01-30" "3.2.1" "OpenSSL"
|
||
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
||
|
|
.\" way too many mistakes in technical documents.
|
||
|
|
.if n .ad l
|
||
|
|
.nh
|
||
|
|
.SH "NAME"
|
||
|
|
evp \- high\-level cryptographic functions
|
||
|
|
.SH "SYNOPSIS"
|
||
|
|
.IX Header "SYNOPSIS"
|
||
|
|
.Vb 1
|
||
|
|
\& #include <openssl/evp.h>
|
||
|
|
.Ve
|
||
|
|
.SH "DESCRIPTION"
|
||
|
|
.IX Header "DESCRIPTION"
|
||
|
|
The \s-1EVP\s0 library provides a high-level interface to cryptographic
|
||
|
|
functions.
|
||
|
|
.PP
|
||
|
|
The \fBEVP_Seal\fR\fI\s-1XXX\s0\fR and \fBEVP_Open\fR\fI\s-1XXX\s0\fR
|
||
|
|
functions provide public key encryption and decryption to implement digital \*(L"envelopes\*(R".
|
||
|
|
.PP
|
||
|
|
The \fBEVP_DigestSign\fR\fI\s-1XXX\s0\fR and
|
||
|
|
\&\fBEVP_DigestVerify\fR\fI\s-1XXX\s0\fR functions implement
|
||
|
|
digital signatures and Message Authentication Codes (MACs). Also see the older
|
||
|
|
\&\fBEVP_Sign\fR\fI\s-1XXX\s0\fR and \fBEVP_Verify\fR\fI\s-1XXX\s0\fR
|
||
|
|
functions.
|
||
|
|
.PP
|
||
|
|
Symmetric encryption is available with the \fBEVP_Encrypt\fR\fI\s-1XXX\s0\fR
|
||
|
|
functions. The \fBEVP_Digest\fR\fI\s-1XXX\s0\fR functions provide message digests.
|
||
|
|
.PP
|
||
|
|
The \fB\s-1EVP_PKEY\s0\fR\fI\s-1XXX\s0\fR functions provide a high-level interface to
|
||
|
|
asymmetric algorithms. To create a new \s-1EVP_PKEY\s0 see
|
||
|
|
\&\fIEVP_PKEY_new\fR\|(3). EVP_PKEYs can be associated
|
||
|
|
with a private key of a particular algorithm by using the functions
|
||
|
|
described on the \fIEVP_PKEY_fromdata\fR\|(3) page, or
|
||
|
|
new keys can be generated using \fIEVP_PKEY_keygen\fR\|(3).
|
||
|
|
EVP_PKEYs can be compared using \fIEVP_PKEY_eq\fR\|(3), or printed using
|
||
|
|
\&\fIEVP_PKEY_print_private\fR\|(3). \fIEVP_PKEY_todata\fR\|(3) can be used to convert a
|
||
|
|
key back into an \s-1\fIOSSL_PARAM\s0\fR\|(3) array.
|
||
|
|
.PP
|
||
|
|
The \s-1EVP_PKEY\s0 functions support the full range of asymmetric algorithm operations:
|
||
|
|
.IP "For key agreement see \fIEVP_PKEY_derive\fR\|(3)" 4
|
||
|
|
.IX Item "For key agreement see EVP_PKEY_derive"
|
||
|
|
.PD 0
|
||
|
|
.IP "For signing and verifying see \fIEVP_PKEY_sign\fR\|(3), \fIEVP_PKEY_verify\fR\|(3) and \fIEVP_PKEY_verify_recover\fR\|(3). However, note that these functions do not perform a digest of the data to be signed. Therefore, normally you would use the \fIEVP_DigestSignInit\fR\|(3) functions for this purpose." 4
|
||
|
|
.IX Item "For signing and verifying see EVP_PKEY_sign, EVP_PKEY_verify and EVP_PKEY_verify_recover. However, note that these functions do not perform a digest of the data to be signed. Therefore, normally you would use the EVP_DigestSignInit functions for this purpose."
|
||
|
|
.ie n .IP "For encryption and decryption see \fIEVP_PKEY_encrypt\fR\|(3) and \fIEVP_PKEY_decrypt\fR\|(3) respectively. However, note that these functions perform encryption and decryption only. As public key encryption is an expensive operation, normally you would wrap an encrypted message in a ""digital envelope"" using the \fIEVP_SealInit\fR\|(3) and \fIEVP_OpenInit\fR\|(3) functions." 4
|
||
|
|
.el .IP "For encryption and decryption see \fIEVP_PKEY_encrypt\fR\|(3) and \fIEVP_PKEY_decrypt\fR\|(3) respectively. However, note that these functions perform encryption and decryption only. As public key encryption is an expensive operation, normally you would wrap an encrypted message in a ``digital envelope'' using the \fIEVP_SealInit\fR\|(3) and \fIEVP_OpenInit\fR\|(3) functions." 4
|
||
|
|
.IX Item "For encryption and decryption see EVP_PKEY_encrypt and EVP_PKEY_decrypt respectively. However, note that these functions perform encryption and decryption only. As public key encryption is an expensive operation, normally you would wrap an encrypted message in a digital envelope using the EVP_SealInit and EVP_OpenInit functions."
|
||
|
|
.PD
|
||
|
|
.PP
|
||
|
|
The \fIEVP_BytesToKey\fR\|(3) function provides some limited support for password
|
||
|
|
based encryption. Careful selection of the parameters will provide a PKCS#5 \s-1PBKDF1\s0 compatible
|
||
|
|
implementation. However, new applications should not typically use this (preferring, for example,
|
||
|
|
\&\s-1PBKDF2\s0 from PCKS#5).
|
||
|
|
.PP
|
||
|
|
The \fBEVP_Encode\fR\fI\s-1XXX\s0\fR and
|
||
|
|
\&\fBEVP_Decode\fR\fI\s-1XXX\s0\fR functions implement base 64 encoding
|
||
|
|
and decoding.
|
||
|
|
.PP
|
||
|
|
All the symmetric algorithms (ciphers), digests and asymmetric algorithms
|
||
|
|
(public key algorithms) can be replaced by \s-1ENGINE\s0 modules providing alternative
|
||
|
|
implementations. If \s-1ENGINE\s0 implementations of ciphers or digests are registered
|
||
|
|
as defaults, then the various \s-1EVP\s0 functions will automatically use those
|
||
|
|
implementations automatically in preference to built in software
|
||
|
|
implementations. For more information, consult the \fIengine\fR\|(3) man page.
|
||
|
|
.PP
|
||
|
|
Although low-level algorithm specific functions exist for many algorithms
|
||
|
|
their use is discouraged. They cannot be used with an \s-1ENGINE\s0 and \s-1ENGINE\s0
|
||
|
|
versions of new algorithms cannot be accessed using the low-level functions.
|
||
|
|
Also makes code harder to adapt to new algorithms and some options are not
|
||
|
|
cleanly supported at the low-level and some operations are more efficient
|
||
|
|
using the high-level interface.
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
.IX Header "SEE ALSO"
|
||
|
|
\&\fIEVP_DigestInit\fR\|(3),
|
||
|
|
\&\fIEVP_EncryptInit\fR\|(3),
|
||
|
|
\&\fIEVP_OpenInit\fR\|(3),
|
||
|
|
\&\fIEVP_SealInit\fR\|(3),
|
||
|
|
\&\fIEVP_DigestSignInit\fR\|(3),
|
||
|
|
\&\fIEVP_SignInit\fR\|(3),
|
||
|
|
\&\fIEVP_VerifyInit\fR\|(3),
|
||
|
|
\&\fIEVP_EncodeInit\fR\|(3),
|
||
|
|
\&\fIEVP_PKEY_new\fR\|(3),
|
||
|
|
\&\fIEVP_PKEY_fromdata\fR\|(3),
|
||
|
|
\&\fIEVP_PKEY_todata\fR\|(3),
|
||
|
|
\&\fIEVP_PKEY_keygen\fR\|(3),
|
||
|
|
\&\fIEVP_PKEY_print_private\fR\|(3),
|
||
|
|
\&\fIEVP_PKEY_decrypt\fR\|(3),
|
||
|
|
\&\fIEVP_PKEY_encrypt\fR\|(3),
|
||
|
|
\&\fIEVP_PKEY_sign\fR\|(3),
|
||
|
|
\&\fIEVP_PKEY_verify\fR\|(3),
|
||
|
|
\&\fIEVP_PKEY_verify_recover\fR\|(3),
|
||
|
|
\&\fIEVP_PKEY_derive\fR\|(3),
|
||
|
|
\&\fIEVP_BytesToKey\fR\|(3),
|
||
|
|
\&\fIENGINE_by_id\fR\|(3)
|
||
|
|
.SH "COPYRIGHT"
|
||
|
|
.IX Header "COPYRIGHT"
|
||
|
|
Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved.
|
||
|
|
.PP
|
||
|
|
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
|
||
|
|
this file except in compliance with the License. You can obtain a copy
|
||
|
|
in the file \s-1LICENSE\s0 in the source distribution or at
|
||
|
|
<https://www.openssl.org/source/license.html>.
|