aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDr. Stephen Henson <steve@openssl.org>2015-03-15 16:26:04 +0000
committerDr. Stephen Henson <steve@openssl.org>2015-03-24 17:35:58 +0000
commit2e430277578d3dd586cd005682a54a59d6158146 (patch)
tree4fa3771298d408499873043a3f37f61b2c7746d0 /doc
parent7b68c30da01b4eedcd546f81844156646387cacb (diff)
downloadopenssl-2e430277578d3dd586cd005682a54a59d6158146.zip
openssl-2e430277578d3dd586cd005682a54a59d6158146.tar.gz
openssl-2e430277578d3dd586cd005682a54a59d6158146.tar.bz2
make ASN1_OBJECT opaque
Reviewed-by: Matt Caswell <matt@openssl.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/crypto/OBJ_nid2obj.pod14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/crypto/OBJ_nid2obj.pod b/doc/crypto/OBJ_nid2obj.pod
index 1e45dd4..648204e 100644
--- a/doc/crypto/OBJ_nid2obj.pod
+++ b/doc/crypto/OBJ_nid2obj.pod
@@ -29,6 +29,9 @@ functions
int OBJ_create(const char *oid,const char *sn,const char *ln);
void OBJ_cleanup(void);
+ size_t OBJ_length(const ASN1_OBJECT *obj);
+ const unsigned char *OBJ_get0_data(const ASN1_OBJECT *obj);
+
=head1 DESCRIPTION
The ASN1 object utility functions process ASN1_OBJECT structures which are
@@ -70,6 +73,11 @@ OBJ_cleanup() cleans up OpenSSLs internal object table: this should
be called before an application exits if any new objects were added
using OBJ_create().
+OBJ_length() returns the size of the content octets of B<obj>.
+
+OBJ_get0_data() returns a pointer to the content octets of B<obj>.
+The returned pointer is an internal pointer which B<must not> be freed.
+
=head1 NOTES
Objects in OpenSSL can have a short name, a long name and a numerical
@@ -96,6 +104,12 @@ Objects do not need to be in the internal tables to be processed,
the functions OBJ_txt2obj() and OBJ_obj2txt() can process the numerical
form of an OID.
+Some objects are used to reprsent algorithms which do not have a
+corresponding ASN.1 OBJECT IDENTIFIER encoding (for example no OID currently
+exists for a particular algorithm). As a result they B<cannot> be encoded or
+decoded as part of ASN.1 structures. Applications can determine if there
+is a corresponding OBJECT IDENTIFIER by checking OBJ_length() is not zero.
+
=head1 EXAMPLES
Create an object for B<commonName>: