freedsx/asn1

An ASN.1 library for PHP.

0.4.8 2024-10-13 15:35 UTC

Requires

• php: >=7.1

Requires (Dev)

• friends-of-phpspec/phpspec-code-coverage: ^4.3|^6.1
• phpspec/phpspec: ^5.1|^6.1|^7.1
• phpstan/phpstan: ^0.11.15|^0.12
• slevomat/coding-standard: ~7.0
• squizlabs/php_codesniffer: 3.*
• symplify/easy-coding-standard: ^6.1|^7.3|^9.0

Suggests

• ext-gmp: For big integer support in Integer/Enumerated/OID types and tag numbers.

MIT

• Chad Sikorra

• asn1
• asn.1
• DER
• x.690
• ber

README

FreeDSx ASN1 is a PHP library for dealing with ASN.1 data structures. Its original focus was on ASN.1 BER encoding used in LDAP as part of the FreeDSx LDAP library. It was moved to its own library to allow for additional encoders and reuse in other projects.

Getting Started

Install via composer:

composer require freedsx/asn1

Encoding

To encode an ASN.1 structure you can use the helper methods of the Asn1 class and an encoder:

use FreeDSx\Asn1\Asn1;
use FreeDSx\Asn1\Encoders;

# Create the ASN.1 structure you need...
$asn1 = Asn1::sequence(
    Asn1::integer(9999),
    Asn1::octetString('foo'),
    Asn1::boolean(true)
);

# Encoded $bytes will now contain the BER binary representation of a sequence containing:
#  - An integer type of value 9999
#  - An octet string type of value 'foo'
#  - A boolean type of true
$bytes = Encoders::ber()->encode($asn1);

# Encode using the more strict DER encoder
$bytes = Encoders::der()->encode($asn1);

Decoding

To decode an ASN.1 structure you can get an encoder and call decode then parse it out:

use FreeDSx\Asn1\Asn1;
use FreeDSx\Asn1\Encoders;
use FreeDSx\Asn1\Type\SequenceType;
use FreeDSx\Asn1\Type\OctetStringType;
use FreeDSx\Asn1\Type\IntegerType;
use FreeDSx\Asn1\Type\BooleanType;

# Assuming bytes contains the binary BER encoded sequence described in the encoding section
# Get a BER encoder instance, call decode on it, and $pdu will now be a sequence object.
$pdu = Encoders::ber()->decode($bytes);

# You could also decode using DER, if that's what you're expecting...
$pdu = Encoders::der()->decode($bytes);

# Validate the structure you are expecting...
if (!($pdu instanceof SequenceType && count($pdu) === 3)) {
    echo "Decoded structure is invalid.".PHP_EOL;
    exit;
}

# Loop through the sequence and check the individual types it contains...
foreach ($pdu as $i => $type) {
    if ($i === 0 && $type instanceof IntegerType) {
        var_dump($type->getValue());
    } elseif ($i === 1 && $type instanceof OctetStringType) {
        var_dump($type->getValue());
    } elseif ($i === 2 && $type instanceof BooleanType) {
        var_dump($type->getValue());
    } else {
        echo "Invalid type encountered.".PHP_EOL;
        exit;
    }
}