mirror of https://github.com/openssl/openssl.git
134 lines
5.1 KiB
Plaintext
134 lines
5.1 KiB
Plaintext
=pod
|
|
|
|
=head1 NAME
|
|
|
|
OCSP_response_status, OCSP_response_get1_basic, OCSP_response_create,
|
|
OCSP_RESPONSE_free, OCSP_RESPID_set_by_name,
|
|
OCSP_RESPID_set_by_key_ex, OCSP_RESPID_set_by_key, OCSP_RESPID_match_ex,
|
|
OCSP_RESPID_match, OCSP_basic_sign, OCSP_basic_sign_ctx
|
|
- OCSP response functions
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
#include <openssl/ocsp.h>
|
|
|
|
int OCSP_response_status(OCSP_RESPONSE *resp);
|
|
OCSP_BASICRESP *OCSP_response_get1_basic(OCSP_RESPONSE *resp);
|
|
OCSP_RESPONSE *OCSP_response_create(int status, OCSP_BASICRESP *bs);
|
|
void OCSP_RESPONSE_free(OCSP_RESPONSE *resp);
|
|
|
|
int OCSP_RESPID_set_by_name(OCSP_RESPID *respid, X509 *cert);
|
|
int OCSP_RESPID_set_by_key_ex(OCSP_RESPID *respid, X509 *cert,
|
|
OSSL_LIB_CTX *libctx, const char *propq);
|
|
int OCSP_RESPID_set_by_key(OCSP_RESPID *respid, X509 *cert);
|
|
int OCSP_RESPID_match_ex(OCSP_RESPID *respid, X509 *cert, OSSL_LIB_CTX *libctx,
|
|
const char *propq);
|
|
int OCSP_RESPID_match(OCSP_RESPID *respid, X509 *cert);
|
|
|
|
int OCSP_basic_sign(OCSP_BASICRESP *brsp, X509 *signer, EVP_PKEY *key,
|
|
const EVP_MD *dgst, STACK_OF(X509) *certs,
|
|
unsigned long flags);
|
|
int OCSP_basic_sign_ctx(OCSP_BASICRESP *brsp, X509 *signer, EVP_MD_CTX *ctx,
|
|
STACK_OF(X509) *certs, unsigned long flags);
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
OCSP_response_status() returns the OCSP response status of I<resp>. It returns
|
|
one of the values: I<OCSP_RESPONSE_STATUS_SUCCESSFUL>,
|
|
I<OCSP_RESPONSE_STATUS_MALFORMEDREQUEST>,
|
|
I<OCSP_RESPONSE_STATUS_INTERNALERROR>, I<OCSP_RESPONSE_STATUS_TRYLATER>
|
|
I<OCSP_RESPONSE_STATUS_SIGREQUIRED>, or I<OCSP_RESPONSE_STATUS_UNAUTHORIZED>.
|
|
|
|
OCSP_response_get1_basic() decodes and returns the I<OCSP_BASICRESP> structure
|
|
contained in I<resp>.
|
|
|
|
OCSP_response_create() creates and returns an I<OCSP_RESPONSE> structure for
|
|
I<status> and optionally including basic response I<bs>.
|
|
|
|
OCSP_RESPONSE_free() frees up OCSP response I<resp>.
|
|
|
|
OCSP_RESPID_set_by_name() sets the name of the OCSP_RESPID to be the same as the
|
|
subject name in the supplied X509 certificate I<cert> for the OCSP responder.
|
|
|
|
OCSP_RESPID_set_by_key_ex() sets the key of the OCSP_RESPID to be the same as the
|
|
key in the supplied X509 certificate I<cert> for the OCSP responder. The key is
|
|
stored as a SHA1 hash. To calculate the hash the SHA1 algorithm is fetched using
|
|
the library ctx I<libctx> and the property query string I<propq> (see
|
|
L<crypto(7)/ALGORITHM FETCHING> for further information).
|
|
|
|
OCSP_RESPID_set_by_key() does the same as OCSP_RESPID_set_by_key_ex() except
|
|
that the default library context is used with an empty property query string.
|
|
|
|
Note that an OCSP_RESPID can only have one of the name, or the key set. Calling
|
|
OCSP_RESPID_set_by_name() or OCSP_RESPID_set_by_key() will clear any existing
|
|
setting.
|
|
|
|
OCSP_RESPID_match_ex() tests whether the OCSP_RESPID given in I<respid> matches
|
|
with the X509 certificate I<cert> based on the SHA1 hash. To calculate the hash
|
|
the SHA1 algorithm is fetched using the library ctx I<libctx> and the property
|
|
query string I<propq> (see L<crypto(7)/ALGORITHM FETCHING> for further
|
|
information).
|
|
|
|
OCSP_RESPID_match() does the same as OCSP_RESPID_match_ex() except that the
|
|
default library context is used with an empty property query string.
|
|
|
|
OCSP_basic_sign() signs OCSP response I<brsp> using certificate I<signer>, private key
|
|
I<key>, digest I<dgst> and additional certificates I<certs>. If the I<flags> option
|
|
I<OCSP_NOCERTS> is set then no certificates will be included in the response. If the
|
|
I<flags> option I<OCSP_RESPID_KEY> is set then the responder is identified by key ID
|
|
rather than by name. OCSP_basic_sign_ctx() also signs OCSP response I<brsp> but
|
|
uses the parameters contained in digest context I<ctx>.
|
|
|
|
=head1 RETURN VALUES
|
|
|
|
OCSP_RESPONSE_status() returns a status value.
|
|
|
|
OCSP_response_get1_basic() returns an I<OCSP_BASICRESP> structure pointer or
|
|
I<NULL> if an error occurred.
|
|
|
|
OCSP_response_create() returns an I<OCSP_RESPONSE> structure pointer or I<NULL>
|
|
if an error occurred.
|
|
|
|
OCSP_RESPONSE_free() does not return a value.
|
|
|
|
OCSP_RESPID_set_by_name(), OCSP_RESPID_set_by_key(), OCSP_basic_sign(), and
|
|
OCSP_basic_sign_ctx() return 1 on success or 0
|
|
on failure.
|
|
|
|
OCSP_RESPID_match() returns 1 if the OCSP_RESPID and the X509 certificate match
|
|
or 0 otherwise.
|
|
|
|
=head1 NOTES
|
|
|
|
OCSP_response_get1_basic() is only called if the status of a response is
|
|
I<OCSP_RESPONSE_STATUS_SUCCESSFUL>.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<crypto(7)>
|
|
L<OCSP_cert_to_id(3)>
|
|
L<OCSP_request_add1_nonce(3)>
|
|
L<OCSP_REQUEST_new(3)>
|
|
L<OCSP_resp_find_status(3)>
|
|
L<OCSP_sendreq_new(3)>
|
|
L<OCSP_RESPID_new(3)>
|
|
L<OCSP_RESPID_free(3)>
|
|
|
|
=head1 HISTORY
|
|
|
|
The OCSP_RESPID_set_by_name(), OCSP_RESPID_set_by_key() and OCSP_RESPID_match()
|
|
functions were added in OpenSSL 1.1.0a.
|
|
|
|
The OCSP_basic_sign_ctx() function was added in OpenSSL 1.1.1.
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2015-2021 The OpenSSL Project Authors. All Rights Reserved.
|
|
|
|
Licensed under the Apache License 2.0 (the "License"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file LICENSE in the source distribution or at
|
|
L<https://www.openssl.org/source/license.html>.
|
|
|
|
=cut
|