doc/crypto/OCSP_response_status.pod

   1 =pod
   2
   3 OCSP_response_status, OCSP_response_get1_basic, OCSP_response_create,
   4 OCSP_RESPONSE_free - OCSP response functions.
   5
   6 =head1 SYNOPSIS
   7
   8  #include <openssl/ocsp.h>
   9
  10  int OCSP_response_status(OCSP_RESPONSE *resp);
  11  OCSP_BASICRESP *OCSP_response_get1_basic(OCSP_RESPONSE *resp);
  12  OCSP_RESPONSE *OCSP_response_create(int status, OCSP_BASICRESP *bs);
  13  void OCSP_RESPONSE_free(OCSP_RESPONSE *resp);
  14
  15 =head1 DESCRIPTION
  16
  17 OCSP_response_status() returns the OCSP response status of B<resp>. It returns
  18 one of the values: B<OCSP_RESPONSE_STATUS_SUCCESSFUL>,
  19 B<OCSP_RESPONSE_STATUS_MALFORMEDREQUEST>,
  20 B<OCSP_RESPONSE_STATUS_INTERNALERROR>, B<OCSP_RESPONSE_STATUS_TRYLATER>
  21 B<OCSP_RESPONSE_STATUS_SIGREQUIRED>, or B<OCSP_RESPONSE_STATUS_UNAUTHORIZED>.
  22
  23 OCSP_response_get1_basic() decodes and returns the B<OCSP_BASICRESP> structure
  24 contained in B<resp>.
  25
  26 OCSP_response_create() creates and returns an B<OCSP_RESPONSE> structure for
  27 B<status> and optionally including basic response B<bs>.
  28
  29 OCSP_RESPONSE_free() frees up OCSP response B<resp>.
  30
  31 =head1 RETURN VALUES
  32
  33 OCSP_RESPONSE_status() returns a status value.
  34
  35 OCSP_response_get1_basic() returns an B<OCSP_BASICRESP> structure pointer or
  36 B<NULL> if an error occurred.
  37
  38 OCSP_response_create() returns an B<OCSP_RESPONSE> structure pointer or B<NULL>
  39 if an error occurred.
  40
  41 OCSP_RESPONSE_free() does not return a value.
  42
  43 =head1 NOTES
  44
  45 OCSP_response_get1_basic() is only called if the status of a response is
  46 B<OCSP_RESPONSE_STATUS_SUCCESSFUL>.
  47
  48 =head1 SEE ALSO
  49
  50 L<crypto(3)>
  51 L<OCSP_cert_to_id(3)>
  52 L<OCSP_request_add1_nonce(3)>
  53 L<OCSP_REQUEST_new(3)>
  54 L<OCSP_response_find_status(3)>
  55 L<OCSP_sendreq_new(3)>
  56
  57 =head1 COPYRIGHT
  58
  59 Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
  60
  61 Licensed under the OpenSSL license (the "License").  You may not use
  62 this file except in compliance with the License.  You can obtain a copy
  63 in the file LICENSE in the source distribution or at
  64 L<https://www.openssl.org/source/license.html>.
  65
  66 =cut