.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "EVP_PKEY_SET1_ENCODED_PUBLIC_KEY 3ossl" .TH EVP_PKEY_SET1_ENCODED_PUBLIC_KEY 3ossl "2023-09-19" "3.0.11" "OpenSSL" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" EVP_PKEY_set1_encoded_public_key, EVP_PKEY_get1_encoded_public_key, EVP_PKEY_set1_tls_encodedpoint, EVP_PKEY_get1_tls_encodedpoint \&\- functions to set and get public key data within an EVP_PKEY .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& #include \& \& int EVP_PKEY_set1_encoded_public_key(EVP_PKEY *pkey, \& const unsigned char *pub, size_t publen); \& \& size_t EVP_PKEY_get1_encoded_public_key(EVP_PKEY *pkey, unsigned char **ppub); .Ve .PP The following functions have been deprecated since OpenSSL 3.0, and can be hidden entirely by defining \fB\s-1OPENSSL_API_COMPAT\s0\fR with a suitable version value, see \fBopenssl_user_macros\fR\|(7): .PP .Vb 2 \& int EVP_PKEY_set1_tls_encodedpoint(EVP_PKEY *pkey, \& const unsigned char *pt, size_t ptlen); \& \& size_t EVP_PKEY_get1_tls_encodedpoint(EVP_PKEY *pkey, unsigned char **ppt); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBEVP_PKEY_set1_encoded_public_key()\fR can be used to set the public key value within an existing \s-1EVP_PKEY\s0 object. For the built-in OpenSSL algorithms this currently only works for those that support key exchange. Parameters are not set as part of this operation, so typically an application will create an \&\s-1EVP_PKEY\s0 first, set the parameters on it, and then call this function. For example setting the parameters might be done using \&\fBEVP_PKEY_copy_parameters\fR\|(3). .PP The format for the encoded public key will depend on the algorithm in use. For \&\s-1DH\s0 it should be encoded as a positive integer in big-endian form. For \s-1EC\s0 is should be a point conforming to Sec. 2.3.4 of the \s-1SECG SEC 1\s0 (\*(L"Elliptic Curve Cryptography\*(R") standard. For X25519 and X448 it should be encoded in a format as defined by \s-1RFC7748.\s0 .PP The key to be updated is supplied in \fBpkey\fR. The buffer containing the encoded key is pointed to be \fBpub\fR. The length of the buffer is supplied in \fBpublen\fR. .PP \&\fBEVP_PKEY_get1_encoded_public_key()\fR does the equivalent operation except that the encoded public key is returned to the application. The key containing the public key data is supplied in \fBpkey\fR. A buffer containing the encoded key will be allocated and stored in \fB*ppub\fR. The length of the encoded public key is returned by the function. The application is responsible for freeing the allocated buffer. .PP The macro \fBEVP_PKEY_set1_tls_encodedpoint()\fR is deprecated and simply calls \&\fBEVP_PKEY_set1_encoded_public_key()\fR with all the same arguments. New applications should use \fBEVP_PKEY_set1_encoded_public_key()\fR instead. .PP The macro \fBEVP_PKEY_get1_tls_encodedpoint()\fR is deprecated and simply calls \&\fBEVP_PKEY_get1_encoded_public_key()\fR with all the same arguments. New applications should use \fBEVP_PKEY_get1_encoded_public_key()\fR instead. .SH "RETURN VALUES" .IX Header "RETURN VALUES" \&\fBEVP_PKEY_set1_encoded_public_key()\fR returns 1 for success and 0 or a negative value for failure. .PP \&\fBEVP_PKEY_get1_encoded_public_key()\fR returns the length of the encoded key or 0 for failure. .SH "EXAMPLES" .IX Header "EXAMPLES" See \fBEVP_PKEY_derive_init\fR\|(3) and \fBEVP_PKEY_derive\fR\|(3) for information about performing a key exchange operation. .SS "Set up a peer's \s-1EVP_PKEY\s0 ready for a key exchange operation" .IX Subsection "Set up a peer's EVP_PKEY ready for a key exchange operation" .Vb 1 \& #include \& \& int exchange(EVP_PKEY *ourkey, unsigned char *peer_pub, size_t peer_pub_len) \& { \& EVP_PKEY *peerkey = EVP_PKEY_new(); \& \& if (peerkey == NULL || EVP_PKEY_copy_parameters(peerkey, ourkey) <= 0) \& return 0; \& \& if (EVP_PKEY_set1_encoded_public_key(peerkey, peer_pub, \& peer_pub_len) <= 0) \& return 0; \& \& /* Do the key exchange here */ \& \& EVP_PKEY_free(peerkey); \& \& return 1; \& } .Ve .SS "Get an encoded public key to send to a peer" .IX Subsection "Get an encoded public key to send to a peer" .Vb 1 \& #include \& \& int get_encoded_pub_key(EVP_PKEY *ourkey) \& { \& unsigned char *pubkey; \& size_t pubkey_len; \& \& pubkey_len = EVP_PKEY_get1_encoded_public_key(ourkey, &pubkey); \& if (pubkey_len == 0) \& return 0; \& \& /* \& * Send the encoded public key stored in the buffer at "pubkey" and of \& * length pubkey_len, to the peer. \& */ \& \& OPENSSL_free(pubkey); \& return 1; \& } .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBEVP_PKEY_new\fR\|(3), \fBEVP_PKEY_copy_parameters\fR\|(3), \&\fBEVP_PKEY_derive_init\fR\|(3), \fBEVP_PKEY_derive\fR\|(3), \&\s-1\fBEVP_PKEY\-DH\s0\fR\|(7), \s-1\fBEVP_PKEY\-EC\s0\fR\|(7), \s-1\fBEVP_PKEY\-X25519\s0\fR\|(7), \s-1\fBEVP_PKEY\-X448\s0\fR\|(7) .SH "HISTORY" .IX Header "HISTORY" \&\fBEVP_PKEY_set1_encoded_public_key()\fR and \fBEVP_PKEY_get1_encoded_public_key()\fR were added in OpenSSL 3.0. .PP \&\fBEVP_PKEY_set1_tls_encodedpoint()\fR and \fBEVP_PKEY_get1_tls_encodedpoint()\fR were deprecated in OpenSSL 3.0. .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2020\-2021 The OpenSSL Project Authors. All Rights Reserved. .PP Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at .