ASN.1 오픈소스 컴파일러 asn1c 사용법

ASN.1 정보를 가지고 개발 하기 위해서 ASN.1 컴파일러가 필요하다.
실제로 상용 버전의 컴파일러는 라이센스 비용이 비싸다
여기서는 현재 무료로 사용 가능한 오픈소스인 asn1c 기본 사용법이다.

해당 툴의 홈페이지에서 관련 설명과 GitHub 에서 소스를 다운 받을 수 있다.
그럼 asn1c 에 대해 사용법을 알아보자.

ASN1C 설치

asn1c 를 소스파일을 풀어 보자
현재 다운 버전은 0.9.28 버전이다.

tar zxvf asn1c-0.9.28.tar.gz
cd asn1c-0.9.28

./configure
make
make install

설치는 간단히 한다.
참고로 make install 은 root 권한이 필요하다.
root 권한이 아니라면 sudo make install 을 해주면 된다.
또는 설치 환경에 따라 루트 권한을 이용하면 된다.

기본적으로는 /usr/local/bin/asn1c 위치에 asn1c 명령어가 설치 된다.
만약 설치 경로를 변경 하려면 ./configure --prefix=/path 옵션을 사용해서 변경 하면 된다.
prefix 옵션을 사용해 루트 권한이 필요하지 않는 위치라면 make install 만 해주어서 사용 하면 된다.

이렇게 설치가 되면 asn1c 바이너리 파일이 생성 되는데 이 명령어에 대한 man 으로 기능 옵션을 확인 할 수 있다.
간단히 man asn1c 라고 입력 하면 아래 처럼 설명이 나온다.

man asn1c

NAME
       asn1c -- the ASN.1 Compiler

SYNOPSIS
       asn1c [-E [-F] | -P | -R]
       [-Sdir] [-X]
       [-Wdebug-...] [-foption] [-gen-option] [-pdu={all|auto|Type}]
       [-print-option]
       input-filenames...

DESCRIPTION
       asn1c compiles ASN.1 specifications into a set of target language
       (C/C++) encoders and decoders for BER, DER, PER, XER and other encoding
       rules.

로 간단히 명령어에 대한 설명을 확인 할 수 있다.

ASN1C 기본 사용법

예제 ASN1 아래 처럼 있다고 하자

TestModule DEFINITIONS ::= BEGIN -- Module parameters preamble
     Circle ::= SEQUENCE { -- Definition of Circle type
    position-x INTEGER, -- Integer position
     position-y INTEGER, -- Position along Y-axis
     radius INTEGER (0..MAX) -- Positive radius
     } -- End of Circle type
END -- End of TestModule

이 내용이르 ex.asn1 파일로 저장을 하자

ASN1.C 문법 테스트

이 모듈을 컴파일을 하면 다음 명령어를 실행 한다.

asn1c -EF ex1.asn1

이렇게 에러가 없이 ASN1 모듈 값이 나오면 정상 파일이다.

BER 등 여러가지 인코드/디코드 소스 만들기

asn1c ex.asn1

이 명령어를 성공적으로 마치면 여러가지 소스 파일이 생성된다.
보통 상용 컴파일러를 사용하면 라이브러리랑 헤더를 생성을 해주는데
asn1c 경우 소스를 생성 한다.

참고로 간단한 모듈이라도 기본적으로 생성해야하는 ASN.1 기능 소스가 있어서 상당히 많은 파일이 생긴다.
예제로 생긴 파일은 다음과 같다

jykim@jykim-VirtualBox:~/work/test$ ls
asn_application.h  BIT_STRING.h        INTEGER.c           per_opentype.c
asn_codecs.h       Circle.c            INTEGER.h           per_opentype.h
asn_codecs_prim.c  Circle.h            Makefile.am.sample  per_support.c
asn_codecs_prim.h  constraints.c       NativeEnumerated.c  per_support.h
asn_internal.h     constraints.h       NativeEnumerated.h  xer_decoder.c
asn_system.h       constr_SEQUENCE.c   NativeInteger.c     xer_decoder.h
ber_decoder.c      constr_SEQUENCE.h   NativeInteger.h     xer_encoder.c
ber_decoder.h      constr_TYPE.c       OCTET_STRING.c      xer_encoder.h
ber_tlv_length.c   constr_TYPE.h       OCTET_STRING.h      xer_support.c
ber_tlv_length.h   converter-sample.c  per_decoder.c       xer_support.h
ber_tlv_tag.c      der_encoder.c       per_decoder.h
ber_tlv_tag.h      der_encoder.h       per_encoder.c
BIT_STRING.c       ex.asn1             per_encoder.h

생성된 파일을 보면 ber, der, per, xer 인코딩 디코딩 API 가 생성 된것을 볼 수 있다.
기본적으로 BER 과 PER은 디폴트로 지원한다.
그리고 BER과 PER 디폴트 지원에 PER 하나만 지원을 하려면 다음 처럼 사용한다.

asn1c -gen-PER ex.asn1

생성된 소스 코드 컴파일

cc -DPDU=Circle -I. -o EX.ex *.c 

이 명령어를 실행하면 EX.ex 라는 바이너릴가 생성 된다.
convert-samlep.c 가 메인 소스이다.

Usage: ./EX.ex [options] <data.ber> ...
Where options are:
  -iper        Input is in Unaligned PER (Packed Encoding Rules) (DEFAULT)
  -iber        Input is in BER (Basic Encoding Rules)
  -ixer        Input is in XER (XML Encoding Rules)
  -oper        Output in Unaligned PER (Packed Encoding Rules)
  -oder        Output in DER (Distinguished Encoding Rules)
  -oxer        Output in XER (XML Encoding Rules) (DEFAULT)
  -otext       Output in plain semi-structured text (dump)
  -onull       Verify (decode) input, but do not output
  -per-nopad   Assume PER PDUs are not padded (-iper)
  -1           Decode only the first PDU in file
  -b <size>    Set the i/o buffer size (default is 8192)
  -c           Check ASN.1 constraints after decoding
  -d           Enable debugging (-dd is even better)
  -n <num>     Process files <num> times
  -s <size>    Set the stack usage limit (default is 30000)

여기서 개발 프로그램 내에서 사용 하려면 이 conver-sample.c 소스를 제외하고 같이 포함하거나
라이브러리로 만들어 사용하면 된다.

RFC 문서를 ASN1 파일 변환

asn1c 를 설치하면 examples 파일에 crfc2asn.pl 이라는 Perl 툴이 있는데
이 툴은 RFC 문서 내에 있는 ASN.1 문법 파일을 추출 하는 유틸이다
사용법은 다음과 같다

./crfc2asn1.pl 
Extract the ASN.1 specification from the RFC file(s).
Usage 1: ./crfc2asn1.pl <rfc-file.txt> ...
Usage 2: <someprog> | ./crfc2asn1.pl

이 툴을 이용해 RFC문서에서 간단히 ASN1 문법을 가져와서 사용할 수 있다.

참고로 모든 문서가 잘 되지는 않았다.
필요시 문서를 수정 후 실행 해야 한다.

홈페이지에서 다운받은 가이드 파일이다

asn1c-usage.pdf

0.20MB

개인적으로 OpenSSL 을 사용하면 ASN.1 컴파일러를 별루 쓰지는 않는다
가끔 OpenSSL 에서 정의 되지 않은 ASN.1 모듈이 필요시 직접 추가해서 사용한다.

하지만 BER 또는 DER 인코딩이 아니라 PER 같은 인코딩을 사용한다면 OpenSSL 은 지원 하지 않는다.
이때는 asn1c를 사용해야 한다.
asn1c 도 필요해서 사용법 정리를 해 보았다.