ossl_cmp_ctx_set1_caPubs.pod 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. =pod
  2. =head1 NAME
  3. ossl_cmp_ctx_set1_caPubs,
  4. ossl_cmp_ctx_set0_validatedSrvCert,
  5. ossl_cmp_ctx_set_status,
  6. ossl_cmp_ctx_set0_statusString,
  7. ossl_cmp_ctx_set_failInfoCode,
  8. ossl_cmp_ctx_set0_newCert,
  9. ossl_cmp_ctx_set1_extraCertsIn,
  10. ossl_cmp_ctx_set1_recipNonce
  11. - internal functions for managing the CMP client context datastructure
  12. =head1 SYNOPSIS
  13. #include <openssl/cmp.h>
  14. int ossl_cmp_ctx_set1_caPubs(OSSL_CMP_CTX *ctx, STACK_OF(X509) *caPubs);
  15. int ossl_cmp_ctx_set0_validatedSrvCert(OSSL_CMP_CTX *ctx, X509 *cert);
  16. int ossl_cmp_ctx_set_status(OSSL_CMP_CTX *ctx, int status);
  17. int ossl_cmp_ctx_set0_statusString(OSSL_CMP_CTX *ctx,
  18. OSSL_CMP_PKIFREETEXT *text);
  19. int ossl_cmp_ctx_set_failInfoCode(OSSL_CMP_CTX *ctx, int fail_info);
  20. int ossl_cmp_ctx_set0_newCert(OSSL_CMP_CTX *ctx, X509 *cert);
  21. int ossl_cmp_ctx_set1_extraCertsIn(OSSL_CMP_CTX *ctx,
  22. STACK_OF(X509) *extraCertsIn);
  23. int ossl_cmp_ctx_set1_recipNonce(OSSL_CMP_CTX *ctx,
  24. const ASN1_OCTET_STRING *nonce);
  25. =head1 DESCRIPTION
  26. ossl_cmp_ctx_set1_caPubs() copies the given stack of CA certificates
  27. to the caPubs field of the context.
  28. The reference counts of those certificates handled successfully are increased.
  29. ossl_cmp_ctx_set0_validatedSrvCert() sets the validatedSrvCert of the context,
  30. which caches any already validated server cert, or NULL if not available.
  31. ossl_cmp_ctx_set_status() sets the status field of the context.
  32. ossl_cmp_ctx_set0_statusString() sets the statusString field of the context.
  33. ossl_cmp_ctx_set_failInfoCode() sets the error code bits in the failInfoCode
  34. field of the context based on the given OSSL_CMP_PKIFAILUREINFO structure.
  35. ossl_cmp_ctx_set0_newCert() sets the given (newly enrolled) certificate
  36. in the context.
  37. ossl_cmp_ctx_set1_extraCertsIn() sets the extraCertsIn field of the context.
  38. The reference counts of those certificates handled successfully are increased.
  39. ossl_cmp_ctx_set1_recipNonce() sets the given recipient nonce in the context.
  40. =head1 NOTES
  41. CMP is defined in RFC 4210 (and CRMF in RFC 4211).
  42. =head1 RETURN VALUES
  43. All functions return 1 on success, 0 on error.
  44. =head1 HISTORY
  45. The OpenSSL CMP support was added in OpenSSL 3.0.
  46. =head1 COPYRIGHT
  47. Copyright 2007-2018 The OpenSSL Project Authors. All Rights Reserved.
  48. Licensed under the Apache License 2.0 (the "License"). You may not use
  49. this file except in compliance with the License. You can obtain a copy
  50. in the file LICENSE in the source distribution or at
  51. L<https://www.openssl.org/source/license.html>.
  52. =cut