secure/lib/libcrypto/man/EVP_MD_meth_new.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  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(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/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(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/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'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/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(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/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 "EVP_MD_METH_NEW 3"
 132 .TH EVP_MD_METH_NEW 3 "2018-11-20" "1.1.1a" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 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
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/evp.h>
 143 \&
 144 \& EVP_MD *EVP_MD_meth_new(int md_type, int pkey_type);
 145 \& void EVP_MD_meth_free(EVP_MD *md);
 146 \& EVP_MD *EVP_MD_meth_dup(const EVP_MD *md);
 147 \&
 148 \& int EVP_MD_meth_set_input_blocksize(EVP_MD *md, int blocksize);
 149 \& int EVP_MD_meth_set_result_size(EVP_MD *md, int resultsize);
 150 \& int EVP_MD_meth_set_app_datasize(EVP_MD *md, int datasize);
 151 \& int EVP_MD_meth_set_flags(EVP_MD *md, unsigned long flags);
 152 \& int EVP_MD_meth_set_init(EVP_MD *md, int (*init)(EVP_MD_CTX *ctx));
 153 \& int EVP_MD_meth_set_update(EVP_MD *md, int (*update)(EVP_MD_CTX *ctx,
 154 \&                                                      const void *data,
 155 \&                                                      size_t count));
 156 \& int EVP_MD_meth_set_final(EVP_MD *md, int (*final)(EVP_MD_CTX *ctx,
 157 \&                                                    unsigned char *md));
 158 \& int EVP_MD_meth_set_copy(EVP_MD *md, int (*copy)(EVP_MD_CTX *to,
 159 \&                                                  const EVP_MD_CTX *from));
 160 \& int EVP_MD_meth_set_cleanup(EVP_MD *md, int (*cleanup)(EVP_MD_CTX *ctx));
 161 \& int EVP_MD_meth_set_ctrl(EVP_MD *md, int (*ctrl)(EVP_MD_CTX *ctx, int cmd,
 162 \&                                                  int p1, void *p2));
 163 \&
 164 \& int EVP_MD_meth_get_input_blocksize(const EVP_MD *md);
 165 \& int EVP_MD_meth_get_result_size(const EVP_MD *md);
 166 \& int EVP_MD_meth_get_app_datasize(const EVP_MD *md);
 167 \& unsigned long EVP_MD_meth_get_flags(const EVP_MD *md);
 168 \& int (*EVP_MD_meth_get_init(const EVP_MD *md))(EVP_MD_CTX *ctx);
 169 \& int (*EVP_MD_meth_get_update(const EVP_MD *md))(EVP_MD_CTX *ctx,
 170 \&                                                 const void *data,
 171 \&                                                 size_t count);
 172 \& int (*EVP_MD_meth_get_final(const EVP_MD *md))(EVP_MD_CTX *ctx,
 173 \&                                                unsigned char *md);
 174 \& int (*EVP_MD_meth_get_copy(const EVP_MD *md))(EVP_MD_CTX *to,
 175 \&                                               const EVP_MD_CTX *from);
 176 \& int (*EVP_MD_meth_get_cleanup(const EVP_MD *md))(EVP_MD_CTX *ctx);
 177 \& int (*EVP_MD_meth_get_ctrl(const EVP_MD *md))(EVP_MD_CTX *ctx, int cmd,
 178 \&                                               int p1, void *p2);
 179 .Ve
 180 .SH "DESCRIPTION"
 181 .IX Header "DESCRIPTION"
 182 The \fB\s-1EVP_MD\s0\fR type is a structure for digest method implementation.
 183 It can also have associated public/private key signing and verifying
 184 routines.
 185 .PP
 186 \&\fIEVP_MD_meth_new()\fR creates a new \fB\s-1EVP_MD\s0\fR structure.
 187 .PP
 188 \&\fIEVP_MD_meth_dup()\fR creates a copy of \fBmd\fR.
 189 .PP
 190 \&\fIEVP_MD_meth_free()\fR destroys a \fB\s-1EVP_MD\s0\fR structure.
 191 .PP
 192 \&\fIEVP_MD_meth_set_input_blocksize()\fR sets the internal input block size
 193 for the method \fBmd\fR to \fBblocksize\fR bytes.
 194 .PP
 195 \&\fIEVP_MD_meth_set_result_size()\fR sets the size of the result that the
 196 digest method in \fBmd\fR is expected to produce to \fBresultsize\fR bytes.
 197 .PP
 198 The digest method may have its own private data, which OpenSSL will
 199 allocate for it.  \fIEVP_MD_meth_set_app_datasize()\fR should be used to
 200 set the size for it to \fBdatasize\fR.
 201 .PP
 202 \&\fIEVP_MD_meth_set_flags()\fR sets the flags to describe optional
 203 behaviours in the particular \fBmd\fR.  Several flags can be or'd
 204 together.  The available flags are:
 205 .IP "\s-1EVP_MD_FLAG_ONESHOT\s0" 4
 206 .IX Item "EVP_MD_FLAG_ONESHOT"
 207 This digest method can only handles one block of input.
 208 .IP "\s-1EVP_MD_FLAG_DIGALGID_NULL\s0" 4
 209 .IX Item "EVP_MD_FLAG_DIGALGID_NULL"
 210 When setting up a DigestAlgorithmIdentifier, this flag will have the
 211 parameter set to \s-1NULL\s0 by default.  Use this for PKCS#1.  \fINote: if
 212 combined with \s-1EVP_MD_FLAG_DIGALGID_ABSENT,\s0 the latter will override.\fR
 213 .IP "\s-1EVP_MD_FLAG_DIGALGID_ABSENT\s0" 4
 214 .IX Item "EVP_MD_FLAG_DIGALGID_ABSENT"
 215 When setting up a DigestAlgorithmIdentifier, this flag will have the
 216 parameter be left absent by default.  \fINote: if combined with
 217 \&\s-1EVP_MD_FLAG_DIGALGID_NULL,\s0 the latter will be overridden.\fR
 218 .IP "\s-1EVP_MD_FLAG_DIGALGID_CUSTOM\s0" 4
 219 .IX Item "EVP_MD_FLAG_DIGALGID_CUSTOM"
 220 Custom DigestAlgorithmIdentifier handling via ctrl, with
 221 \&\fB\s-1EVP_MD_FLAG_DIGALGID_ABSENT\s0\fR as default.  \fINote: if combined with
 222 \&\s-1EVP_MD_FLAG_DIGALGID_NULL,\s0 the latter will be overridden.\fR
 223 Currently unused.
 224 .PP
 225 \&\fIEVP_MD_meth_set_init()\fR sets the digest init function for \fBmd\fR.
 226 The digest init function is called by \fIEVP_DigestInit()\fR,
 227 \&\fIEVP_DigestInit_ex()\fR, EVP_SignInit, \fIEVP_SignInit_ex()\fR, \fIEVP_VerifyInit()\fR
 228 and \fIEVP_VerifyInit_ex()\fR.
 229 .PP
 230 \&\fIEVP_MD_meth_set_update()\fR sets the digest update function for \fBmd\fR.
 231 The digest update function is called by \fIEVP_DigestUpdate()\fR,
 232 \&\fIEVP_SignUpdate()\fR.
 233 .PP
 234 \&\fIEVP_MD_meth_set_final()\fR sets the digest final function for \fBmd\fR.
 235 The digest final function is called by \fIEVP_DigestFinal()\fR,
 236 \&\fIEVP_DigestFinal_ex()\fR, \fIEVP_SignFinal()\fR and \fIEVP_VerifyFinal()\fR.
 237 .PP
 238 \&\fIEVP_MD_meth_set_copy()\fR sets the function for \fBmd\fR to do extra
 239 computations after the method's private data structure has been copied
 240 from one \fB\s-1EVP_MD_CTX\s0\fR to another.  If all that's needed is to copy
 241 the data, there is no need for this copy function.
 242 Note that the copy function is passed two \fB\s-1EVP_MD_CTX\s0 *\fR, the private
 243 data structure is then available with \fIEVP_MD_CTX_md_data()\fR.
 244 This copy function is called by \fIEVP_MD_CTX_copy()\fR and
 245 \&\fIEVP_MD_CTX_copy_ex()\fR.
 246 .PP
 247 \&\fIEVP_MD_meth_set_cleanup()\fR sets the function for \fBmd\fR to do extra
 248 cleanup before the method's private data structure is cleaned out and
 249 freed.
 250 Note that the cleanup function is passed a \fB\s-1EVP_MD_CTX\s0 *\fR, the
 251 private data structure is then available with \fIEVP_MD_CTX_md_data()\fR.
 252 This cleanup function is called by \fIEVP_MD_CTX_reset()\fR and
 253 \&\fIEVP_MD_CTX_free()\fR.
 254 .PP
 255 \&\fIEVP_MD_meth_set_ctrl()\fR sets the control function for \fBmd\fR.
 256 .PP
 257 \&\fIEVP_MD_meth_get_input_blocksize()\fR, \fIEVP_MD_meth_get_result_size()\fR,
 258 \&\fIEVP_MD_meth_get_app_datasize()\fR, \fIEVP_MD_meth_get_flags()\fR,
 259 \&\fIEVP_MD_meth_get_init()\fR, \fIEVP_MD_meth_get_update()\fR,
 260 \&\fIEVP_MD_meth_get_final()\fR, \fIEVP_MD_meth_get_copy()\fR,
 261 \&\fIEVP_MD_meth_get_cleanup()\fR and \fIEVP_MD_meth_get_ctrl()\fR are all used
 262 to retrieve the method data given with the EVP_MD_meth_set_*()
 263 functions above.
 264 .SH "RETURN VALUES"
 265 .IX Header "RETURN VALUES"
 266 \&\fIEVP_MD_meth_new()\fR and \fIEVP_MD_meth_dup()\fR return a pointer to a newly
 267 created \fB\s-1EVP_MD\s0\fR, or \s-1NULL\s0 on failure.
 268 All EVP_MD_meth_set_*() functions return 1.
 269 \&\fIEVP_MD_get_input_blocksize()\fR, \fIEVP_MD_meth_get_result_size()\fR,
 270 \&\fIEVP_MD_meth_get_app_datasize()\fR and \fIEVP_MD_meth_get_flags()\fR return the
 271 indicated sizes or flags.
 272 All other EVP_CIPHER_meth_get_*() functions return pointers to their
 273 respective \fBmd\fR function.
 274 .SH "SEE ALSO"
 275 .IX Header "SEE ALSO"
 276 \&\fIEVP_DigestInit\fR\|(3), \fIEVP_SignInit\fR\|(3), \fIEVP_VerifyInit\fR\|(3)
 277 .SH "HISTORY"
 278 .IX Header "HISTORY"
 279 The \fB\s-1EVP_MD\s0\fR structure was openly available in OpenSSL before version
 280 1.1.  The functions described here were added in OpenSSL 1.1.
 281 .SH "COPYRIGHT"
 282 .IX Header "COPYRIGHT"
 283 Copyright 2015\-2017 The OpenSSL Project Authors. All Rights Reserved.
 284 .PP
 285 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 286 this file except in compliance with the License.  You can obtain a copy
 287 in the file \s-1LICENSE\s0 in the source distribution or at
 288 <https://www.openssl.org/source/license.html>.