secure/lib/libcrypto/man/EVP_MD_meth_new.3

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.39)
   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 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "EVP_MD_METH_NEW 3"
 136 .TH EVP_MD_METH_NEW 3 "2019-09-10" "1.1.1d" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 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
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/evp.h>
 147 \&
 148 \& EVP_MD *EVP_MD_meth_new(int md_type, int pkey_type);
 149 \& void EVP_MD_meth_free(EVP_MD *md);
 150 \& EVP_MD *EVP_MD_meth_dup(const EVP_MD *md);
 151 \&
 152 \& int EVP_MD_meth_set_input_blocksize(EVP_MD *md, int blocksize);
 153 \& int EVP_MD_meth_set_result_size(EVP_MD *md, int resultsize);
 154 \& int EVP_MD_meth_set_app_datasize(EVP_MD *md, int datasize);
 155 \& int EVP_MD_meth_set_flags(EVP_MD *md, unsigned long flags);
 156 \& int EVP_MD_meth_set_init(EVP_MD *md, int (*init)(EVP_MD_CTX *ctx));
 157 \& int EVP_MD_meth_set_update(EVP_MD *md, int (*update)(EVP_MD_CTX *ctx,
 158 \&                                                      const void *data,
 159 \&                                                      size_t count));
 160 \& int EVP_MD_meth_set_final(EVP_MD *md, int (*final)(EVP_MD_CTX *ctx,
 161 \&                                                    unsigned char *md));
 162 \& int EVP_MD_meth_set_copy(EVP_MD *md, int (*copy)(EVP_MD_CTX *to,
 163 \&                                                  const EVP_MD_CTX *from));
 164 \& int EVP_MD_meth_set_cleanup(EVP_MD *md, int (*cleanup)(EVP_MD_CTX *ctx));
 165 \& int EVP_MD_meth_set_ctrl(EVP_MD *md, int (*ctrl)(EVP_MD_CTX *ctx, int cmd,
 166 \&                                                  int p1, void *p2));
 167 \&
 168 \& int EVP_MD_meth_get_input_blocksize(const EVP_MD *md);
 169 \& int EVP_MD_meth_get_result_size(const EVP_MD *md);
 170 \& int EVP_MD_meth_get_app_datasize(const EVP_MD *md);
 171 \& unsigned long EVP_MD_meth_get_flags(const EVP_MD *md);
 172 \& int (*EVP_MD_meth_get_init(const EVP_MD *md))(EVP_MD_CTX *ctx);
 173 \& int (*EVP_MD_meth_get_update(const EVP_MD *md))(EVP_MD_CTX *ctx,
 174 \&                                                 const void *data,
 175 \&                                                 size_t count);
 176 \& int (*EVP_MD_meth_get_final(const EVP_MD *md))(EVP_MD_CTX *ctx,
 177 \&                                                unsigned char *md);
 178 \& int (*EVP_MD_meth_get_copy(const EVP_MD *md))(EVP_MD_CTX *to,
 179 \&                                               const EVP_MD_CTX *from);
 180 \& int (*EVP_MD_meth_get_cleanup(const EVP_MD *md))(EVP_MD_CTX *ctx);
 181 \& int (*EVP_MD_meth_get_ctrl(const EVP_MD *md))(EVP_MD_CTX *ctx, int cmd,
 182 \&                                               int p1, void *p2);
 183 .Ve
 184 .SH "DESCRIPTION"
 185 .IX Header "DESCRIPTION"
 186 The \fB\s-1EVP_MD\s0\fR type is a structure for digest method implementation.
 187 It can also have associated public/private key signing and verifying
 188 routines.
 189 .PP
 190 \&\fBEVP_MD_meth_new()\fR creates a new \fB\s-1EVP_MD\s0\fR structure.
 191 .PP
 192 \&\fBEVP_MD_meth_dup()\fR creates a copy of \fBmd\fR.
 193 .PP
 194 \&\fBEVP_MD_meth_free()\fR destroys a \fB\s-1EVP_MD\s0\fR structure.
 195 .PP
 196 \&\fBEVP_MD_meth_set_input_blocksize()\fR sets the internal input block size
 197 for the method \fBmd\fR to \fBblocksize\fR bytes.
 198 .PP
 199 \&\fBEVP_MD_meth_set_result_size()\fR sets the size of the result that the
 200 digest method in \fBmd\fR is expected to produce to \fBresultsize\fR bytes.
 201 .PP
 202 The digest method may have its own private data, which OpenSSL will
 203 allocate for it.  \fBEVP_MD_meth_set_app_datasize()\fR should be used to
 204 set the size for it to \fBdatasize\fR.
 205 .PP
 206 \&\fBEVP_MD_meth_set_flags()\fR sets the flags to describe optional
 207 behaviours in the particular \fBmd\fR.  Several flags can be or'd
 208 together.  The available flags are:
 209 .IP "\s-1EVP_MD_FLAG_ONESHOT\s0" 4
 210 .IX Item "EVP_MD_FLAG_ONESHOT"
 211 This digest method can only handles one block of input.
 212 .IP "\s-1EVP_MD_FLAG_DIGALGID_NULL\s0" 4
 213 .IX Item "EVP_MD_FLAG_DIGALGID_NULL"
 214 When setting up a DigestAlgorithmIdentifier, this flag will have the
 215 parameter set to \s-1NULL\s0 by default.  Use this for PKCS#1.  \fINote: if
 216 combined with \s-1EVP_MD_FLAG_DIGALGID_ABSENT,\s0 the latter will override.\fR
 217 .IP "\s-1EVP_MD_FLAG_DIGALGID_ABSENT\s0" 4
 218 .IX Item "EVP_MD_FLAG_DIGALGID_ABSENT"
 219 When setting up a DigestAlgorithmIdentifier, this flag will have the
 220 parameter be left absent by default.  \fINote: if combined with
 221 \&\s-1EVP_MD_FLAG_DIGALGID_NULL,\s0 the latter will be overridden.\fR
 222 .IP "\s-1EVP_MD_FLAG_DIGALGID_CUSTOM\s0" 4
 223 .IX Item "EVP_MD_FLAG_DIGALGID_CUSTOM"
 224 Custom DigestAlgorithmIdentifier handling via ctrl, with
 225 \&\fB\s-1EVP_MD_FLAG_DIGALGID_ABSENT\s0\fR as default.  \fINote: if combined with
 226 \&\s-1EVP_MD_FLAG_DIGALGID_NULL,\s0 the latter will be overridden.\fR
 227 Currently unused.
 228 .PP
 229 \&\fBEVP_MD_meth_set_init()\fR sets the digest init function for \fBmd\fR.
 230 The digest init function is called by \fBEVP_DigestInit()\fR,
 231 \&\fBEVP_DigestInit_ex()\fR, EVP_SignInit, \fBEVP_SignInit_ex()\fR, \fBEVP_VerifyInit()\fR
 232 and \fBEVP_VerifyInit_ex()\fR.
 233 .PP
 234 \&\fBEVP_MD_meth_set_update()\fR sets the digest update function for \fBmd\fR.
 235 The digest update function is called by \fBEVP_DigestUpdate()\fR,
 236 \&\fBEVP_SignUpdate()\fR.
 237 .PP
 238 \&\fBEVP_MD_meth_set_final()\fR sets the digest final function for \fBmd\fR.
 239 The digest final function is called by \fBEVP_DigestFinal()\fR,
 240 \&\fBEVP_DigestFinal_ex()\fR, \fBEVP_SignFinal()\fR and \fBEVP_VerifyFinal()\fR.
 241 .PP
 242 \&\fBEVP_MD_meth_set_copy()\fR sets the function for \fBmd\fR to do extra
 243 computations after the method's private data structure has been copied
 244 from one \fB\s-1EVP_MD_CTX\s0\fR to another.  If all that's needed is to copy
 245 the data, there is no need for this copy function.
 246 Note that the copy function is passed two \fB\s-1EVP_MD_CTX\s0 *\fR, the private
 247 data structure is then available with \fBEVP_MD_CTX_md_data()\fR.
 248 This copy function is called by \fBEVP_MD_CTX_copy()\fR and
 249 \&\fBEVP_MD_CTX_copy_ex()\fR.
 250 .PP
 251 \&\fBEVP_MD_meth_set_cleanup()\fR sets the function for \fBmd\fR to do extra
 252 cleanup before the method's private data structure is cleaned out and
 253 freed.
 254 Note that the cleanup function is passed a \fB\s-1EVP_MD_CTX\s0 *\fR, the
 255 private data structure is then available with \fBEVP_MD_CTX_md_data()\fR.
 256 This cleanup function is called by \fBEVP_MD_CTX_reset()\fR and
 257 \&\fBEVP_MD_CTX_free()\fR.
 258 .PP
 259 \&\fBEVP_MD_meth_set_ctrl()\fR sets the control function for \fBmd\fR.
 260 .PP
 261 \&\fBEVP_MD_meth_get_input_blocksize()\fR, \fBEVP_MD_meth_get_result_size()\fR,
 262 \&\fBEVP_MD_meth_get_app_datasize()\fR, \fBEVP_MD_meth_get_flags()\fR,
 263 \&\fBEVP_MD_meth_get_init()\fR, \fBEVP_MD_meth_get_update()\fR,
 264 \&\fBEVP_MD_meth_get_final()\fR, \fBEVP_MD_meth_get_copy()\fR,
 265 \&\fBEVP_MD_meth_get_cleanup()\fR and \fBEVP_MD_meth_get_ctrl()\fR are all used
 266 to retrieve the method data given with the EVP_MD_meth_set_*()
 267 functions above.
 268 .SH "RETURN VALUES"
 269 .IX Header "RETURN VALUES"
 270 \&\fBEVP_MD_meth_new()\fR and \fBEVP_MD_meth_dup()\fR return a pointer to a newly
 271 created \fB\s-1EVP_MD\s0\fR, or \s-1NULL\s0 on failure.
 272 All EVP_MD_meth_set_*() functions return 1.
 273 \&\fBEVP_MD_get_input_blocksize()\fR, \fBEVP_MD_meth_get_result_size()\fR,
 274 \&\fBEVP_MD_meth_get_app_datasize()\fR and \fBEVP_MD_meth_get_flags()\fR return the
 275 indicated sizes or flags.
 276 All other EVP_CIPHER_meth_get_*() functions return pointers to their
 277 respective \fBmd\fR function.
 278 .SH "SEE ALSO"
 279 .IX Header "SEE ALSO"
 280 \&\fBEVP_DigestInit\fR\|(3), \fBEVP_SignInit\fR\|(3), \fBEVP_VerifyInit\fR\|(3)
 281 .SH "HISTORY"
 282 .IX Header "HISTORY"
 283 The \fB\s-1EVP_MD\s0\fR structure was openly available in OpenSSL before version
 284 1.1.  The functions described here were added in OpenSSL 1.1.
 285 .SH "COPYRIGHT"
 286 .IX Header "COPYRIGHT"
 287 Copyright 2015\-2017 The OpenSSL Project Authors. All Rights Reserved.
 288 .PP
 289 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 290 this file except in compliance with the License.  You can obtain a copy
 291 in the file \s-1LICENSE\s0 in the source distribution or at
 292 <https://www.openssl.org/source/license.html>.