crypto/external/bsd/openssl/lib/libcrypto/man/CMS_sign_add1_signer.3

   1 .\"     $NetBSD: libcrypto.pl,v 1.3 2007/11/27 22:16:03 christos Exp $
   2 .\"
   3 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
   4 .\"
   5 .\" Standard preamble:
   6 .\" ========================================================================
   7 .de Sh \" Subsection heading
   8 .br
   9 .if t .Sp
  10 .ne 5
  11 .PP
  12 \fB\\$1\fR
  13 .PP
  14 ..
  15 .de Sp \" Vertical space (when we can't use .PP)
  16 .if t .sp .5v
  17 .if n .sp
  18 ..
  19 .de Vb \" Begin verbatim text
  20 .ft CW
  21 .nf
  22 .ne \\$1
  23 ..
  24 .de Ve \" End verbatim text
  25 .ft R
  26 .fi
  27 ..
  28 .\" Set up some character translations and predefined strings.  \*(-- will
  29 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  30 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  31 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  32 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  33 .\" nothing in troff, for use with C<>.
  34 .tr \(*W-
  35 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  36 .ie n \{\
  37 .    ds -- \(*W-
  38 .    ds PI pi
  39 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  40 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  41 .    ds L" ""
  42 .    ds R" ""
  43 .    ds C` ""
  44 .    ds C' ""
  45 'br\}
  46 .el\{\
  47 .    ds -- \|\(em\|
  48 .    ds PI \(*p
  49 .    ds L" ``
  50 .    ds R" ''
  51 'br\}
  52 .\"
  53 .\" Escape single quotes in literal strings from groff's Unicode transform.
  54 .ie \n(.g .ds Aq \(aq
  55 .el       .ds Aq '
  56 .\"
  57 .\" If the F register is turned on, we'll generate index entries on stderr for
  58 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  59 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  60 .\" output yourself in some meaningful fashion.
  61 .ie \nF \{\
  62 .    de IX
  63 .    tm Index:\\$1\t\\n%\t"\\$2"
  64 ..
  65 .    nr % 0
  66 .    rr F
  67 .\}
  68 .el \{\
  69 .    de IX
  70 ..
  71 .\}
  72 .\"
  73 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  74 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  75 .    \" fudge factors for nroff and troff
  76 .if n \{\
  77 .    ds #H 0
  78 .    ds #V .8m
  79 .    ds #F .3m
  80 .    ds #[ \f1
  81 .    ds #] \fP
  82 .\}
  83 .if t \{\
  84 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  85 .    ds #V .6m
  86 .    ds #F 0
  87 .    ds #[ \&
  88 .    ds #] \&
  89 .\}
  90 .    \" simple accents for nroff and troff
  91 .if n \{\
  92 .    ds ' \&
  93 .    ds ` \&
  94 .    ds ^ \&
  95 .    ds , \&
  96 .    ds ~ ~
  97 .    ds /
  98 .\}
  99 .if t \{\
 100 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 101 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 102 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 103 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 104 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 105 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 106 .\}
 107 .    \" troff and (daisy-wheel) nroff accents
 108 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 109 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 110 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 111 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 112 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 113 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 114 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 115 .ds ae a\h'-(\w'a'u*4/10)'e
 116 .ds Ae A\h'-(\w'A'u*4/10)'E
 117 .    \" corrections for vroff
 118 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 119 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 120 .    \" for low resolution devices (crt and lpr)
 121 .if \n(.H>23 .if \n(.V>19 \
 122 \{\
 123 .    ds : e
 124 .    ds 8 ss
 125 .    ds o a
 126 .    ds d- d\h'-1'\(ga
 127 .    ds D- D\h'-1'\(hy
 128 .    ds th \o'bp'
 129 .    ds Th \o'LP'
 130 .    ds ae ae
 131 .    ds Ae AE
 132 .\}
 133 .rm #[ #] #H #V #F C
 134 .\" ========================================================================
 135 .\"
 136 .IX Title "CMS_sign_add1_signer 3"
 137 .TH CMS_sign_add1_signer 3 "2009-03-08" "1.1.0-dev" "OpenSSL"
 138 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 139 .\" way too many mistakes in technical documents.
 140 .if n .ad l
 141 .nh
 142 .SH "NAME"
 143 .Vb 1
 144 \& CMS_sign_add1_signer, CMS_SignerInfo_sign \- add a signer to a CMS_ContentInfo signed data structure.
 145 .Ve
 146 .SH "LIBRARY"
 147 libcrypto, -lcrypto
 148 .SH "SYNOPSIS"
 149 .IX Header "SYNOPSIS"
 150 .Vb 1
 151 \& #include <openssl/cms.h>
 152 \&
 153 \& CMS_SignerInfo *CMS_sign_add1_signer(CMS_ContentInfo *cms, X509 *signcert, EVP_PKEY *pkey, const EVP_MD *md, unsigned int flags);
 154 \&
 155 \& int CMS_SignerInfo_sign(CMS_SignerInfo *si);
 156 .Ve
 157 .SH "DESCRIPTION"
 158 .IX Header "DESCRIPTION"
 159 \&\fICMS_sign_add1_signer()\fR adds a signer with certificate \fBsigncert\fR and private
 160 key \fBpkey\fR using message digest \fBmd\fR to CMS_ContentInfo SignedData
 161 structure \fBcms\fR.
 162 .PP
 163 The CMS_ContentInfo structure should be obtained from an initial call to
 164 \&\fICMS_sign()\fR with the flag \fB\s-1CMS_PARTIAL\s0\fR set or in the case or re-signing a
 165 valid CMS_ContentInfo SignedData structure.
 166 .PP
 167 If the \fBmd\fR parameter is \fB\s-1NULL\s0\fR then the default digest for the public
 168 key algorithm will be used.
 169 .PP
 170 Unless the \fB\s-1CMS_REUSE_DIGEST\s0\fR flag is set the returned CMS_ContentInfo
 171 structure is not complete and must be finalized either by streaming (if
 172 applicable) or a call to \fICMS_final()\fR.
 173 .PP
 174 The \fICMS_SignerInfo_sign()\fR function will explicitly sign a CMS_SignerInfo
 175 structure, its main use is when \fB\s-1CMS_REUSE_DIGEST\s0\fR and \fB\s-1CMS_PARTIAL\s0\fR flags
 176 are both set.
 177 .SH "NOTES"
 178 .IX Header "NOTES"
 179 The main purpose of \fICMS_sign_add1_signer()\fR is to provide finer control
 180 over a \s-1CMS\s0 signed data structure where the simpler \fICMS_sign()\fR function defaults
 181 are not appropriate. For example if multiple signers or non default digest
 182 algorithms are needed. New attributes can also be added using the returned
 183 CMS_SignerInfo structure and the \s-1CMS\s0 attribute utility functions or the
 184 \&\s-1CMS\s0 signed receipt request functions.
 185 .PP
 186 Any of the following flags (ored together) can be passed in the \fBflags\fR
 187 parameter.
 188 .PP
 189 If \fB\s-1CMS_REUSE_DIGEST\s0\fR is set then an attempt is made to copy the content
 190 digest value from the CMS_ContentInfo structure: to add a signer to an existing
 191 structure.  An error occurs if a matching digest value cannot be found to copy.
 192 The returned CMS_ContentInfo structure will be valid and finalized when this
 193 flag is set.
 194 .PP
 195 If \fB\s-1CMS_PARTIAL\s0\fR is set in addition to \fB\s-1CMS_REUSE_DIGEST\s0\fR then the
 196 CMS_SignerInfo structure will not be finalized so additional attributes
 197 can be added. In this case an explicit call to \fICMS_SignerInfo_sign()\fR is
 198 needed to finalize it.
 199 .PP
 200 If \fB\s-1CMS_NOCERTS\s0\fR is set the signer's certificate will not be included in the
 201 CMS_ContentInfo structure, the signer's certificate must still be supplied in
 202 the \fBsigncert\fR parameter though. This can reduce the size of the signature if
 203 the signers certificate can be obtained by other means: for example a
 204 previously signed message.
 205 .PP
 206 The SignedData structure includes several \s-1CMS\s0 signedAttributes including the
 207 signing time, the \s-1CMS\s0 content type and the supported list of ciphers in an
 208 SMIMECapabilities attribute. If \fB\s-1CMS_NOATTR\s0\fR is set then no signedAttributes
 209 will be used. If \fB\s-1CMS_NOSMIMECAP\s0\fR is set then just the SMIMECapabilities are
 210 omitted.
 211 .PP
 212 OpenSSL will by default identify signing certificates using issuer name
 213 and serial number. If \fB\s-1CMS_USE_KEYID\s0\fR is set it will use the subject key
 214 identifier value instead. An error occurs if the signing certificate does not
 215 have a subject key identifier extension.
 216 .PP
 217 If present the SMIMECapabilities attribute indicates support for the following
 218 algorithms in preference order: 256 bit \s-1AES\s0, Gost R3411\-94, Gost 28147\-89, 192
 219 bit \s-1AES\s0, 128 bit \s-1AES\s0, triple \s-1DES\s0, 128 bit \s-1RC2\s0, 64 bit \s-1RC2\s0, \s-1DES\s0 and 40 bit \s-1RC2\s0.
 220 If any of these algorithms is not available then it will not be included: for example the \s-1GOST\s0 algorithms will not be included if the \s-1GOST\s0 \s-1ENGINE\s0 is
 221 not loaded.
 222 .PP
 223 \&\fICMS_sign_add1_signer()\fR returns an internal pointer to the CMS_SignerInfo
 224 structure just added, this can be used to set additional attributes
 225 before it is finalized.
 226 .SH "RETURN VALUES"
 227 .IX Header "RETURN VALUES"
 228 \&\fICMS_sign1_add_signers()\fR returns an internal pointer to the CMS_SignerInfo
 229 structure just added or \s-1NULL\s0 if an error occurs.
 230 .SH "SEE ALSO"
 231 .IX Header "SEE ALSO"
 232 \&\fIERR_get_error\fR\|(3), \fICMS_sign\fR\|(3),
 233 \&\fICMS_final\fR\|(3),
 234 .SH "HISTORY"
 235 .IX Header "HISTORY"
 236 \&\fICMS_sign_add1_signer()\fR was added to OpenSSL 0.9.8