X509_get_subject_name.pod 2.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. =pod
  2. =head1 NAME
  3. X509_get_subject_name, X509_set_subject_name, X509_get_issuer_name,
  4. X509_set_issuer_name, X509_REQ_get_subject_name, X509_REQ_set_subject_name,
  5. X509_CRL_get_issuer, X509_CRL_set_issuer_name - get and set issuer or
  6. subject names
  7. =head1 SYNOPSIS
  8. #include <openssl/x509.h>
  9. X509_NAME *X509_get_subject_name(const X509 *x);
  10. int X509_set_subject_name(X509 *x, const X509_NAME *name);
  11. X509_NAME *X509_get_issuer_name(const X509 *x);
  12. int X509_set_issuer_name(X509 *x, const X509_NAME *name);
  13. X509_NAME *X509_REQ_get_subject_name(const X509_REQ *req);
  14. int X509_REQ_set_subject_name(X509_REQ *req, const X509_NAME *name);
  15. X509_NAME *X509_CRL_get_issuer(const X509_CRL *crl);
  16. int X509_CRL_set_issuer_name(X509_CRL *x, const X509_NAME *name);
  17. =head1 DESCRIPTION
  18. X509_get_subject_name() returns the subject name of certificate B<x>. The
  19. returned value is an internal pointer which B<MUST NOT> be freed.
  20. X509_set_subject_name() sets the issuer name of certificate B<x> to
  21. B<name>. The B<name> parameter is copied internally and should be freed
  22. up when it is no longer needed.
  23. X509_get_issuer_name() and X509_set_issuer_name() are identical to
  24. X509_get_subject_name() and X509_set_subject_name() except the get and
  25. set the issuer name of B<x>.
  26. Similarly X509_REQ_get_subject_name(), X509_REQ_set_subject_name(),
  27. X509_CRL_get_issuer() and X509_CRL_set_issuer_name() get or set the subject
  28. or issuer names of certificate requests of CRLs respectively.
  29. =head1 RETURN VALUES
  30. X509_get_subject_name(), X509_get_issuer_name(), X509_REQ_get_subject_name()
  31. and X509_CRL_get_issuer() return an B<X509_NAME> pointer.
  32. X509_set_subject_name(), X509_set_issuer_name(), X509_REQ_set_subject_name()
  33. and X509_CRL_set_issuer_name() return 1 for success and 0 for failure.
  34. =head1 SEE ALSO
  35. L<d2i_X509(3)>,
  36. L<ERR_get_error(3)>, L<d2i_X509(3)>
  37. L<X509_CRL_get0_by_serial(3)>,
  38. L<X509_get0_signature(3)>,
  39. L<X509_get_ext_d2i(3)>,
  40. L<X509_get_extension_flags(3)>,
  41. L<X509_get_pubkey(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_REQ_get_subject_name() is a function in OpenSSL 1.1.0 and a macro in
  52. earlier versions.
  53. X509_CRL_get_issuer() is a function in OpenSSL 1.1.0. It was previously
  54. added in OpenSSL 1.0.0 as a macro.
  55. =head1 COPYRIGHT
  56. Copyright 2015-2020 The OpenSSL Project Authors. All Rights Reserved.
  57. Licensed under the Apache License 2.0 (the "License"). You may not use
  58. this file except in compliance with the License. You can obtain a copy
  59. in the file LICENSE in the source distribution or at
  60. L<https://www.openssl.org/source/license.html>.
  61. =cut