crypto/external/bsd/openssl/lib/libcrypto/man/EVP_PKEY_derive.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 "EVP_PKEY_derive 3"
 137 .TH EVP_PKEY_derive 3 "2006-07-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 EVP_PKEY_derive_init, EVP_PKEY_derive_set_peer, EVP_PKEY_derive \- derive public key algorithm shared secret.
 144 .SH "LIBRARY"
 145 libcrypto, -lcrypto
 146 .SH "SYNOPSIS"
 147 .IX Header "SYNOPSIS"
 148 .Vb 1
 149 \& #include <openssl/evp.h>
 150 \&
 151 \& int EVP_PKEY_derive_init(EVP_PKEY_CTX *ctx);
 152 \& int EVP_PKEY_derive_set_peer(EVP_PKEY_CTX *ctx, EVP_PKEY *peer);
 153 \& int EVP_PKEY_derive(EVP_PKEY_CTX *ctx, unsigned char *key, size_t *keylen);
 154 .Ve
 155 .SH "DESCRIPTION"
 156 .IX Header "DESCRIPTION"
 157 The \fIEVP_PKEY_derive_init()\fR function initializes a public key algorithm
 158 context using key \fBpkey\fR for shared secret derivation.
 159 .PP
 160 The \fIEVP_PKEY_derive_set_peer()\fR function sets the peer key: this will normally
 161 be a public key.
 162 .PP
 163 The \fIEVP_PKEY_derive()\fR derives a shared secret using \fBctx\fR.
 164 If \fBkey\fR is \fB\s-1NULL\s0\fR then the maximum size of the output buffer is written to
 165 the \fBkeylen\fR parameter. If \fBkey\fR is not \fB\s-1NULL\s0\fR then before the call the
 166 \&\fBkeylen\fR parameter should contain the length of the \fBkey\fR buffer, if the call
 167 is successful the shared secret is written to \fBkey\fR and the amount of data
 168 written to \fBkeylen\fR.
 169 .SH "NOTES"
 170 .IX Header "NOTES"
 171 After the call to \fIEVP_PKEY_derive_init()\fR algorithm specific control
 172 operations can be performed to set any appropriate parameters for the
 173 operation.
 174 .PP
 175 The function \fIEVP_PKEY_derive()\fR can be called more than once on the same
 176 context if several operations are performed using the same parameters.
 177 .SH "RETURN VALUES"
 178 .IX Header "RETURN VALUES"
 179 \&\fIEVP_PKEY_derive_init()\fR and \fIEVP_PKEY_derive()\fR return 1 for success and 0
 180 or a negative value for failure. In particular a return value of \-2
 181 indicates the operation is not supported by the public key algorithm.
 182 .SH "EXAMPLE"
 183 .IX Header "EXAMPLE"
 184 Derive shared secret (for example \s-1DH\s0 or \s-1EC\s0 keys):
 185 .PP
 186 .Vb 2
 187 \& #include <openssl/evp.h>
 188 \& #include <openssl/rsa.h>
 189 \&
 190 \& EVP_PKEY_CTX *ctx;
 191 \& unsigned char *skey;
 192 \& size_t skeylen;
 193 \& EVP_PKEY *pkey, *peerkey;
 194 \& /* NB: assumes pkey, peerkey have been already set up */
 195 \&
 196 \& ctx = EVP_PKEY_CTX_new(pkey);
 197 \& if (!ctx)
 198 \&        /* Error occurred */
 199 \& if (EVP_PKEY_derive_init(ctx) <= 0)
 200 \&        /* Error */
 201 \& if (EVP_PKEY_derive_set_peer(ctx, peerkey) <= 0)
 202 \&        /* Error */
 203 \&
 204 \& /* Determine buffer length */
 205 \& if (EVP_PKEY_derive(ctx, NULL, &skeylen) <= 0)
 206 \&        /* Error */
 207 \&
 208 \& skey = OPENSSL_malloc(skeylen);
 209 \&
 210 \& if (!skey)
 211 \&        /* malloc failure */
 212 \&
 213 \& if (EVP_PKEY_derive(ctx, skey, &skeylen) <= 0)
 214 \&        /* Error */
 215 \&
 216 \& /* Shared secret is skey bytes written to buffer skey */
 217 .Ve
 218 .SH "SEE ALSO"
 219 .IX Header "SEE ALSO"
 220 \&\fIEVP_PKEY_CTX_new\fR\|(3),
 221 \&\fIEVP_PKEY_encrypt\fR\|(3),
 222 \&\fIEVP_PKEY_decrypt\fR\|(3),
 223 \&\fIEVP_PKEY_sign\fR\|(3),
 224 \&\fIEVP_PKEY_verify\fR\|(3),
 225 \&\fIEVP_PKEY_verifyrecover\fR\|(3),
 226 .SH "HISTORY"
 227 .IX Header "HISTORY"
 228 These functions were first added to OpenSSL 0.9.9.