X509_NAME_ENTRY_get_object.3ssl - Man Page

X509_NAME_ENTRY utility functions

Synopsis

 #include <openssl/x509.h>

 ASN1_OBJECT *X509_NAME_ENTRY_get_object(const X509_NAME_ENTRY *ne);
 ASN1_STRING *X509_NAME_ENTRY_get_data(const X509_NAME_ENTRY *ne);

 int X509_NAME_ENTRY_set_object(X509_NAME_ENTRY *ne, const ASN1_OBJECT *obj);
 int X509_NAME_ENTRY_set_data(X509_NAME_ENTRY *ne, int type,
                              const unsigned char *bytes, int len);

 X509_NAME_ENTRY *X509_NAME_ENTRY_create_by_txt(X509_NAME_ENTRY **ne, const char *field,
                                                int type, const unsigned char *bytes,
                                                int len);
 X509_NAME_ENTRY *X509_NAME_ENTRY_create_by_NID(X509_NAME_ENTRY **ne, int nid,
                                                int type, const unsigned char *bytes,
                                                int len);
 X509_NAME_ENTRY *X509_NAME_ENTRY_create_by_OBJ(X509_NAME_ENTRY **ne,
                                                const ASN1_OBJECT *obj, int type,
                                                const unsigned char *bytes, int len);

Description

X509_NAME_ENTRY_get_object() retrieves the field name of ne in and ASN1_OBJECT structure.

X509_NAME_ENTRY_get_data() retrieves the field value of ne in and ASN1_STRING structure.

X509_NAME_ENTRY_set_object() sets the field name of ne to obj.

X509_NAME_ENTRY_set_data() sets the field value of ne to string type type and value determined by bytes and len.

X509_NAME_ENTRY_create_by_txt(), X509_NAME_ENTRY_create_by_NID() and X509_NAME_ENTRY_create_by_OBJ() create and return an X509_NAME_ENTRY structure.

Notes

X509_NAME_ENTRY_get_object() and X509_NAME_ENTRY_get_data() can be used to examine an X509_NAME_ENTRY function as returned by X509_NAME_get_entry() for example.

X509_NAME_ENTRY_create_by_txt(), X509_NAME_ENTRY_create_by_OBJ(), X509_NAME_ENTRY_create_by_NID() and X509_NAME_ENTRY_set_data() are seldom used in practice because X509_NAME_ENTRY structures are almost always part of X509_NAME structures and the corresponding X509_NAME functions are typically used to create and add new entries in a single operation.

The arguments of these functions support similar options to the similarly named ones of the corresponding X509_NAME functions such as X509_NAME_add_entry_by_txt(). So for example type can be set to MBSTRING_ASC but in the case of X509_set_data() the field name must be set first so the relevant field information can be looked up internally.

Return Values

X509_NAME_ENTRY_get_object() returns a valid ASN1_OBJECT structure if it is set or NULL if an error occurred.

X509_NAME_ENTRY_get_data() returns a valid ASN1_STRING structure if it is set or NULL if an error occurred.

X509_NAME_ENTRY_set_object() and X509_NAME_ENTRY_set_data() return 1 on success or 0 on error.

X509_NAME_ENTRY_create_by_txt(), X509_NAME_ENTRY_create_by_NID() and X509_NAME_ENTRY_create_by_OBJ() return a valid X509_NAME_ENTRY on success or NULL if an error occurred.

See Also

ERR_get_error(3), d2i_X509_NAME(3), OBJ_nid2obj(3)

Referenced By

i2d_re_X509_tbs.3ssl(3), x509.7ssl(7), X509_CRL_get0_by_serial.3ssl(3), X509_get0_notBefore.3ssl(3), X509_get0_signature.3ssl(3), X509_get0_uids.3ssl(3), X509_get_pubkey.3ssl(3), X509_get_serialNumber.3ssl(3), X509_get_subject_name.3ssl(3), X509_get_version.3ssl(3), X509_new.3ssl(3), X509_sign.3ssl(3), X509V3_get_d2i.3ssl(3).

The man pages X509_NAME_ENTRY_create_by_NID.3ssl(3), X509_NAME_ENTRY_create_by_OBJ.3ssl(3), X509_NAME_ENTRY_create_by_txt.3ssl(3), X509_NAME_ENTRY_get_data.3ssl(3), X509_NAME_ENTRY_set_data.3ssl(3) and X509_NAME_ENTRY_set_object.3ssl(3) are aliases of X509_NAME_ENTRY_get_object.3ssl(3).

2021-03-26 1.1.1k OpenSSL