Asn PureBasic Reference Documentation

Asn

For creating, loading, parsing, converting, and saving ASN.1

Object Creation

obj.i = CkAsn::ckCreate()

; Make sure to dispose of the object when finished like this:
CkAsn::ckDispose(obj);

Properties

Declare.i ckBoolValue(obj.i)
Declare setCkBoolValue(obj.i, value.i)

Introduced in version 9.5.0.49

The ASN.1 item's boolean value if it is a boolean item.

Declare.i ckConstructed(obj.i) ; (read-only)

Introduced in version 9.5.0.49

1 if this ASN.1 item is a constructed item. Sequence and Set items are constructed and can contain sub-items. All other tags (boolean, integer, octets, utf8String, etc.) are primitive (non-constructed).

Declare.s ckContentStr(obj.i)
Declare setCkContentStr(obj.i, value.s)

Introduced in version 9.5.0.49

The ASN.1 item's content if it is an ASN.1 string type (such as Utf8String, BmpString, PrintableString, VisibleString, T61String, IA5String, NumericString, or UniversalString).

Declare.s ckDebugLogFilePath(obj.i)
Declare setCkDebugLogFilePath(obj.i, value.s)

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

Declare.i ckIntValue(obj.i)
Declare setCkIntValue(obj.i, value.i)

Introduced in version 9.5.0.49

The ASN.1 item's integer value if it is a small integer item.

Declare.s ckLastErrorHtml(obj.i) ; (read-only)

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Declare.s ckLastErrorText(obj.i) ; (read-only)

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Concept of LastErrorText

LastErrorText Standard Information

Declare.s ckLastErrorXml(obj.i) ; (read-only)

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Declare.i ckLastMethodSuccess(obj.i)
Declare setCkLastMethodSuccess(obj.i, value.i)

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = 1 and failure = 0.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

Declare.i ckNumSubItems(obj.i) ; (read-only)

Introduced in version 9.5.0.49

The number of sub-items contained within this ASN.1 item. Only constructed items, such as Sequence and Set will contain sub-iitems. Primitive items such as OIDs, octet strings, integers, etc. will never contain sub-items.

Declare.s ckTag(obj.i) ; (read-only)

Introduced in version 9.5.0.49

The ASN.1 item's tag as a descriptive string. Possible values are:

boolean
integer
bitString
octets
null
oid
utf8String
relativeOid
sequence
set
numericString
printableString
t61String
ia5String
utcTime
bmpString

Declare.i ckTagValue(obj.i) ; (read-only)

Introduced in version 9.5.0.49

The ASN.1 item's tag as a integer value. The integer values for possible tags are as follows:

boolean (1)
integer (2)
bitString (3)
octets (4)
null (5)
oid (6)
utf8String (12)
relativeOid (13)
sequence (16)
set (17)
numericString (18)
printableString (19)
t61String (20)
ia5String (22)
utcTime (23)
bmpString (30)

Declare.i ckVerboseLogging(obj.i)
Declare setCkVerboseLogging(obj.i, value.i)

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Declare.s ckVersion(obj.i) ; (read-only)

Version of the component/library, such as "9.5.0.63"

Methods

Declare.i ckAppendBigInt(obj.i, encodedBytes.s, encoding.s)

Introduced in version 9.5.0.49

Appends an ASN.1 integer, but one that is a big (huge) integer that is too large to be represented by an integer variable. The bytes composing the integer are passed in encoded string format (such as base64, hex, etc.). The byte order must be big-endian. The encoding may be any of the following encodings: "Base64", "Hex", "Base58", "modBase64", "Base32", "UU", "QP" (for quoted-printable), "URL" (for url-encoding), "Q", "B", "url_oath", "url_rfc1738", "url_rfc2396", and "url_rfc3986". The encoding name is case insensitive (for example, both "Base64" and "base64" are treated the same).

Returns 1 for success, 0 for failure.

Using the ASN.1 API to Create a Certificate Request (CSR)

Declare.i ckAppendBits(obj.i, encodedBytes.s, encoding.s)

Introduced in version 9.5.0.49

Appends an ASN.1 bit string to the caller's sub-items. The bytes containing the bits are passed in encoded string format (such as base64, hex, etc.). The byte order must be big-endian (MSB first). The encoding may be any of the following encodings: "Base64", "Hex", "Base58", "modBase64", "Base32", "UU", "QP" (for quoted-printable), "URL" (for url-encoding), "Q", "B", "url_oath", "url_rfc1738", "url_rfc2396", and "url_rfc3986". The encoding name is case insensitive (for example, both "Base64" and "base64" are treated the same).

Returns 1 for success, 0 for failure.

Declare.i ckAppendBool(obj.i, value.l)

Introduced in version 9.5.0.49

Appends an ASN.1 boolean item to the caller's sub-items. Items may only be appended to constructed data types such as Sequence and Set.

Returns 1 for success, 0 for failure.

Declare.i ckAppendContextConstructed(obj.i, tag.l)

Introduced in version 9.5.0.50

Appends an ASN.1 context-specific constructed item to the caller's sub-items.

Returns 1 for success, 0 for failure.

Using the ASN.1 API to Create a Certificate Request (CSR)

Declare.i ckAppendContextPrimitive(obj.i, tag.l, encodedBytes.s, encoding.s)

Introduced in version 9.5.0.50

Appends an ASN.1 context-specific primitive item to the caller's sub-items. The bytes are passed in encoded string format (such as base64, hex, etc.). The encoding may be any of the following encodings: "Base64", "Hex", "Base58", "modBase64", "Base32", "UU", "QP" (for quoted-printable), "URL" (for url-encoding), "Q", "B", "url_oath", "url_rfc1738", "url_rfc2396", and "url_rfc3986". The encoding name is case insensitive (for example, both "Base64" and "base64" are treated the same).

Returns 1 for success, 0 for failure.

Declare.i ckAppendInt(obj.i, value.l)

Introduced in version 9.5.0.49

Appends an ASN.1 integer item to the caller's sub-items. Items may only be appended to constructed data types such as Sequence and Set.

Returns 1 for success, 0 for failure.

Declare.i ckAppendNull(obj.i)

Introduced in version 9.5.0.49

Appends an ASN.1 null item to the caller's sub-items. Items may only be appended to constructed data types such as Sequence and Set.

Returns 1 for success, 0 for failure.

Declare.i ckAppendOctets(obj.i, encodedBytes.s, encoding.s)

Introduced in version 9.5.0.49

Appends an ASN.1 octet string to the caller's sub-items. The bytes are passed in encoded string format (such as base64, hex, etc.). The encoding may be any of the following encodings: "Base64", "Hex", "Base58", "modBase64", "Base32", "UU", "QP" (for quoted-printable), "URL" (for url-encoding), "Q", "B", "url_oath", "url_rfc1738", "url_rfc2396", and "url_rfc3986". The encoding name is case insensitive (for example, both "Base64" and "base64" are treated the same).

Returns 1 for success, 0 for failure.

Declare.i ckAppendOid(obj.i, oid.s)

Introduced in version 9.5.0.49

Appends an ASN.1 OID (object identifier) to the caller's sub-items. The OID is passed in string form, such as "1.2.840.113549.1.9.1".

Returns 1 for success, 0 for failure.

Declare.i ckAppendSequence(obj.i)

Introduced in version 9.5.0.49

Appends an ASN.1 sequence item to the caller's sub-items.

Returns 1 for success, 0 for failure.

Using the ASN.1 API to Create a Certificate Request (CSR)

Declare.i ckAppendSequence2(obj.i)

Introduced in version 9.5.0.50

Appends an ASN.1 sequence item to the caller's sub-items, and updates the internal reference to point to the newly appended sequence item.

Returns 1 for success, 0 for failure.

Declare.i ckAppendSequenceR(obj.i)

Introduced in version 9.5.0.50

Appends an ASN.1 sequence item to the caller's sub-items, and returns the newly appended sequence item.

Returns 0 on failure

Declare.i ckAppendSet(obj.i)

Introduced in version 9.5.0.49

Appends an ASN.1 set item to the caller's sub-items.

Returns 1 for success, 0 for failure.

Using the ASN.1 API to Create a Certificate Request (CSR)

Declare.i ckAppendSet2(obj.i)

Introduced in version 9.5.0.50

Appends an ASN.1 set item to the caller's sub-items, and updates the internal reference to point to the newly appended set item.

Returns 1 for success, 0 for failure.

Declare.i ckAppendSetR(obj.i)

Introduced in version 9.5.0.50

Appends an ASN.1 set item to the caller's sub-items, and returns the newly appended set item.

Returns 0 on failure

Declare.i ckAppendString(obj.i, strType.s, value.s)

Introduced in version 9.5.0.49

Appends a string item to the caller's sub-items. The strType specifies the type of string to be added. It may be "utf8", "ia5", "t61", "printable", "visible", "numeric", "universal", or "bmp". The value must conform to the ASN.1 restrictions imposed for a given string type. The "utf8", "bmp", and "universal" types have no restrictions on what characters are allowed. In general, unless a specific type of string is required, choose the "utf8" type.

Returns 1 for success, 0 for failure.

Declare.i ckAppendTime(obj.i, timeFormat.s, dateTimeStr.s)

Introduced in version 9.5.0.49

Appends a UTCTime item to the caller's sub-items. The timeFormat specifies the format of the dateTimeStr. It should be set to "utc". (In the future, this method will be expanded to append GeneralizedTime items by using "generalized" for timeFormat.) To append the current date/time, set dateTimeStr equal to the empty string or the keyword "now". Otherwise, the dateTimeStr should be in the UTC time format "YYMMDDhhmm[ss]Z" or "YYMMDDhhmm[ss](+|-)hhmm".

Returns 1 for success, 0 for failure.

Declare.s ckAsnToXml(obj.i)

Introduced in version 9.5.0.49

Converts ASN.1 to XML and returns the XML string.

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

Convert ASN.1 to/from Binary DER, XML, and Base64

Load PEM ASN.1 and Convert to XML

Declare.i ckDeleteSubItem(obj.i, index.l)

Introduced in version 9.5.0.49

Discards the Nth sub-item. (The 1st sub-item is at index 0.)

Returns 1 for success, 0 for failure.

Declare.s ckGetEncodedContent(obj.i, encoding.s)

Introduced in version 9.5.0.49

Returns the content of the ASN.1 item in encoded string form. The encoding may be any of the following encodings: "Base64", "Hex", "Base58", "modBase64", "Base32", "UU", "QP" (for quoted-printable), "URL" (for url-encoding), "Q", "B", "url_oath", "url_rfc1738", "url_rfc2396", and "url_rfc3986". The encoding name is case insensitive (for example, both "Base64" and "base64" are treated the same).

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

Declare.s ckGetEncodedDer(obj.i, encoding.s)

Introduced in version 9.5.0.49

Returns the binary DER in encoded string form. The encoding indicates the encoding and can be "base64", "hex", "uu", "quoted-printable", "base32", or "modbase64".

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

Convert ASN.1 to/from Binary DER, XML, and Base64

Using the ASN.1 API to Create a Certificate Request (CSR)

Declare.i ckGetLastSubItem(obj.i)

Introduced in version 9.5.0.49

Returns the last ASN.1 sub-item. This method can be called immediately after any Append* method to access the appended item.

Returns 0 on failure

Declare.i ckGetSubItem(obj.i, index.l)

Introduced in version 9.5.0.49

Returns the Nth ASN.1 sub-item. The 1st sub-item is at index 0.

Returns 0 on failure

Using the ASN.1 API to Create a Certificate Request (CSR)

Declare.i ckLoadAsnXml(obj.i, xmlStr.s)

Introduced in version 9.5.0.49

Loads ASN.1 from the XML representation (such as that created by the AsnToXml method).

Returns 1 for success, 0 for failure.

Convert ASN.1 to/from Binary DER, XML, and Base64

Declare.i ckLoadBinaryFile(obj.i, path.s)

Introduced in version 9.5.0.49

Loads ASN.1 from a binary DER file.

Returns 1 for success, 0 for failure.

Convert ASN.1 to/from Binary DER, XML, and Base64

Declare.i ckLoadEncoded(obj.i, asnContent.s, encoding.s)

Introduced in version 9.5.0.49

Loads ASN.1 from an encoded string. The encoding can be "base64", "hex", "uu", "quoted-printable", "base32", or "modbase64".

Returns 1 for success, 0 for failure.

Convert ASN.1 to/from Binary DER, XML, and Base64

Declare.i ckSaveLastError(obj.i, path.s)

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns 1 for success, 0 for failure.

Declare.i ckSetEncodedContent(obj.i, encodedBytes.s, encoding.s)

Introduced in version 9.5.0.49

Sets the content of this primitive ASN.1 item. The encoding may be any of the following encodings: "Base64", "Hex", "Base58", "modBase64", "Base32", "UU", "QP" (for quoted-printable), "URL" (for url-encoding), "Q", "B", "url_oath", "url_rfc1738", "url_rfc2396", and "url_rfc3986". The encoding name is case insensitive (for example, both "Base64" and "base64" are treated the same).

Returns 1 for success, 0 for failure.

Declare.i ckWriteBinaryDer(obj.i, path.s)

Introduced in version 9.5.0.49

Writes the ASN.1 in binary DER form to a file.

Returns 1 for success, 0 for failure.

Convert ASN.1 to/from Binary DER, XML, and Base64

Using the ASN.1 API to Create a Certificate Request (CSR)