| 1 | =pod
|
|---|
| 2 |
|
|---|
| 3 | =head1 NAME
|
|---|
| 4 |
|
|---|
| 5 | X509_sign, X509_sign_ctx,
|
|---|
| 6 | X509_REQ_sign, X509_REQ_sign_ctx,
|
|---|
| 7 | X509_CRL_sign, X509_CRL_sign_ctx -
|
|---|
| 8 | sign certificate, certificate request, or CRL signature
|
|---|
| 9 |
|
|---|
| 10 | =head1 SYNOPSIS
|
|---|
| 11 |
|
|---|
| 12 | #include <openssl/x509.h>
|
|---|
| 13 |
|
|---|
| 14 | int X509_sign(X509 *x, EVP_PKEY *pkey, const EVP_MD *md);
|
|---|
| 15 | int X509_sign_ctx(X509 *x, EVP_MD_CTX *ctx);
|
|---|
| 16 |
|
|---|
| 17 | int X509_REQ_sign(X509_REQ *x, EVP_PKEY *pkey, const EVP_MD *md);
|
|---|
| 18 | int X509_REQ_sign_ctx(X509_REQ *x, EVP_MD_CTX *ctx);
|
|---|
| 19 |
|
|---|
| 20 | int X509_CRL_sign(X509_CRL *x, EVP_PKEY *pkey, const EVP_MD *md);
|
|---|
| 21 | int X509_CRL_sign_ctx(X509_CRL *x, EVP_MD_CTX *ctx);
|
|---|
| 22 |
|
|---|
| 23 | =head1 DESCRIPTION
|
|---|
| 24 |
|
|---|
| 25 | X509_sign() signs certificate I<x> using private key I<pkey> and message
|
|---|
| 26 | digest I<md> and sets the signature in I<x>. X509_sign_ctx() also signs
|
|---|
| 27 | certificate I<x> but uses the parameters contained in digest context I<ctx>.
|
|---|
| 28 | If the certificate information includes X.509 extensions,
|
|---|
| 29 | these two functions make sure that the certificate bears X.509 version 3.
|
|---|
| 30 |
|
|---|
| 31 | X509_REQ_sign(), X509_REQ_sign_ctx(),
|
|---|
| 32 | X509_CRL_sign(), and X509_CRL_sign_ctx()
|
|---|
| 33 | sign certificate requests and CRLs, respectively.
|
|---|
| 34 |
|
|---|
| 35 | =head1 NOTES
|
|---|
| 36 |
|
|---|
| 37 | X509_sign_ctx() is used where the default parameters for the corresponding
|
|---|
| 38 | public key and digest are not suitable. It can be used to sign keys using
|
|---|
| 39 | RSA-PSS for example.
|
|---|
| 40 |
|
|---|
| 41 | For efficiency reasons and to work around ASN.1 encoding issues the encoding
|
|---|
| 42 | of the signed portion of a certificate, certificate request and CRL is cached
|
|---|
| 43 | internally. If the signed portion of the structure is modified the encoding
|
|---|
| 44 | is not always updated meaning a stale version is sometimes used. This is not
|
|---|
| 45 | normally a problem because modifying the signed portion will invalidate the
|
|---|
| 46 | signature and signing will always update the encoding.
|
|---|
| 47 |
|
|---|
| 48 | =head1 RETURN VALUES
|
|---|
| 49 |
|
|---|
| 50 | All functions return the size of the signature
|
|---|
| 51 | in bytes for success and zero for failure.
|
|---|
| 52 |
|
|---|
| 53 | =head1 SEE ALSO
|
|---|
| 54 |
|
|---|
| 55 | L<ERR_get_error(3)>,
|
|---|
| 56 | L<X509_NAME_add_entry_by_txt(3)>,
|
|---|
| 57 | L<X509_new(3)>,
|
|---|
| 58 | L<X509_verify_cert(3)>,
|
|---|
| 59 | L<X509_verify(3)>,
|
|---|
| 60 | L<X509_REQ_verify_ex(3)>, L<X509_REQ_verify(3)>,
|
|---|
| 61 | L<X509_CRL_verify(3)>
|
|---|
| 62 |
|
|---|
| 63 | =head1 HISTORY
|
|---|
| 64 |
|
|---|
| 65 | The X509_sign(), X509_REQ_sign() and X509_CRL_sign() functions are
|
|---|
| 66 | available in all versions of OpenSSL.
|
|---|
| 67 |
|
|---|
| 68 | The X509_sign_ctx(), X509_REQ_sign_ctx()
|
|---|
| 69 | and X509_CRL_sign_ctx() functions were added in OpenSSL 1.0.1.
|
|---|
| 70 |
|
|---|
| 71 | =head1 COPYRIGHT
|
|---|
| 72 |
|
|---|
| 73 | Copyright 2015-2023 The OpenSSL Project Authors. All Rights Reserved.
|
|---|
| 74 |
|
|---|
| 75 | Licensed under the Apache License 2.0 (the "License"). You may not use
|
|---|
| 76 | this file except in compliance with the License. You can obtain a copy
|
|---|
| 77 | in the file LICENSE in the source distribution or at
|
|---|
| 78 | L<https://www.openssl.org/source/license.html>.
|
|---|
| 79 |
|
|---|
| 80 | =cut
|
|---|
