summaryrefslogtreecommitdiff
path: root/doc/libtasn1.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/libtasn1.html')
-rw-r--r--doc/libtasn1.html49
1 files changed, 26 insertions, 23 deletions
diff --git a/doc/libtasn1.html b/doc/libtasn1.html
index 88b01e1..47e7509 100644
--- a/doc/libtasn1.html
+++ b/doc/libtasn1.html
@@ -1,11 +1,11 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is for GNU Libtasn1
-(version 4.13, 4 April 2016),
+(version 4.14, 29 March 2019),
which is a library for Abstract Syntax Notation One (ASN.1) and
Distinguished Encoding Rules (DER) manipulation.
-Copyright (C) 2001-2015 Free Software Foundation, Inc.
+Copyright (C) 2001-2019 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
@@ -13,16 +13,16 @@ any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
copy of the license is included in the section entitled "GNU Free
Documentation License". -->
-<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
+<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
<head>
-<title>GNU Libtasn1 4.13</title>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>GNU Libtasn1 4.14</title>
-<meta name="description" content="GNU Libtasn1 4.13">
-<meta name="keywords" content="GNU Libtasn1 4.13">
+<meta name="description" content="GNU Libtasn1 4.14">
+<meta name="keywords" content="GNU Libtasn1 4.14">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="#Top" rel="start" title="Top">
<link href="#Concept-Index" rel="index" title="Concept Index">
<link href="#SEC_Contents" rel="contents" title="Table of Contents">
@@ -104,7 +104,7 @@ dd, li {
</head>
<body lang="en">
-<h1 class="settitle" align="center">GNU Libtasn1 4.13</h1>
+<h1 class="settitle" align="center">GNU Libtasn1 4.14</h1>
@@ -158,11 +158,11 @@ Next: <a href="#Introduction" accesskey="n" rel="next">Introduction</a>, Up: <a
<h1 class="top">Libtasn1</h1>
<p>This manual is for GNU Libtasn1
-(version 4.13, 4 April 2016),
+(version 4.14, 29 March 2019),
which is a library for Abstract Syntax Notation One (ASN.1) and
Distinguished Encoding Rules (DER) manipulation.
</p>
-<p>Copyright &copy; 2001-2015 Free Software Foundation, Inc.
+<p>Copyright &copy; 2001-2019 Free Software Foundation, Inc.
</p>
<blockquote>
<p>Permission is granted to copy, distribute and/or modify this document
@@ -669,7 +669,7 @@ needed to manage the definitions included in <code>file</code> file.
</p>
<p><strong>Returns:</strong> <code>ASN1_SUCCESS</code> if the file has a correct syntax and every
identifier is known, <code>ASN1_ELEMENT_NOT_EMPTY</code> if <code>definitions</code> not
-<code>NULL</code> , <code>ASN1_FILE_NOT_FOUND</code> if an error occured while
+<code>NULL</code> , <code>ASN1_FILE_NOT_FOUND</code> if an error occurred while
opening <code>file</code> , <code>ASN1_SYNTAX_ERROR</code> if the syntax is not
correct, <code>ASN1_IDENTIFIER_NOT_FOUND</code> if in the file there is an
identifier that is not defined, <code>ASN1_NAME_TOO_LONG</code> if in the
@@ -700,7 +700,7 @@ included in <code>inputFileName</code> file. If <code>inputFileName</code> is
will be &quot;xx_asn1_tab&quot;.
</p>
<p><strong>Returns:</strong> <code>ASN1_SUCCESS</code> if the file has a correct syntax and every
-identifier is known, <code>ASN1_FILE_NOT_FOUND</code> if an error occured
+identifier is known, <code>ASN1_FILE_NOT_FOUND</code> if an error occurred
while opening <code>inputFileName</code> , <code>ASN1_SYNTAX_ERROR</code> if the syntax is
not correct, <code>ASN1_IDENTIFIER_NOT_FOUND</code> if in the file there is
an identifier that is not defined, <code>ASN1_NAME_TOO_LONG</code> if in the
@@ -1010,7 +1010,7 @@ pointer to memory cells already allocated (may be <code>NULL</code> ).
<p><var>len</var>: number of bytes of *value: value[0]..value[len-1]. Initialy
holds the sizeof value.
</p>
-<p>Returns the value of one element inside a structure.
+<p>Returns the value of one element inside a structure.
If an element is OPTIONAL and this returns
<code>ASN1_ELEMENT_NOT_FOUND</code> , it means that this element wasn&rsquo;t present
in the der encoding that created the structure. The first element
@@ -1064,7 +1064,8 @@ encoding of the structure actually used.
<code>ASN1_VALUE_NOT_FOUND</code> if there isn&rsquo;t any value for the element
selected, and <code>ASN1_MEM_ERROR</code> if The value vector isn&rsquo;t big enough
to store the result, and in this case <code>len</code> will contain the number of
-bytes needed.
+bytes needed. On the occasion that the stored data are of zero-length
+this function may return <code>ASN1_SUCCESS</code> even if the provided <code>len</code> is zero.
</p></dd></dl>
<a name="asn1_005fread_005fvalue_005ftype-1"></a>
@@ -1083,7 +1084,7 @@ holds the sizeof value.
</p>
<p><var>etype</var>: The type of the value read (ASN1_ETYPE)
</p>
-<p>Returns the type and value of one element inside a structure.
+<p>Returns the type and value of one element inside a structure.
If an element is OPTIONAL and this returns
<code>ASN1_ELEMENT_NOT_FOUND</code> , it means that this element wasn&rsquo;t present
in the der encoding that created the structure. The first element
@@ -1137,7 +1138,8 @@ encoding of the structure actually used.
<code>ASN1_VALUE_NOT_FOUND</code> if there isn&rsquo;t any value for the element
selected, and <code>ASN1_MEM_ERROR</code> if The value vector isn&rsquo;t big enough
to store the result, and in this case <code>len</code> will contain the number of
-bytes needed.
+bytes needed. On the occasion that the stored data are of zero-length
+this function may return <code>ASN1_SUCCESS</code> even if the provided <code>len</code> is zero.
</p></dd></dl>
<a name="asn1_005fread_005ftag-1"></a>
@@ -1330,7 +1332,7 @@ when the decoded length value plus <code>len</code> would exceed <code>der_len
</p>
<p><var>len</var>: Output variable containing the length of the DER TAG data.
</p>
-<p><var>tag</var>: Output variable containing the decoded tag.
+<p><var>tag</var>: Output variable containing the decoded tag (may be <code>NULL</code> ).
</p>
<p>Decode the class and TAG from DER code.
</p>
@@ -1394,7 +1396,8 @@ content octets.
</p>
<p><var>str_size</var>: Length of pre-allocated output buffer.
</p>
-<p>Converts a DER encoded object identifier to its textual form.
+<p>Converts a DER encoded object identifier to its textual form. This
+function expects the DER object identifier without the tag.
</p>
<p><strong>Returns:</strong> <code>ASN1_SUCCESS</code> on success, or an error.
</p></dd></dl>
@@ -1468,7 +1471,7 @@ error occurred.
</p>
<p>Fill the structure * <code>element</code> with values of a DER encoding
string. The structure must just be created with function
-<code>asn1_create_element()</code> .
+<code>asn1_create_element()</code> .
</p>
<p>Note that the * <code>element</code> variable is provided as a pointer for
historical reasons.
@@ -1626,7 +1629,7 @@ The output is a pointer inside the <code>der</code> .
</p>
<p><var>ber_len</var>: the total length occupied by BER (may be <code>NULL</code> )
</p>
-<p>Decodes a BER encoded type. The output is an allocated value
+<p>Decodes a BER encoded type. The output is an allocated value
of the data. This decodes BER STRINGS only. Other types are
decoded as DER.
</p>
@@ -1691,7 +1694,7 @@ Previous: <a href="#Error-handling-functions" accesskey="p" rel="prev">Error han
<p><var>name</var>: null terminated string with the element&rsquo;s name to find.
</p>
<p>Searches for an element called <code>name</code> starting from <code>pointer</code> . The
-name is composed by differents identifiers separated by dots. When
+name is composed by different identifiers separated by dots. When
* <code>pointer</code> has a name, the first identifier must be the name of
* <code>pointer</code> , otherwise it must be the name of one child of * <code>pointer</code> .
</p>
@@ -1752,7 +1755,7 @@ Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
</pre></div>
-<ol>
+<ol start="0">
<li> PREAMBLE
<p>The purpose of this License is to make a manual, textbook, or other
@@ -1928,7 +1931,7 @@ Version filling the role of the Document, thus licensing distribution
and modification of the Modified Version to whoever possesses a copy
of it. In addition, you must do these things in the Modified Version:
</p>
-<ol>
+<ol type="A" start="1">
<li> Use in the Title Page (and on the covers, if any) a title distinct
from that of the Document, and from those of previous versions
(which should, if there were any, be listed in the History section