---
product: Chilkat
product_version: 11.7.0
language: phpext
language_label: PHP Extension
class: Asn
class_name: CkAsn
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/phpCkAsnRef.html
---
# Chilkat Asn — PHP Extension — v11.7.0

> Chilkat 11.7.0 · language=phpext · class=Asn (CkAsn)
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/Asn.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/phpext/guide.md`.

## Purpose

**Load, inspect, build, edit, and encode ASN.1 structures in DER or XML form.**

`Chilkat.Asn` represents an ASN.1 item and its optional child items. It can load ASN.1 from binary DER, encoded DER strings, files, or `BinData`; expose tags, tag values, primitive content, boolean and integer values, and child counts; build constructed structures such as `SEQUENCE` and `SET`; append common primitive types such as booleans, integers, big integers, bit strings, octets, OIDs, strings, times, null values, and context-specific items; convert ASN.1 to XML; reload from that XML form; and write the final structure back to DER.

**Load DER data**

Load ASN.1 from binary DER bytes, encoded text such as Base64 or hex, files, or existing `BinData` objects.

**Inspect ASN.1 items**

Read the item tag, tag value, constructed/primitive state, sub-item count, string content, boolean value, or integer value.

**Build sequences and sets**

Append constructed `SEQUENCE` and `SET` items, then add child ASN.1 values beneath them.

**Append primitive values**

Add booleans, integers, big integers, bit strings, octet strings, OIDs, strings, times, null values, and encoded byte content.

**Context-specific tags**

Add context-specific primitive or constructed items when working with ASN.1 formats that use tagged application-specific structures.

**DER and XML conversion**

Convert ASN.1 to XML for inspection or editing, load ASN.1 back from XML, and output the result as binary or encoded DER.

**Common pattern:** Load existing DER with `LoadBinary`, `LoadEncoded`, `LoadBd`, or `LoadBinaryFile`, inspect the tree with `Tag`, `Constructed`, `NumSubItems`, and `GetSubItem`, then extract primitive content or convert to XML with `AsnToXml`. To create ASN.1, start with a constructed item, append child values, and write the final DER with `GetBinaryDer`, `GetEncodedDer`, `WriteBd`, or `WriteBinaryDer`.

## Object creation, unlocking and error handling

**Object Creation**

```php
$obj = new CkAsn();
```

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in PHP Extension.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `string debugLogFilePath(); void put_DebugLogFilePath(string strVal);` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastErrorHtml` | `(read-only) string lastErrorHtml();` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `(read-only) string lastErrorText();` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `(read-only) string lastErrorXml();` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `bool get_LastMethodSuccess() void put_LastMethodSuccess(bool boolVal);` | read/write | Indicates the success or failure of the most recent method call: `true` means success, `false` means failure. |
| `Utf8` | `bool get_Utf8() void put_Utf8(bool boolVal);` | read/write | When set to `true`, all `string` arguments and return values are interpreted as UTF-8 strings. |
| `VerboseLogging` | `bool get_VerboseLogging() void put_VerboseLogging(bool boolVal);` | read/write | If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `(read-only) string version();` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `BoolValue` | property, read/write | `bool get_BoolValue() void put_BoolValue(bool boolVal);` |
| `Constructed` | property, read-only | `(read-only) bool get_Constructed()` |
| `ContentStr` | property, read/write | `string contentStr(); void put_ContentStr(string strVal);` |
| `IntValue` | property, read/write | `int get_IntValue() void put_IntValue(int intVal);` |
| `NumSubItems` | property, read-only | `(read-only) int get_NumSubItems()` |
| `Tag` | property, read-only | `(read-only) string tag();` |
| `TagValue` | property, read-only | `(read-only) int get_TagValue()` |
| `AppendBigInt` | method | `bool AppendBigInt(string $encodedBytes, string $encoding);` |
| `AppendBits` | method | `bool AppendBits(string $encodedBytes, string $encoding);` |
| `AppendBool` | method | `bool AppendBool(bool $value);` |
| `AppendContextConstructed` | method | `bool AppendContextConstructed(int $tag);` |
| `AppendContextPrimitive` | method | `bool AppendContextPrimitive(int $tag, string $encodedBytes, string $encoding);` |
| `AppendInt` | method | `bool AppendInt(int $value);` |
| `AppendNull` | method | `bool AppendNull();` |
| `AppendOctets` | method | `bool AppendOctets(string $encodedBytes, string $encoding);` |
| `AppendOid` | method | `bool AppendOid(string $oid);` |
| `AppendSequence` | method | `bool AppendSequence();` |
| `AppendSequence2` | method | `bool AppendSequence2();` |
| `AppendSequenceR` | method | `CkAsn AppendSequenceR();` |
| `AppendSet` | method | `bool AppendSet();` |
| `AppendSet2` | method | `bool AppendSet2();` |
| `AppendSetR` | method | `CkAsn AppendSetR();` |
| `AppendString` | method | `bool AppendString(string $strType, string $value);` |
| `AppendTime` | method | `bool AppendTime(string $timeFormat, string $dateTimeStr);` |
| `AsnToXml` | method | `bool AsnToXml(CkString outStr); string asnToXml();` |
| `DeleteSubItem` | method | `bool DeleteSubItem(int $index);` |
| `GetEncodedContent` | method | `bool GetEncodedContent(string $encoding, CkString outStr); string getEncodedContent(string encoding);` |
| `GetEncodedDer` | method | `bool GetEncodedDer(string $encoding, CkString outStr); string getEncodedDer(string encoding);` |
| `GetLastSubItem` | method | `CkAsn GetLastSubItem();` |
| `GetSubItem` | method | `CkAsn GetSubItem(int $index);` |
| `LoadAsnXml` | method | `bool LoadAsnXml(string $xmlStr);` |
| `LoadBd` | method | `bool LoadBd(CkBinData $bd);` |
| `LoadBinaryFile` | method | `bool LoadBinaryFile(string $path);` |
| `LoadEncoded` | method | `bool LoadEncoded(string $asnContent, string $encoding);` |
| `SetEncodedContent` | method | `bool SetEncodedContent(string $encodedBytes, string $encoding);` |
| `WriteBd` | method | `bool WriteBd(CkBinData $bd);` |
| `WriteBinaryDer` | method | `bool WriteBinaryDer(string $path);` |

Deprecated members are listed at the end of this file with their replacements; do not use them in new code.

## Properties

### Asn.BoolValue

`Chilkat 11.7.0 · phpext · Asn · BoolValue · property · read/write · since 9.5.0.49`

```php
bool get_BoolValue()

void put_BoolValue(bool boolVal);
```

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

### Asn.Constructed

`Chilkat 11.7.0 · phpext · Asn · Constructed · property · read-only · since 9.5.0.49`

```php
(read-only)

bool get_Constructed()
```

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

### Asn.ContentStr

`Chilkat 11.7.0 · phpext · Asn · ContentStr · property · read/write · since 9.5.0.49`

```php
string contentStr();

void put_ContentStr(string 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).

### Asn.IntValue

`Chilkat 11.7.0 · phpext · Asn · IntValue · property · read/write · since 9.5.0.49`

```php
int get_IntValue()

void put_IntValue(int intVal);
```

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

### Asn.NumSubItems

`Chilkat 11.7.0 · phpext · Asn · NumSubItems · property · read-only · since 9.5.0.49`

```php
(read-only)

int get_NumSubItems()
```

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.

### Asn.Tag

`Chilkat 11.7.0 · phpext · Asn · Tag · property · read-only · since 9.5.0.49`

```php
(read-only)

string tag();
```

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
```

### Asn.TagValue

`Chilkat 11.7.0 · phpext · Asn · TagValue · property · read-only · since 9.5.0.49`

```php
(read-only)

int get_TagValue()
```

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)
```

## Methods

### Asn.AppendBigInt

`Chilkat 11.7.0 · phpext · Asn · AppendBigInt · method · since 9.5.0.49`

```php
bool AppendBigInt(string $encodedBytes, string $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 true for success, false for failure.

### Asn.AppendBits

`Chilkat 11.7.0 · phpext · Asn · AppendBits · method · since 9.5.0.49`

```php
bool AppendBits(string $encodedBytes, string $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 true for success, false for failure.

### Asn.AppendBool

`Chilkat 11.7.0 · phpext · Asn · AppendBool · method · since 9.5.0.49`

```php
bool AppendBool(bool $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 true for success, false for failure.

### Asn.AppendContextConstructed

`Chilkat 11.7.0 · phpext · Asn · AppendContextConstructed · method · since 9.5.0.50`

```php
bool AppendContextConstructed(int $tag);
```

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

Returns true for success, false for failure.

### Asn.AppendContextPrimitive

`Chilkat 11.7.0 · phpext · Asn · AppendContextPrimitive · method · since 9.5.0.50`

```php
bool AppendContextPrimitive(int $tag, string $encodedBytes, string $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 true for success, false for failure.

### Asn.AppendInt

`Chilkat 11.7.0 · phpext · Asn · AppendInt · method · since 9.5.0.49`

```php
bool AppendInt(int $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 true for success, false for failure.

### Asn.AppendNull

`Chilkat 11.7.0 · phpext · Asn · AppendNull · method · since 9.5.0.49`

```php
bool AppendNull();
```

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.

### Asn.AppendOctets

`Chilkat 11.7.0 · phpext · Asn · AppendOctets · method · since 9.5.0.49`

```php
bool AppendOctets(string $encodedBytes, string $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 true for success, false for failure.

### Asn.AppendOid

`Chilkat 11.7.0 · phpext · Asn · AppendOid · method · since 9.5.0.49`

```php
bool AppendOid(string $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 true for success, false for failure.

### Asn.AppendSequence

`Chilkat 11.7.0 · phpext · Asn · AppendSequence · method · since 9.5.0.49`

```php
bool AppendSequence();
```

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

Returns true for success, false for failure.

### Asn.AppendSequence2

`Chilkat 11.7.0 · phpext · Asn · AppendSequence2 · method · since 9.5.0.50`

```php
bool 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 true for success, false for failure.

### Asn.AppendSequenceR

`Chilkat 11.7.0 · phpext · Asn · AppendSequenceR · method · since 9.5.0.50`

```php
CkAsn AppendSequenceR();
```

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

Returns `null` on failure

### Asn.AppendSet

`Chilkat 11.7.0 · phpext · Asn · AppendSet · method · since 9.5.0.49`

```php
bool AppendSet();
```

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

Returns true for success, false for failure.

### Asn.AppendSet2

`Chilkat 11.7.0 · phpext · Asn · AppendSet2 · method · since 9.5.0.50`

```php
bool 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 true for success, false for failure.

### Asn.AppendSetR

`Chilkat 11.7.0 · phpext · Asn · AppendSetR · method · since 9.5.0.50`

```php
CkAsn AppendSetR();
```

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

Returns `null` on failure

### Asn.AppendString

`Chilkat 11.7.0 · phpext · Asn · AppendString · method · since 9.5.0.49`

```php
bool AppendString(string $strType, string $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 true for success, false for failure.

### Asn.AppendTime

`Chilkat 11.7.0 · phpext · Asn · AppendTime · method · since 9.5.0.49`

```php
bool AppendTime(string $timeFormat, string $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 true for success, false for failure.

### Asn.AsnToXml

`Chilkat 11.7.0 · phpext · Asn · AsnToXml · method · since 9.5.0.49`

```php
bool AsnToXml(CkString outStr);

string asnToXml();
```

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

Returns true for success, false for failure.

### Asn.DeleteSubItem

`Chilkat 11.7.0 · phpext · Asn · DeleteSubItem · method · since 9.5.0.49`

```php
bool DeleteSubItem(int $index);
```

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

Returns true for success, false for failure.

### Asn.GetEncodedContent

`Chilkat 11.7.0 · phpext · Asn · GetEncodedContent · method · since 9.5.0.49`

```php
bool GetEncodedContent(string $encoding, CkString outStr);

string getEncodedContent(string 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 true for success, false for failure.

### Asn.GetEncodedDer

`Chilkat 11.7.0 · phpext · Asn · GetEncodedDer · method · since 9.5.0.49`

```php
bool GetEncodedDer(string $encoding, CkString outStr);

string getEncodedDer(string 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 true for success, false for failure.

### Asn.GetLastSubItem

`Chilkat 11.7.0 · phpext · Asn · GetLastSubItem · method · since 9.5.0.49`

```php
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

### Asn.GetSubItem

`Chilkat 11.7.0 · phpext · Asn · GetSubItem · method · since 9.5.0.49`

```php
CkAsn GetSubItem(int $index);
```

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

Returns `null` on failure

### Asn.LoadAsnXml

`Chilkat 11.7.0 · phpext · Asn · LoadAsnXml · method · since 9.5.0.49`

```php
bool LoadAsnXml(string $xmlStr);
```

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

Returns true for success, false for failure.

### Asn.LoadBd

`Chilkat 11.7.0 · phpext · Asn · LoadBd · method · since 9.5.0.77`

```php
bool LoadBd(CkBinData $bd);
```

Loads ASN.1 from the binary DER contained in `bd`.

Returns true for success, false for failure.

### Asn.LoadBinaryFile

`Chilkat 11.7.0 · phpext · Asn · LoadBinaryFile · method · since 9.5.0.49`

```php
bool LoadBinaryFile(string $path);
```

Loads ASN.1 from a binary DER file.

Returns true for success, false for failure.

### Asn.LoadEncoded

`Chilkat 11.7.0 · phpext · Asn · LoadEncoded · method · since 9.5.0.49`

```php
bool LoadEncoded(string $asnContent, string $encoding);
```

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.

### Asn.SetEncodedContent

`Chilkat 11.7.0 · phpext · Asn · SetEncodedContent · method · since 9.5.0.49`

```php
bool SetEncodedContent(string $encodedBytes, string $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 true for success, false for failure.

### Asn.WriteBd

`Chilkat 11.7.0 · phpext · Asn · WriteBd · method · since 9.5.0.77`

```php
bool WriteBd(CkBinData $bd);
```

Appends the ASN.1 in binary DER format to `bd`.

Returns true for success, false for failure.

### Asn.WriteBinaryDer

`Chilkat 11.7.0 · phpext · Asn · WriteBinaryDer · method · since 9.5.0.49`

```php
bool WriteBinaryDer(string $path);
```

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

Returns true for success, false for failure.

## Deprecated members — do not use in new code

| Member | Kind | Deprecated in | Use instead |
|---|---|---|---|
| `GetBinaryDer` | method | before 11.6.1 | — |
| `LoadBinary` | method | before 11.6.1 | — |

## Related classes

[`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/phpext/classes/BinData.md)

