288 lines
12 KiB
Groff
288 lines
12 KiB
Groff
.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
|
|
.\"
|
|
.\" 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 >0, 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
|
|
..
|
|
.if !\nF .nr F 0
|
|
.if \nF>0 \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. if !\nF==2 \{\
|
|
. nr % 0
|
|
. nr F 2
|
|
. \}
|
|
.\}
|
|
.\"
|
|
.\" 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_MD_METH_NEW 3"
|
|
.TH EVP_MD_METH_NEW 3 "2018-11-20" "1.1.1a" "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_MD_meth_dup, EVP_MD_meth_new, EVP_MD_meth_free, EVP_MD_meth_set_input_blocksize, EVP_MD_meth_set_result_size, EVP_MD_meth_set_app_datasize, EVP_MD_meth_set_flags, EVP_MD_meth_set_init, EVP_MD_meth_set_update, EVP_MD_meth_set_final, EVP_MD_meth_set_copy, EVP_MD_meth_set_cleanup, EVP_MD_meth_set_ctrl, EVP_MD_meth_get_input_blocksize, EVP_MD_meth_get_result_size, EVP_MD_meth_get_app_datasize, EVP_MD_meth_get_flags, EVP_MD_meth_get_init, EVP_MD_meth_get_update, EVP_MD_meth_get_final, EVP_MD_meth_get_copy, EVP_MD_meth_get_cleanup, EVP_MD_meth_get_ctrl \&\- Routines to build up EVP_MD methods
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/evp.h>
|
|
\&
|
|
\& EVP_MD *EVP_MD_meth_new(int md_type, int pkey_type);
|
|
\& void EVP_MD_meth_free(EVP_MD *md);
|
|
\& EVP_MD *EVP_MD_meth_dup(const EVP_MD *md);
|
|
\&
|
|
\& int EVP_MD_meth_set_input_blocksize(EVP_MD *md, int blocksize);
|
|
\& int EVP_MD_meth_set_result_size(EVP_MD *md, int resultsize);
|
|
\& int EVP_MD_meth_set_app_datasize(EVP_MD *md, int datasize);
|
|
\& int EVP_MD_meth_set_flags(EVP_MD *md, unsigned long flags);
|
|
\& int EVP_MD_meth_set_init(EVP_MD *md, int (*init)(EVP_MD_CTX *ctx));
|
|
\& int EVP_MD_meth_set_update(EVP_MD *md, int (*update)(EVP_MD_CTX *ctx,
|
|
\& const void *data,
|
|
\& size_t count));
|
|
\& int EVP_MD_meth_set_final(EVP_MD *md, int (*final)(EVP_MD_CTX *ctx,
|
|
\& unsigned char *md));
|
|
\& int EVP_MD_meth_set_copy(EVP_MD *md, int (*copy)(EVP_MD_CTX *to,
|
|
\& const EVP_MD_CTX *from));
|
|
\& int EVP_MD_meth_set_cleanup(EVP_MD *md, int (*cleanup)(EVP_MD_CTX *ctx));
|
|
\& int EVP_MD_meth_set_ctrl(EVP_MD *md, int (*ctrl)(EVP_MD_CTX *ctx, int cmd,
|
|
\& int p1, void *p2));
|
|
\&
|
|
\& int EVP_MD_meth_get_input_blocksize(const EVP_MD *md);
|
|
\& int EVP_MD_meth_get_result_size(const EVP_MD *md);
|
|
\& int EVP_MD_meth_get_app_datasize(const EVP_MD *md);
|
|
\& unsigned long EVP_MD_meth_get_flags(const EVP_MD *md);
|
|
\& int (*EVP_MD_meth_get_init(const EVP_MD *md))(EVP_MD_CTX *ctx);
|
|
\& int (*EVP_MD_meth_get_update(const EVP_MD *md))(EVP_MD_CTX *ctx,
|
|
\& const void *data,
|
|
\& size_t count);
|
|
\& int (*EVP_MD_meth_get_final(const EVP_MD *md))(EVP_MD_CTX *ctx,
|
|
\& unsigned char *md);
|
|
\& int (*EVP_MD_meth_get_copy(const EVP_MD *md))(EVP_MD_CTX *to,
|
|
\& const EVP_MD_CTX *from);
|
|
\& int (*EVP_MD_meth_get_cleanup(const EVP_MD *md))(EVP_MD_CTX *ctx);
|
|
\& int (*EVP_MD_meth_get_ctrl(const EVP_MD *md))(EVP_MD_CTX *ctx, int cmd,
|
|
\& int p1, void *p2);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
The \fB\s-1EVP_MD\s0\fR type is a structure for digest method implementation.
|
|
It can also have associated public/private key signing and verifying
|
|
routines.
|
|
.PP
|
|
\&\fIEVP_MD_meth_new()\fR creates a new \fB\s-1EVP_MD\s0\fR structure.
|
|
.PP
|
|
\&\fIEVP_MD_meth_dup()\fR creates a copy of \fBmd\fR.
|
|
.PP
|
|
\&\fIEVP_MD_meth_free()\fR destroys a \fB\s-1EVP_MD\s0\fR structure.
|
|
.PP
|
|
\&\fIEVP_MD_meth_set_input_blocksize()\fR sets the internal input block size
|
|
for the method \fBmd\fR to \fBblocksize\fR bytes.
|
|
.PP
|
|
\&\fIEVP_MD_meth_set_result_size()\fR sets the size of the result that the
|
|
digest method in \fBmd\fR is expected to produce to \fBresultsize\fR bytes.
|
|
.PP
|
|
The digest method may have its own private data, which OpenSSL will
|
|
allocate for it. \fIEVP_MD_meth_set_app_datasize()\fR should be used to
|
|
set the size for it to \fBdatasize\fR.
|
|
.PP
|
|
\&\fIEVP_MD_meth_set_flags()\fR sets the flags to describe optional
|
|
behaviours in the particular \fBmd\fR. Several flags can be or'd
|
|
together. The available flags are:
|
|
.IP "\s-1EVP_MD_FLAG_ONESHOT\s0" 4
|
|
.IX Item "EVP_MD_FLAG_ONESHOT"
|
|
This digest method can only handles one block of input.
|
|
.IP "\s-1EVP_MD_FLAG_DIGALGID_NULL\s0" 4
|
|
.IX Item "EVP_MD_FLAG_DIGALGID_NULL"
|
|
When setting up a DigestAlgorithmIdentifier, this flag will have the
|
|
parameter set to \s-1NULL\s0 by default. Use this for PKCS#1. \fINote: if
|
|
combined with \s-1EVP_MD_FLAG_DIGALGID_ABSENT,\s0 the latter will override.\fR
|
|
.IP "\s-1EVP_MD_FLAG_DIGALGID_ABSENT\s0" 4
|
|
.IX Item "EVP_MD_FLAG_DIGALGID_ABSENT"
|
|
When setting up a DigestAlgorithmIdentifier, this flag will have the
|
|
parameter be left absent by default. \fINote: if combined with
|
|
\&\s-1EVP_MD_FLAG_DIGALGID_NULL,\s0 the latter will be overridden.\fR
|
|
.IP "\s-1EVP_MD_FLAG_DIGALGID_CUSTOM\s0" 4
|
|
.IX Item "EVP_MD_FLAG_DIGALGID_CUSTOM"
|
|
Custom DigestAlgorithmIdentifier handling via ctrl, with
|
|
\&\fB\s-1EVP_MD_FLAG_DIGALGID_ABSENT\s0\fR as default. \fINote: if combined with
|
|
\&\s-1EVP_MD_FLAG_DIGALGID_NULL,\s0 the latter will be overridden.\fR
|
|
Currently unused.
|
|
.PP
|
|
\&\fIEVP_MD_meth_set_init()\fR sets the digest init function for \fBmd\fR.
|
|
The digest init function is called by \fIEVP_DigestInit()\fR,
|
|
\&\fIEVP_DigestInit_ex()\fR, EVP_SignInit, \fIEVP_SignInit_ex()\fR, \fIEVP_VerifyInit()\fR
|
|
and \fIEVP_VerifyInit_ex()\fR.
|
|
.PP
|
|
\&\fIEVP_MD_meth_set_update()\fR sets the digest update function for \fBmd\fR.
|
|
The digest update function is called by \fIEVP_DigestUpdate()\fR,
|
|
\&\fIEVP_SignUpdate()\fR.
|
|
.PP
|
|
\&\fIEVP_MD_meth_set_final()\fR sets the digest final function for \fBmd\fR.
|
|
The digest final function is called by \fIEVP_DigestFinal()\fR,
|
|
\&\fIEVP_DigestFinal_ex()\fR, \fIEVP_SignFinal()\fR and \fIEVP_VerifyFinal()\fR.
|
|
.PP
|
|
\&\fIEVP_MD_meth_set_copy()\fR sets the function for \fBmd\fR to do extra
|
|
computations after the method's private data structure has been copied
|
|
from one \fB\s-1EVP_MD_CTX\s0\fR to another. If all that's needed is to copy
|
|
the data, there is no need for this copy function.
|
|
Note that the copy function is passed two \fB\s-1EVP_MD_CTX\s0 *\fR, the private
|
|
data structure is then available with \fIEVP_MD_CTX_md_data()\fR.
|
|
This copy function is called by \fIEVP_MD_CTX_copy()\fR and
|
|
\&\fIEVP_MD_CTX_copy_ex()\fR.
|
|
.PP
|
|
\&\fIEVP_MD_meth_set_cleanup()\fR sets the function for \fBmd\fR to do extra
|
|
cleanup before the method's private data structure is cleaned out and
|
|
freed.
|
|
Note that the cleanup function is passed a \fB\s-1EVP_MD_CTX\s0 *\fR, the
|
|
private data structure is then available with \fIEVP_MD_CTX_md_data()\fR.
|
|
This cleanup function is called by \fIEVP_MD_CTX_reset()\fR and
|
|
\&\fIEVP_MD_CTX_free()\fR.
|
|
.PP
|
|
\&\fIEVP_MD_meth_set_ctrl()\fR sets the control function for \fBmd\fR.
|
|
.PP
|
|
\&\fIEVP_MD_meth_get_input_blocksize()\fR, \fIEVP_MD_meth_get_result_size()\fR,
|
|
\&\fIEVP_MD_meth_get_app_datasize()\fR, \fIEVP_MD_meth_get_flags()\fR,
|
|
\&\fIEVP_MD_meth_get_init()\fR, \fIEVP_MD_meth_get_update()\fR,
|
|
\&\fIEVP_MD_meth_get_final()\fR, \fIEVP_MD_meth_get_copy()\fR,
|
|
\&\fIEVP_MD_meth_get_cleanup()\fR and \fIEVP_MD_meth_get_ctrl()\fR are all used
|
|
to retrieve the method data given with the EVP_MD_meth_set_*()
|
|
functions above.
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
\&\fIEVP_MD_meth_new()\fR and \fIEVP_MD_meth_dup()\fR return a pointer to a newly
|
|
created \fB\s-1EVP_MD\s0\fR, or \s-1NULL\s0 on failure.
|
|
All EVP_MD_meth_set_*() functions return 1.
|
|
\&\fIEVP_MD_get_input_blocksize()\fR, \fIEVP_MD_meth_get_result_size()\fR,
|
|
\&\fIEVP_MD_meth_get_app_datasize()\fR and \fIEVP_MD_meth_get_flags()\fR return the
|
|
indicated sizes or flags.
|
|
All other EVP_CIPHER_meth_get_*() functions return pointers to their
|
|
respective \fBmd\fR function.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIEVP_DigestInit\fR\|(3), \fIEVP_SignInit\fR\|(3), \fIEVP_VerifyInit\fR\|(3)
|
|
.SH "HISTORY"
|
|
.IX Header "HISTORY"
|
|
The \fB\s-1EVP_MD\s0\fR structure was openly available in OpenSSL before version
|
|
1.1. The functions described here were added in OpenSSL 1.1.
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2015\-2017 The OpenSSL Project Authors. All Rights Reserved.
|
|
.PP
|
|
Licensed under the OpenSSL license (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>.
|