Asn Tcl Reference Documentation
Asn
Current Version: 10.0.0
For creating, loading, parsing, converting, and saving ASN.1
Object Creation
set myAsn [new CkAsn]
Properties
BoolValue
set boolVal [CkAsn_get_BoolValue $myAsn]
CkAsn_put_BoolValue $myAsn $boolVal
The ASN.1 item's boolean value if it is a boolean item.
topConstructed
set boolVal [CkAsn_get_Constructed $myAsn]
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).
topContentStr
# ckStr is a CkString
CkAsn_get_ContentStr $myAsn $ckStr
set strVal [CkAsn_get_contentStr $myAsn]
CkAsn_put_ContentStr $myAsn $strVal
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).
topDebugLogFilePath
# ckStr is a CkString
CkAsn_get_DebugLogFilePath $myAsn $ckStr
set strVal [CkAsn_get_debugLogFilePath $myAsn]
CkAsn_put_DebugLogFilePath $myAsn $strVal
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:
- a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
- the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
- there is an internal problem (bug) in the Chilkat code that causes the hang.
IntValue
set intVal [CkAsn_get_IntValue $myAsn]
CkAsn_put_IntValue $myAsn $intVal
The ASN.1 item's integer value if it is a small integer item.
topLastErrorHtml
# ckStr is a CkString
CkAsn_get_LastErrorHtml $myAsn $ckStr
set strVal [CkAsn_get_lastErrorHtml $myAsn]
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.
topLastErrorText
# ckStr is a CkString
CkAsn_get_LastErrorText $myAsn $ckStr
set strVal [CkAsn_get_lastErrorText $myAsn]
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.
LastErrorXml
# ckStr is a CkString
CkAsn_get_LastErrorXml $myAsn $ckStr
set strVal [CkAsn_get_lastErrorXml $myAsn]
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.
topLastMethodSuccess
set boolVal [CkAsn_get_LastMethodSuccess $myAsn]
CkAsn_put_LastMethodSuccess $myAsn $boolVal
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.
topNumSubItems
set intVal [CkAsn_get_NumSubItems $myAsn]
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.
topTag
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 bmpStringtop
TagValue
set intVal [CkAsn_get_TagValue $myAsn]
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
set boolVal [CkAsn_get_Utf8 $myAsn]
CkAsn_put_Utf8 $myAsn $boolVal
When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.
topVerboseLogging
set boolVal [CkAsn_get_VerboseLogging $myAsn]
CkAsn_put_VerboseLogging $myAsn $boolVal
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.
topVersion
Methods
AppendBigInt
# encoding is a string
set status [CkAsn_AppendBigInt $encodedBytes $encoding]
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.
AppendBits
# encoding is a string
set status [CkAsn_AppendBits $encodedBytes $encoding]
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.
topAppendBool
set status [CkAsn_AppendBool $value]
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.
topAppendContextConstructed
set status [CkAsn_AppendContextConstructed $tag]
Appends an ASN.1 context-specific constructed item to the caller's sub-items.
Returns 1 for success, 0 for failure.
AppendContextPrimitive
# encodedBytes is a string
# encoding is a string
set status [CkAsn_AppendContextPrimitive $tag $encodedBytes $encoding]
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.
topAppendInt
set status [CkAsn_AppendInt $value]
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.
topAppendNull
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.
topAppendOctets
# encoding is a string
set status [CkAsn_AppendOctets $encodedBytes $encoding]
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.
topAppendOid
set status [CkAsn_AppendOid $oid]
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.
topAppendSequence
Appends an ASN.1 sequence item to the caller's sub-items.
Returns 1 for success, 0 for failure.
AppendSequence2
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.
topAppendSequenceR
Appends an ASN.1 sequence item to the caller's sub-items, and returns the newly appended sequence item.
Returns NULL on failure
topAppendSet
Appends an ASN.1 set item to the caller's sub-items.
Returns 1 for success, 0 for failure.
AppendSet2
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.
topAppendSetR
Appends an ASN.1 set item to the caller's sub-items, and returns the newly appended set item.
Returns NULL on failure
topAppendString
# value is a string
set status [CkAsn_AppendString $strType $value]
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.
topAppendTime
# dateTimeStr is a string
set status [CkAsn_AppendTime $timeFormat $dateTimeStr]
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.
topAsnToXml
set status [CkAsn_AsnToXml $outStr]
set retStr [CkAsn_asnToXml $myAsn]
Converts ASN.1 to XML and returns the XML string.
Returns 1 for success, 0 for failure.
DeleteSubItem
set status [CkAsn_DeleteSubItem $index]
Discards the Nth sub-item. (The 1st sub-item is at index 0.)
Returns 1 for success, 0 for failure.
topGetBinaryDer
GetEncodedContent
# outStr is a CkString (output)
set status [CkAsn_GetEncodedContent $encoding $outStr]
set retStr [CkAsn_getEncodedContent $myAsn $encoding]
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 1 for success, 0 for failure.
topGetEncodedDer
# outStr is a CkString (output)
set status [CkAsn_GetEncodedDer $encoding $outStr]
set retStr [CkAsn_getEncodedDer $myAsn $encoding]
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 1 for success, 0 for failure.
GetLastSubItem
set ret_asn [CkAsn_GetLastSubItem]
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
topGetSubItem
# index is an integer
set ret_asn [CkAsn_GetSubItem $index]
Returns the Nth ASN.1 sub-item. The 1st sub-item is at index 0.
Returns NULL on failure
LoadAsnXml
set status [CkAsn_LoadAsnXml $xmlStr]
Loads ASN.1 from the XML representation (such as that created by the AsnToXml method).
Returns 1 for success, 0 for failure.
LoadBd
set status [CkAsn_LoadBd $bd]
Loads ASN.1 from the binary DER contained in bd.
Returns 1 for success, 0 for failure.
LoadBinary
LoadBinaryFile
set status [CkAsn_LoadBinaryFile $path]
Loads ASN.1 from a binary DER file.
Returns 1 for success, 0 for failure.
LoadEncoded
# encoding is a string
set status [CkAsn_LoadEncoded $asnContent $encoding]
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.
SetEncodedContent
# encoding is a string
set status [CkAsn_SetEncodedContent $encodedBytes $encoding]
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.
topWriteBd
set status [CkAsn_WriteBd $bd]
WriteBinaryDer
set status [CkAsn_WriteBinaryDer $path]
Writes the ASN.1 in binary DER form to a file.
Returns 1 for success, 0 for failure.