Asn C Reference Documentation

Asn

Current Version: 9.5.0.75

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

Create/Dispose

HCkAsn instance = CkAsn_Create();
// ...
CkAsn_Dispose(instance);
HCkAsn CkAsn_Create(void);

Creates an instance of the HCkAsn object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkAsn_Dispose(HCkAsn handle);

Objects created by calling CkAsn_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkAsn_Dispose.

Properties

BoolValue
BOOL CkAsn_getBoolValue(HCkAsn cHandle);
void CkAsn_putBoolValue(HCkAsn cHandle, BOOL newVal);
Introduced in version 9.5.0.49

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

top
Constructed
BOOL CkAsn_getConstructed(HCkAsn cHandle);
Introduced in version 9.5.0.49

TRUE 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).

top
ContentStr
void CkAsn_getContentStr(HCkAsn cHandle, HCkString retval);
void CkAsn_putContentStr(HCkAsn cHandle, const char *newVal);
const char *CkAsn_contentStr(HCkAsn cHandle);
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).

top
DebugLogFilePath
void CkAsn_getDebugLogFilePath(HCkAsn cHandle, HCkString retval);
void CkAsn_putDebugLogFilePath(HCkAsn cHandle, const char *newVal);
const char *CkAsn_debugLogFilePath(HCkAsn cHandle);

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.

top
IntValue
int CkAsn_getIntValue(HCkAsn cHandle);
void CkAsn_putIntValue(HCkAsn cHandle, int newVal);
Introduced in version 9.5.0.49

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

top
LastErrorHtml
void CkAsn_getLastErrorHtml(HCkAsn cHandle, HCkString retval);
const char *CkAsn_lastErrorHtml(HCkAsn cHandle);

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.

top
LastErrorText
void CkAsn_getLastErrorText(HCkAsn cHandle, HCkString retval);
const char *CkAsn_lastErrorText(HCkAsn cHandle);

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.

top
LastErrorXml
void CkAsn_getLastErrorXml(HCkAsn cHandle, HCkString retval);
const char *CkAsn_lastErrorXml(HCkAsn cHandle);

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.

top
LastMethodSuccess
BOOL CkAsn_getLastMethodSuccess(HCkAsn cHandle);
void CkAsn_putLastMethodSuccess(HCkAsn cHandle, BOOL newVal);
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of TRUE indicates success, a value of FALSE 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 = TRUE and failure = FALSE.
  • 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 TRUE. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
NumSubItems
int CkAsn_getNumSubItems(HCkAsn cHandle);
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.

top
Tag
void CkAsn_getTag(HCkAsn cHandle, HCkString retval);
const char *CkAsn_tag(HCkAsn cHandle);
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

top
TagValue
int CkAsn_getTagValue(HCkAsn cHandle);
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)

top
Utf8
BOOL CkAsn_getUtf8(HCkAsn cHandle);
void CkAsn_putUtf8(HCkAsn cHandle, BOOL newVal);

When set to TRUE, all "const char *" arguments are interpreted as utf-8 strings. If set to FALSE (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to TRUE, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to FALSE, all "const char *" return values are ANSI strings.

top
VerboseLogging
BOOL CkAsn_getVerboseLogging(HCkAsn cHandle);
void CkAsn_putVerboseLogging(HCkAsn cHandle, BOOL newVal);

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

top
Version
void CkAsn_getVersion(HCkAsn cHandle, HCkString retval);
const char *CkAsn_version(HCkAsn cHandle);

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

top

Methods

AppendBigInt
BOOL CkAsn_AppendBigInt(HCkAsn cHandle, const char *encodedBytes, const char *encoding);
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 TRUE for success, FALSE for failure.

top
AppendBits
BOOL CkAsn_AppendBits(HCkAsn cHandle, const char *encodedBytes, const char *encoding);
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 TRUE for success, FALSE for failure.

top
AppendBool
BOOL CkAsn_AppendBool(HCkAsn cHandle, BOOL value);
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 TRUE for success, FALSE for failure.

top
AppendContextConstructed
BOOL CkAsn_AppendContextConstructed(HCkAsn cHandle, int tag);
Introduced in version 9.5.0.50

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

Returns TRUE for success, FALSE for failure.

top
AppendContextPrimitive
BOOL CkAsn_AppendContextPrimitive(HCkAsn cHandle, int tag, const char *encodedBytes, const char *encoding);
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 TRUE for success, FALSE for failure.

top
AppendInt
BOOL CkAsn_AppendInt(HCkAsn cHandle, int value);
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 TRUE for success, FALSE for failure.

top
AppendNull
BOOL CkAsn_AppendNull(HCkAsn cHandle);
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 TRUE for success, FALSE for failure.

top
AppendOctets
BOOL CkAsn_AppendOctets(HCkAsn cHandle, const char *encodedBytes, const char *encoding);
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 TRUE for success, FALSE for failure.

top
AppendOid
BOOL CkAsn_AppendOid(HCkAsn cHandle, const char *oid);
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 TRUE for success, FALSE for failure.

top
AppendSequence
BOOL CkAsn_AppendSequence(HCkAsn cHandle);
Introduced in version 9.5.0.49

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

Returns TRUE for success, FALSE for failure.

top
AppendSequence2
BOOL CkAsn_AppendSequence2(HCkAsn cHandle);
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 TRUE for success, FALSE for failure.

top
AppendSequenceR
HCkAsn CkAsn_AppendSequenceR(HCkAsn cHandle);
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 NULL on failure

top
AppendSet
BOOL CkAsn_AppendSet(HCkAsn cHandle);
Introduced in version 9.5.0.49

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

Returns TRUE for success, FALSE for failure.

top
AppendSet2
BOOL CkAsn_AppendSet2(HCkAsn cHandle);
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 TRUE for success, FALSE for failure.

top
AppendSetR
HCkAsn CkAsn_AppendSetR(HCkAsn cHandle);
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 NULL on failure

top
AppendString
BOOL CkAsn_AppendString(HCkAsn cHandle, const char *strType, const char *value);
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 TRUE for success, FALSE for failure.

top
AppendTime
BOOL CkAsn_AppendTime(HCkAsn cHandle, const char *timeFormat, const char *dateTimeStr);
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 TRUE for success, FALSE for failure.

top
AsnToXml
BOOL CkAsn_AsnToXml(HCkAsn cHandle, HCkString outStr);
const char *CkAsn_asnToXml(HCkAsn cHandle);
Introduced in version 9.5.0.49

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

Returns TRUE for success, FALSE for failure.

top
DeleteSubItem
BOOL CkAsn_DeleteSubItem(HCkAsn cHandle, int index);
Introduced in version 9.5.0.49

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

Returns TRUE for success, FALSE for failure.

top
GetBinaryDer
BOOL CkAsn_GetBinaryDer(HCkAsn cHandle, HCkByteData outBytes);
Introduced in version 9.5.0.49

Returns the ASN.1 in binary DER form.

Returns TRUE for success, FALSE for failure.

top
GetEncodedContent
BOOL CkAsn_GetEncodedContent(HCkAsn cHandle, const char *encoding, HCkString outStr);
const char *CkAsn_getEncodedContent(HCkAsn cHandle, const char *encoding);
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 TRUE for success, FALSE for failure.

top
GetEncodedDer
BOOL CkAsn_GetEncodedDer(HCkAsn cHandle, const char *encoding, HCkString outStr);
const char *CkAsn_getEncodedDer(HCkAsn cHandle, const char *encoding);
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 TRUE for success, FALSE for failure.

top
GetLastSubItem
HCkAsn CkAsn_GetLastSubItem(HCkAsn cHandle);
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 NULL on failure

top
GetSubItem
HCkAsn CkAsn_GetSubItem(HCkAsn cHandle, int index);
Introduced in version 9.5.0.49

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

Returns NULL on failure

top
LoadAsnXml
BOOL CkAsn_LoadAsnXml(HCkAsn cHandle, const char *xmlStr);
Introduced in version 9.5.0.49

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

Returns TRUE for success, FALSE for failure.

top
LoadBinary
BOOL CkAsn_LoadBinary(HCkAsn cHandle, HCkByteData derBytes);
Introduced in version 9.5.0.49

Loads ASN.1 from binary DER.

Returns TRUE for success, FALSE for failure.

top
LoadBinaryFile
BOOL CkAsn_LoadBinaryFile(HCkAsn cHandle, const char *path);
Introduced in version 9.5.0.49

Loads ASN.1 from a binary DER file.

Returns TRUE for success, FALSE for failure.

top
LoadEncoded
BOOL CkAsn_LoadEncoded(HCkAsn cHandle, const char *asnContent, const char *encoding);
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 TRUE for success, FALSE for failure.

top
SaveLastError
BOOL CkAsn_SaveLastError(HCkAsn cHandle, const char *path);

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

Returns TRUE for success, FALSE for failure.

top
SetEncodedContent
BOOL CkAsn_SetEncodedContent(HCkAsn cHandle, const char *encodedBytes, const char *encoding);
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 TRUE for success, FALSE for failure.

top
WriteBinaryDer
BOOL CkAsn_WriteBinaryDer(HCkAsn cHandle, const char *path);
Introduced in version 9.5.0.49

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

Returns TRUE for success, FALSE for failure.

top