X509_get_version.pod 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  1. =pod
  2. =head1 NAME
  3. X509_get_version, X509_set_version, X509_REQ_get_version, X509_REQ_set_version,
  4. X509_CRL_get_version, X509_CRL_set_version - get or set certificate,
  5. certificate request or CRL version
  6. =head1 SYNOPSIS
  7. #include <openssl/x509.h>
  8. long X509_get_version(const X509 *x);
  9. int X509_set_version(X509 *x, long version);
  10. long X509_REQ_get_version(const X509_REQ *req);
  11. int X509_REQ_set_version(X509_REQ *x, long version);
  12. long X509_CRL_get_version(const X509_CRL *crl);
  13. int X509_CRL_set_version(X509_CRL *x, long version);
  14. =head1 DESCRIPTION
  15. X509_get_version() returns the numerical value of the version field of
  16. certificate B<x>. Note: this is defined by standards (X.509 et al) to be one
  17. less than the certificate version. So a version 3 certificate will return 2 and
  18. a version 1 certificate will return 0.
  19. X509_set_version() sets the numerical value of the version field of certificate
  20. B<x> to B<version>.
  21. Similarly X509_REQ_get_version(), X509_REQ_set_version(),
  22. X509_CRL_get_version() and X509_CRL_set_version() get and set the version
  23. number of certificate requests and CRLs.
  24. =head1 NOTES
  25. The version field of certificates, certificate requests and CRLs has a
  26. DEFAULT value of B<v1(0)> meaning the field should be omitted for version
  27. 1. This is handled transparently by these functions.
  28. =head1 RETURN VALUES
  29. X509_get_version(), X509_REQ_get_version() and X509_CRL_get_version()
  30. return the numerical value of the version field.
  31. X509_set_version(), X509_REQ_set_version() and X509_CRL_set_version()
  32. return 1 for success and 0 for failure.
  33. =head1 SEE ALSO
  34. L<d2i_X509(3)>,
  35. L<ERR_get_error(3)>,
  36. L<X509_CRL_get0_by_serial(3)>,
  37. L<X509_get0_signature(3)>,
  38. L<X509_get_ext_d2i(3)>,
  39. L<X509_get_extension_flags(3)>,
  40. L<X509_get_pubkey(3)>,
  41. L<X509_get_subject_name(3)>,
  42. L<X509_NAME_add_entry_by_txt(3)>,
  43. L<X509_NAME_ENTRY_get_object(3)>,
  44. L<X509_NAME_get_index_by_NID(3)>,
  45. L<X509_NAME_print_ex(3)>,
  46. L<X509_new(3)>,
  47. L<X509_sign(3)>,
  48. L<X509V3_get_d2i(3)>,
  49. L<X509_verify_cert(3)>
  50. =head1 HISTORY
  51. X509_get_version(), X509_REQ_get_version() and X509_CRL_get_version() are
  52. functions in OpenSSL 1.1.0, in previous versions they were macros.
  53. =head1 COPYRIGHT
  54. Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
  55. Licensed under the Apache License 2.0 (the "License"). You may not use
  56. this file except in compliance with the License. You can obtain a copy
  57. in the file LICENSE in the source distribution or at
  58. L<https://www.openssl.org/source/license.html>.
  59. =cut