secure/lib/libcrypto/man/X509_sign.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 "X509_SIGN 3"
 132 .TH X509_SIGN 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 X509_sign, X509_sign_ctx, X509_verify, X509_REQ_sign, X509_REQ_sign_ctx, X509_REQ_verify, X509_CRL_sign, X509_CRL_sign_ctx, X509_CRL_verify \- sign or verify certificate, certificate request or CRL signature
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/x509.h>
 143 \&
 144 \& int X509_sign(X509 *x, EVP_PKEY *pkey, const EVP_MD *md);
 145 \& int X509_sign_ctx(X509 *x, EVP_MD_CTX *ctx);
 146 \& int X509_verify(X509 *a, EVP_PKEY *r);
 147 \&
 148 \& int X509_REQ_sign(X509_REQ *x, EVP_PKEY *pkey, const EVP_MD *md);
 149 \& int X509_REQ_sign_ctx(X509_REQ *x, EVP_MD_CTX *ctx);
 150 \& int X509_REQ_verify(X509_REQ *a, EVP_PKEY *r);
 151 \&
 152 \& int X509_CRL_sign(X509_CRL *x, EVP_PKEY *pkey, const EVP_MD *md);
 153 \& int X509_CRL_sign_ctx(X509_CRL *x, EVP_MD_CTX *ctx);
 154 \& int X509_CRL_verify(X509_CRL *a, EVP_PKEY *r);
 155 .Ve
 156 .SH "DESCRIPTION"
 157 .IX Header "DESCRIPTION"
 158 \&\fIX509_sign()\fR signs certificate \fBx\fR using private key \fBpkey\fR and message
 159 digest \fBmd\fR and sets the signature in \fBx\fR. \fIX509_sign_ctx()\fR also signs
 160 certificate \fBx\fR but uses the parameters contained in digest context \fBctx\fR.
 161 .PP
 162 \&\fIX509_verify()\fR verifies the signature of certificate \fBx\fR using public key
 163 \&\fBpkey\fR. Only the signature is checked: no other checks (such as certificate
 164 chain validity) are performed.
 165 .PP
 166 \&\fIX509_REQ_sign()\fR, \fIX509_REQ_sign_ctx()\fR, \fIX509_REQ_verify()\fR,
 167 \&\fIX509_CRL_sign()\fR, \fIX509_CRL_sign_ctx()\fR and \fIX509_CRL_verify()\fR sign and verify
 168 certificate requests and CRLs respectively.
 169 .SH "NOTES"
 170 .IX Header "NOTES"
 171 \&\fIX509_sign_ctx()\fR is used where the default parameters for the corresponding
 172 public key and digest are not suitable. It can be used to sign keys using
 173 RSA-PSS for example.
 174 .PP
 175 For efficiency reasons and to work around \s-1ASN.1\s0 encoding issues the encoding
 176 of the signed portion of a certificate, certificate request and \s-1CRL\s0 is cached
 177 internally. If the signed portion of the structure is modified the encoding
 178 is not always updated meaning a stale version is sometimes used. This is not
 179 normally a problem because modifying the signed portion will invalidate the
 180 signature and signing will always update the encoding.
 181 .SH "RETURN VALUES"
 182 .IX Header "RETURN VALUES"
 183 \&\fIX509_sign()\fR, \fIX509_sign_ctx()\fR, \fIX509_REQ_sign()\fR, \fIX509_REQ_sign_ctx()\fR,
 184 \&\fIX509_CRL_sign()\fR and \fIX509_CRL_sign_ctx()\fR return the size of the signature
 185 in bytes for success and zero for failure.
 186 .PP
 187 \&\fIX509_verify()\fR, \fIX509_REQ_verify()\fR and \fIX509_CRL_verify()\fR return 1 if the
 188 signature is valid and 0 if the signature check fails. If the signature
 189 could not be checked at all because it was invalid or some other error
 190 occurred then \-1 is returned.
 191 .SH "SEE ALSO"
 192 .IX Header "SEE ALSO"
 193 \&\fId2i_X509\fR\|(3),
 194 \&\fIERR_get_error\fR\|(3),
 195 \&\fIX509_CRL_get0_by_serial\fR\|(3),
 196 \&\fIX509_get0_signature\fR\|(3),
 197 \&\fIX509_get_ext_d2i\fR\|(3),
 198 \&\fIX509_get_extension_flags\fR\|(3),
 199 \&\fIX509_get_pubkey\fR\|(3),
 200 \&\fIX509_get_subject_name\fR\|(3),
 201 \&\fIX509_get_version\fR\|(3),
 202 \&\fIX509_NAME_add_entry_by_txt\fR\|(3),
 203 \&\fIX509_NAME_ENTRY_get_object\fR\|(3),
 204 \&\fIX509_NAME_get_index_by_NID\fR\|(3),
 205 \&\fIX509_NAME_print_ex\fR\|(3),
 206 \&\fIX509_new\fR\|(3),
 207 \&\fIX509V3_get_d2i\fR\|(3),
 208 \&\fIX509_verify_cert\fR\|(3)
 209 .SH "HISTORY"
 210 .IX Header "HISTORY"
 211 \&\fIX509_sign()\fR, \fIX509_REQ_sign()\fR and \fIX509_CRL_sign()\fR are available in all
 212 versions of OpenSSL.
 213 .PP
 214 \&\fIX509_sign_ctx()\fR, \fIX509_REQ_sign_ctx()\fR and \fIX509_CRL_sign_ctx()\fR were first added
 215 to OpenSSL 1.0.1.
 216 .SH "COPYRIGHT"
 217 .IX Header "COPYRIGHT"
 218 Copyright 2015\-2016 The OpenSSL Project Authors. All Rights Reserved.
 219 .PP
 220 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 221 this file except in compliance with the License.  You can obtain a copy
 222 in the file \s-1LICENSE\s0 in the source distribution or at
 223 <https://www.openssl.org/source/license.html>.