blob: dda59ca9714b0157fbc426c51f24d4e1289f2952 [file] [log] [blame]
Lev Walkin288527b2014-10-26 20:12:53 -07001\batchmode
Lev Walkin464166c2010-11-09 08:34:38 -08002\documentclass[english,oneside,12pt]{book}
Lev Walkin194b2102013-03-28 01:29:06 -07003\usepackage[no-math]{fontspec}
4\usepackage{MnSymbol}
Lev Walkin464166c2010-11-09 08:34:38 -08005\usepackage{xunicode}
6\usepackage{xltxtra}
7
Lev Walkin11c9a8c2013-03-26 00:46:55 -07008\usepackage[hmargin={1in,1in},vmargin={1.5in,1.5in}]{geometry}
Lev Walkin464166c2010-11-09 08:34:38 -08009
10\defaultfontfeatures{Mapping=tex-text}
Lev Walkin11c9a8c2013-03-26 00:46:55 -070011\setmainfont{PT Sans}
12\setsansfont{PT Sans}
Lev Walkin464166c2010-11-09 08:34:38 -080013\setmonofont{Consolas}
14
Lev Walkined44bf42010-11-08 02:04:55 -080015\usepackage{fancyhdr}
Lev Walkined44bf42010-11-08 02:04:55 -080016\usepackage{longtable}
Lev Walkin464166c2010-11-09 08:34:38 -080017\usepackage{booktabs}
Lev Walkined44bf42010-11-08 02:04:55 -080018\usepackage{varioref}
19\usepackage{url}
Lev Walkin11c9a8c2013-03-26 00:46:55 -070020\usepackage{xcolor}
21\usepackage{listings}
22\usepackage{setspace}
Lev Walkin194b2102013-03-28 01:29:06 -070023\usepackage{unicode-math}
24\usepackage{perpage}
25\MakePerPage{footnote}
Lev Walkin11c9a8c2013-03-26 00:46:55 -070026
27\setstretch{1.1}
28
29% Courier 10 Pitch
30\def\courierFont{Courier10 BT WGL4}
31%\def\courierFont{Consolas}
32\setmonofont[Scale=1.05]{\courierFont}
Lev Walkin194b2102013-03-28 01:29:06 -070033\setmathfont[Scale=1.05]{Cambria Math}
Lev Walkin11c9a8c2013-03-26 00:46:55 -070034
Lev Walkined44bf42010-11-08 02:04:55 -080035
36\makeatletter
37
Lev Walkined44bf42010-11-08 02:04:55 -080038%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% Textclass specific LaTeX commands.
Lev Walkin11c9a8c2013-03-26 00:46:55 -070039\lstloadlanguages{C,bash}
40\newfontfamily\listingfont[Scale=1.05]{\courierFont}
41\newfontfamily\inlinelistingfont[Scale=1.05]{\courierFont}
42\definecolor{clrlcomment}{gray}{0.3}
43\definecolor{clrlkeyword}{rgb}{0.588,0.145,0.18}
44\newcommand{\listingkeyword}[1]{\color{clrlkeyword}{#1}}
45\newcommand{\listingstring}[1]{\color{clrlcomment}{#1}}
46\newcommand{\listingcomment}[1]{\color{clrlcomment}{#1}}
47\lstset{tabsize=4,
48 showstringspaces=false,
49 showtabs=false,
50 showspaces=false,
51 keywordstyle=\listingkeyword,
52 stringstyle=\listingstring,
53 commentstyle=\listingcomment,
54 xleftmargin=\parindent,
55 columns=fixed,
56 escapechar=\%,
57 texcl
58}
59\lstdefinestyle{listingStyle}{
60 basicstyle=\small\listingfont,
61 stringstyle=\listingstring,
62 breaklines=true,
63 breakatwhitespace=true,
64 flexiblecolumns=false
65 }
66\lstdefinelanguage{asn1}{
67 morekeywords={DEFINITIONS,BEGIN,END,SEQUENCE,SET,OF,CHOICE,OPTIONAL},
68 morecomment=[l]{--},
69 morecomment=[n]{/*}{*/}
70 }
71
72\lstnewenvironment{codesample}[1][]{\lstset{style=listingStyle,language=C,#1}}{}
Lev Walkin2a744a72013-03-27 01:56:23 -070073\lstnewenvironment{bash}[1][]{\lstset{style=listingStyle,language=bash,#1}}{}
Lev Walkin11c9a8c2013-03-26 00:46:55 -070074\lstnewenvironment{asn}[1][]{\lstset{style=listingStyle,language=asn1,#1}}{}
75\def\code{lstinline}
Lev Walkined44bf42010-11-08 02:04:55 -080076
77%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% User specified LaTeX commands.
78\usepackage{extramarks}
79\lhead{\firstxmark}
80\rfoot{\lastxmark}
Lev Walkin11c9a8c2013-03-26 00:46:55 -070081\definecolor{clrlink}{rgb}{0,0.4,0}
82\definecolor{clrurl}{rgb}{0,0,.6}
Lev Walkined44bf42010-11-08 02:04:55 -080083\usepackage[colorlinks=true,
Lev Walkin11c9a8c2013-03-26 00:46:55 -070084 linkcolor={clrlink},
85 citecolor={clrlink},
86 urlcolor={clrurl},
87 pdfauthor={Lev Walkin},
88 pdftitle={Using the Open Source ASN.1 Compiler},
89 pdfkeywords={ASN.1,asn1c,compiler},
90 bookmarksopen,bookmarksopenlevel=1,
91 pdffitwindow,
92 xetex
Lev Walkined44bf42010-11-08 02:04:55 -080093]{hyperref}
Lev Walkined44bf42010-11-08 02:04:55 -080094
95\makeatother
96
97\usepackage{babel}
98
99\begin{document}
100
Lev Walkin50155de2014-10-26 19:46:16 -0700101\title{Using the Open Source ASN.1 Compiler\\
Lev Walkin288527b2014-10-26 20:12:53 -0700102\vspace*{0.4cm}
Lev Walkin50155de2014-10-26 19:46:16 -0700103\Large Documentation for asn1c version \asnver{}}
Lev Walkined44bf42010-11-08 02:04:55 -0800104\author{Lev Walkin <\href{mailto:vlm@lionet.info?Subject=asn1c}{vlm@lionet.info}>}
105
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700106\pagestyle{fancy}
107\fancyhead[L]{\leftmark}
Lev Walkin50155de2014-10-26 19:46:16 -0700108\fancyhead[R]{\href{http://lionet.info/asn1c}{asn1c-\asnver}}
Lev Walkined44bf42010-11-08 02:04:55 -0800109\maketitle
Lev Walkined44bf42010-11-08 02:04:55 -0800110
111\tableofcontents{}
112
Lev Walkined44bf42010-11-08 02:04:55 -0800113\part{Using the ASN.1 Compiler}
114
115
116\chapter{Introduction to the ASN.1 Compiler}
117
118The purpose of the ASN.1 compiler is to convert the specifications
119in ASN.1 notation into some other language. At this moment, only C
120and C++ target languages are supported, the latter is in upward compatibility
121mode.
122
123The compiler reads the specification and emits a series of target
Lev Walkin464166c2010-11-09 08:34:38 -0800124language structures (C structs, unions, enums) describing the corresponding
Lev Walkined44bf42010-11-08 02:04:55 -0800125ASN.1 types. The compiler also creates the code which allows automatic
126serialization and deserialization of these structures using several
Lev Walkin464166c2010-11-09 08:34:38 -0800127standardized encoding rules (BER, DER, XER, PER).
Lev Walkined44bf42010-11-08 02:04:55 -0800128
129For example, suppose the following ASN.1 module is given%
Lev Walkin194b2102013-03-28 01:29:06 -0700130\footnote{Part \ref{par:ASN.1-Basics} provides a quick reference
Lev Walkin464166c2010-11-09 08:34:38 -0800131on the ASN.1 notation.}:
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700132\begin{asn}
133RectangleTest DEFINITIONS ::= BEGIN
Lev Walkined44bf42010-11-08 02:04:55 -0800134
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700135Rectangle ::= SEQUENCE {
136 height INTEGER, -- Height of the rectangle
137 width INTEGER -- Width of the rectangle
138}
Lev Walkined44bf42010-11-08 02:04:55 -0800139
140END
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700141\end{asn}
Lev Walkined44bf42010-11-08 02:04:55 -0800142The compiler would read this ASN.1 definition and produce the following
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700143C type:
144\begin{codesample}
145typedef struct Rectangle_s {
146 long height;
147 long width;
148} Rectangle_t;
149\end{codesample}
Lev Walkined44bf42010-11-08 02:04:55 -0800150It would also create the code for converting this structure into platform-independent
151wire representation (a serializer API) and the decoder of such wire
152representation back into local, machine-specific type (a deserializer
153API).
154
155
156\section{Quick start with asn1c}
157
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700158After building and installing the compiler, the \emph{asn1c}
159command may be used to compile the ASN.1 modules%
Lev Walkin194b2102013-03-28 01:29:06 -0700160\footnote{This is probably \textbf{not} what you want to try out right now. Read through the rest of this chapter and check the Section~\ref{sec:Command-line-options}
Lev Walkined44bf42010-11-08 02:04:55 -0800161to find out about \textbf{-P} and \textbf{-R} options.%
162}:
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700163\begin{bash}
164asn1c %\emph{<modules.asn1>}%
165\end{bash}
Lev Walkined44bf42010-11-08 02:04:55 -0800166If several ASN.1 modules contain interdependencies, all of the files
167must be specified altogether:
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700168\begin{bash}
169asn1c %\emph{<module1.asn1> <module2.asn1> ...}%
170\end{bash}
Lev Walkined44bf42010-11-08 02:04:55 -0800171The compiler \textbf{-E} and \textbf{-EF} options are used for testing
172the parser and the semantic fixer, respectively. These options will
173instruct the compiler to dump out the parsed (and fixed, if \textbf{-F}
Lev Walkin2a744a72013-03-27 01:56:23 -0700174is involved) ASN.1 specification as it was understood
Lev Walkined44bf42010-11-08 02:04:55 -0800175by the compiler. It might be useful to check whether a particular
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700176syntactic construct is properly supported by the compiler.
177\begin{bash}
178asn1c %\textbf{-EF} \emph{<module-to-test.asn1>}%
179\end{bash}
Lev Walkined44bf42010-11-08 02:04:55 -0800180The \textbf{-P} option is used to dump the compiled output on the
181screen instead of creating a bunch of .c and .h files on disk in the
182current directory. You would probably want to start with \textbf{-P}
183option instead of creating a mess in your current directory. Another
184option, \textbf{-R}, asks compiler to only generate the files which
185need to be generated, and supress linking in the numerous support
186files.
187
188Print the compiled output instead of creating multiple source files:
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700189\begin{bash}
190asn1c %\textbf{-P} \emph{<module-to-compile-and-print.asn1>}%
191\end{bash}
Lev Walkined44bf42010-11-08 02:04:55 -0800192
Lev Walkin2a744a72013-03-27 01:56:23 -0700193\clearpage{}
Lev Walkined44bf42010-11-08 02:04:55 -0800194\section{Recognizing compiler output}
195
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700196The asn1c compiler produces a number of files:
Lev Walkined44bf42010-11-08 02:04:55 -0800197\begin{itemize}
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700198\item A set of .c and .h files for each type defined
199in the ASN.1 specification. These files will be named similarly to
Lev Walkined44bf42010-11-08 02:04:55 -0800200the ASN.1 types (\emph{Rectangle.c} and \emph{Rectangle.h} for the
201RectangleTest ASN.1 module defined in the beginning of this document).
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700202\item A set of helper .c and .h files which contain the generic encoders,
203decoders and other useful routines. There will be quite a few of them, some
204of them are not even always necessary, but the overall amount of code
Lev Walkined44bf42010-11-08 02:04:55 -0800205after compilation will be rather small anyway.
Lev Walkinba68c912017-07-06 07:52:39 -0700206\item A \emph{converter-sample.c} file containing the \emph{int main()} function with a fully functioning decoder. It can convert a given PDU between BER, XER and possibly OER and PER (if -gen-OER or -gen-PER options to asn1c were in effect). At some point you will want to replace this file with your own file containing the \emph{int main()} function.
Lev Walkined44bf42010-11-08 02:04:55 -0800207\item A \emph{Makefile.am.sample} file mentioning all the files created
208at the earlier steps. This file is suitable for either automake suite
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700209or the plain `make` utility. Just rename it into \emph{Makefile}.
Lev Walkined44bf42010-11-08 02:04:55 -0800210\end{itemize}
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700211It is possible to compile everything with just a couple of instructions:
212\begin{bash}
Lev Walkin2a744a72013-03-27 01:56:23 -0700213asn1c -pdu=%\emph{Rectangle}% *.asn1
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700214make -f Makefile.am.sample # If you use `make`
215\end{bash}
216or
217\begin{bash}
Lev Walkin2a744a72013-03-27 01:56:23 -0700218asn1c *.asn1
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700219cc -I. -DPDU=%\emph{Rectangle}% -o rectangle.exe *.c # ... or like this
220\end{bash}
Lev Walkin194b2102013-03-28 01:29:06 -0700221Refer to the Chapter \ref{cha:Step-by-step-examples} for a sample
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700222\emph{int main()} function if you want some custom logic and not satisfied
223with the supplied \emph{converter-sample.c}.
Lev Walkined44bf42010-11-08 02:04:55 -0800224
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700225\clearpage{}
Lev Walkined44bf42010-11-08 02:04:55 -0800226\section{\label{sec:Command-line-options}Command line options}
227
228The following table summarizes the asn1c command line options.
229
Lev Walkin464166c2010-11-09 08:34:38 -0800230\renewcommand{\arraystretch}{1.33}
231\begin{longtable}{lp{4in}}
Lev Walkin288527b2014-10-26 20:12:53 -0700232\textbf{Stage Selection Options} & \textbf{Description}\\
Lev Walkin464166c2010-11-09 08:34:38 -0800233\midrule
Lev Walkin288527b2014-10-26 20:12:53 -0700234{\ttfamily -E} & {\small Stop after the parsing stage and print the reconstructed ASN.1
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700235specification code to the standard output.}\\
Lev Walkin288527b2014-10-26 20:12:53 -0700236{\ttfamily -F} & {\small Used together with \texttt{-E}, instructs the compiler to stop after
Lev Walkined44bf42010-11-08 02:04:55 -0800237the ASN.1 syntax tree fixing stage and dump the reconstructed ASN.1
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700238specification to the standard output.}\\
Lev Walkin288527b2014-10-26 20:12:53 -0700239{\ttfamily -P} & {\small Dump the compiled output to the standard output instead of
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700240creating the target language files on disk.}\\
Lev Walkin288527b2014-10-26 20:12:53 -0700241{\ttfamily -R} & {\small Restrict the compiler to generate only the ASN.1 tables, omitting the usual support code.}\\
242{\ttfamily -S~\emph{<directory>}} & {\small Use the specified directory with ASN.1 skeleton files.}\\
243{\ttfamily -X} & {\small Generate the XML DTD for the specified ASN.1 modules.}\\\\
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700244\textbf{Warning Options} & \textbf{Description}\\
Lev Walkin464166c2010-11-09 08:34:38 -0800245\midrule
Lev Walkin288527b2014-10-26 20:12:53 -0700246{\ttfamily -Werror} & {\small Treat warnings as errors; abort if any warning is produced.}\\
Lev Walkin6a0b3632017-09-13 01:36:47 -0700247{\ttfamily -Wdebug-parser} & {\small Enable the parser debugging during the ASN.1 parsing stage.}\\
248{\ttfamily -Wdebug-lexer} & {\small Enable the lexer debugging during the ASN.1 parsing stage.}\\
249{\ttfamily -Wdebug-fixer} & {\small Enable the ASN.1 syntax tree fixer debugging during the fixing stage.}\\
Lev Walkin288527b2014-10-26 20:12:53 -0700250{\ttfamily -Wdebug-compiler} & {\small Enable debugging during the actual compile time.}\\ \\
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700251\textbf{Language Options} & \textbf{Description}\\
Lev Walkin464166c2010-11-09 08:34:38 -0800252\midrule
Lev Walkin288527b2014-10-26 20:12:53 -0700253{\ttfamily -fbless-SIZE} & {\small Allow SIZE() constraint for INTEGER, ENUMERATED, and other types for which this constraint is normally prohibited by the standard.
254This is a violation of an ASN.1 standard and compiler may fail to produce the meaningful code.}\\
255{\ttfamily -fcompound-names} & {\small Use complex names for C structures. Using complex names prevents
Lev Walkined44bf42010-11-08 02:04:55 -0800256name clashes in case the module reuses the same identifiers in multiple
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700257contexts.}\\
Lev Walkin288527b2014-10-26 20:12:53 -0700258{\ttfamily -findirect-choice} & {\small When generating code for a CHOICE type, compile the CHOICE
Lev Walkined44bf42010-11-08 02:04:55 -0800259members as indirect pointers instead of declaring them inline. Consider
Lev Walkin288527b2014-10-26 20:12:53 -0700260using this option together with \texttt{-fno-include-deps}
261to prevent circular references.}\\
262{\ttfamily -fincludes-quoted} & {\small Generate \#include lines in "double" instead of <angle> quotes.}\\
263{\ttfamily -fknown-extern-type=\emph{<name>}} & {\small Pretend the specified type is known. The compiler will assume
Lev Walkined44bf42010-11-08 02:04:55 -0800264the target language source files for the given type have been provided
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700265manually. }\\
Lev Walkin288527b2014-10-26 20:12:53 -0700266{\ttfamily -fline-refs} & {\small Include ASN.1 module's line numbers in generated code comments.}\\
267{\ttfamily -fno-constraints} & {\small Do not generate ASN.1 subtype constraint checking code. This
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700268may produce a shorter executable.}\\
Lev Walkin288527b2014-10-26 20:12:53 -0700269{\ttfamily -fno-include-deps} & {\small Do not generate courtesy \#include lines for non-critical dependencies.}\\
270{\ttfamily -funnamed-unions} & {\small Enable unnamed unions in the definitions of target language's structures.}\\
271{\ttfamily -fwide-types} & {\small Use the wide integer types (INTEGER\_t, REAL\_t) instead of machine's native data types (long, double). }\\\\
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700272\textbf{Codecs Generation Options} & \textbf{Description}\\
Lev Walkin464166c2010-11-09 08:34:38 -0800273\midrule
Lev Walkinba68c912017-07-06 07:52:39 -0700274{\ttfamily -gen-OER} & {\small Generate the Octet Encoding Rules (OER) support code.}\\
Lev Walkin288527b2014-10-26 20:12:53 -0700275{\ttfamily -gen-PER} & {\small Generate the Packed Encoding Rules (PER) support code.}\\
276{\ttfamily -pdu=\{\textbf{all}|\textbf{auto}|\emph{Type}\}} & {\small Create a PDU table for specified types, or discover the Protocol Data Units automatically.
277In case of \texttt{-pdu=\textbf{all}}, all ASN.1 types defined in all modules wil form a PDU table. In case of \texttt{-pdu=\textbf{auto}}, all types not referenced by any other type will form a PDU table. If \texttt{\emph{Type}} is an ASN.1 type identifier, it is added to a PDU table. The last form may be specified multiple times.}\\ \\
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700278\textbf{Output Options} & \textbf{Description}\\
Lev Walkin464166c2010-11-09 08:34:38 -0800279\midrule
Lev Walkin288527b2014-10-26 20:12:53 -0700280{\ttfamily -print-constraints} & {\small When \texttt{-EF} are also specified, this option forces the compiler
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700281to explain its internal understanding of subtype constraints.}\\
Lev Walkin288527b2014-10-26 20:12:53 -0700282{\ttfamily -print-lines} & {\small Generate \texttt{``-{}- \#line''} comments
283in \texttt{-E} output.}\\
Lev Walkined44bf42010-11-08 02:04:55 -0800284\end{longtable}
Lev Walkin464166c2010-11-09 08:34:38 -0800285\renewcommand{\arraystretch}{1}
Lev Walkined44bf42010-11-08 02:04:55 -0800286
287
288\chapter{Using the ASN.1 Compiler}
289
290
291\section[Invoking the helper code]{Invoking the ASN.1 helper code}
292
293First of all, you should include one or more header files into your
294application. Typically, it is enough to include the header file of
295the main PDU type. For our Rectangle module, including the Rectangle.h
296file is sufficient:
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700297\begin{codesample}
298#include <Rectangle.h>
299\end{codesample}
Lev Walkined44bf42010-11-08 02:04:55 -0800300The header files defines the C structure corresponding to the ASN.1
301definition of a rectangle and the declaration of the ASN.1 type descriptor,
302which is used as an argument to most of the functions provided by
303the ASN.1 module. For example, here is the code which frees the Rectangle\_t
304structure:
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700305\begin{codesample}
306Rectangle_t *rect = ...;
Lev Walkined44bf42010-11-08 02:04:55 -0800307
Lev Walkin8d99d7b2017-08-25 01:06:00 -0700308ASN_STRUCT_FREE(asn_DEF_Rectangle, rect);
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700309\end{codesample}
Lev Walkined44bf42010-11-08 02:04:55 -0800310This code defines a \emph{rect} pointer which points to the Rectangle\_t
Lev Walkin8d99d7b2017-08-25 01:06:00 -0700311structure which needs to be freed. The second line uses the generic
312ASN\_STRUCT\_FREE() macro which invokes the memory deallocation routine
313created specifically for this Rectangle\_t structure.
314The \emph{asn\_DEF\_Rectangle} is the type descriptor which holds
315a collection of routines and operations defined for the Rectangle\_t structure.
Lev Walkined44bf42010-11-08 02:04:55 -0800316
317The following member functions of the asn\_DEF\_Rectangle type descriptor
318are of interest:
319\begin{description}
320\item [{ber\_decoder}] This is the generic \emph{restartable}%
Lev Walkin288527b2014-10-26 20:12:53 -0700321\footnote{Restartability mean that if the decoder encounters the end of the buffer it may be invoked again with the rest of the
322buffer to continue decoding.}
323BER decoder (Basic Encoding Rules). This decoder would create and/or
Lev Walkin194b2102013-03-28 01:29:06 -0700324fill the target structure for you. See Section~\ref{sub:Decoding-BER}.
Lev Walkined44bf42010-11-08 02:04:55 -0800325\item [{der\_encoder}] This is the generic DER encoder (Distinguished Encoding
326Rules). This encoder will take the target structure and encode it
Lev Walkin194b2102013-03-28 01:29:06 -0700327into a series of bytes. See Section~\ref{sub:Encoding-DER}. NOTE:
Lev Walkined44bf42010-11-08 02:04:55 -0800328DER encoding is a subset of BER. Any BER decoder should be able to
Lev Walkin6a0b3632017-09-13 01:36:47 -0700329handle any DER input.
330\item [{oer\_decoder}] This is the OER (Octet Encoding Rules) decoder.
331\item [{oer\_encoder}] This is the Canonical OER encoder. This encoder
332will take the target structure and encode it into a series of bytes compatible
333with all BASIC-OER and CANONICAL-OER decoders.
334\item [{uper\_decoder}] This is the Unaligned PER decoder.
335\item [{uper\_encoder}] This is the Unaligned Basic PER encoder. This encoder
336will take the target structure and encode it into a series of bytes.
Lev Walkined44bf42010-11-08 02:04:55 -0800337\item [{xer\_decoder}] This is the generic XER decoder. It takes both BASIC-XER
338or CANONICAL-XER encodings and deserializes the data into a local,
Lev Walkin194b2102013-03-28 01:29:06 -0700339machine-dependent representation. See Section~\ref{sub:Decoding-XER}.
Lev Walkined44bf42010-11-08 02:04:55 -0800340\item [{xer\_encoder}] This is the XER encoder (XML Encoding Rules). This
341encoder will take the target structure and represent it as an XML
342(text) document using either BASIC-XER or CANONICAL-XER encoding rules.
Lev Walkin194b2102013-03-28 01:29:06 -0700343See Section~\ref{sub:Encoding-XER}.
Lev Walkin6a0b3632017-09-13 01:36:47 -0700344
Lev Walkined44bf42010-11-08 02:04:55 -0800345\item [{check\_constraints}] Check that the contents of the target structure
346are semantically valid and constrained to appropriate implicit or
Lev Walkin194b2102013-03-28 01:29:06 -0700347explicit subtype constraints. See Section~\ref{sub:Validating-the-target}.
Lev Walkined44bf42010-11-08 02:04:55 -0800348\item [{print\_struct}] This function convert the contents of the passed
349target structure into human readable form. This form is not formal
350and cannot be converted back into the structure, but it may turn out
Lev Walkin194b2102013-03-28 01:29:06 -0700351to be useful for debugging or quick-n-dirty printing. See Section~\ref{sub:Printing-the-target}.
Lev Walkined44bf42010-11-08 02:04:55 -0800352\item [{free\_struct}] This is a generic disposal which frees the target
Lev Walkin194b2102013-03-28 01:29:06 -0700353structure. See Section~\ref{sub:Freeing-the-target}.
Lev Walkined44bf42010-11-08 02:04:55 -0800354\end{description}
355Each of the above function takes the type descriptor (\emph{asn\_DEF\_\ldots{}})
356and the target structure (\emph{rect}, in the above example).
357
Lev Walkin6a0b3632017-09-13 01:36:47 -0700358\subsection{\label{sub:Generic-Encoding}Generic encoders and decoders}
359
360Before we start describing specific encoders and decoders, let's step back
361a little and check out a simple high level way.
362
363The asn1c runtime supplies (see asn\_application.h) two sets of high level functions, \emph{asn\_encode*} and \emph{asn\_decode*}, which take a transfer syntax selector as the argument. The transfer syntax selector is defined as this:
364
365\begin{codesample}[basicstyle=\scriptsize\listingfont]
366/*
367 * A selection of ASN.1 Transfer Syntaxes to use with generalized encoders and decoders.
368 */
369enum asn_transfer_syntax {
370 ATS_INVALID,
371 ATS_NONSTANDARD_PLAINTEXT,
372 ATS_BER,
373 ATS_DER,
374 ATS_CER,
375 ATS_BASIC_OER,
376 ATS_CANONICAL_OER,
377 ATS_UNALIGNED_BASIC_PER,
378 ATS_UNALIGNED_CANONICAL_PER,
379 ATS_BASIC_XER,
380 ATS_CANONICAL_XER,
381};
382\end{codesample}
383
384Using this encoding selector, encoding and decoding becomes very generic:
385
386\noindent{}Encoding:
387
388\begin{codesample}[basicstyle=\scriptsize\listingfont]
389uint8_t buffer[128];
390size_t buf_size = sizeof(buffer);
391asn_enc_rval_t er;
392
393er = %\textbf{asn\_encode\emph{\_to\_buffer}}%(0, %\textbf{ATS\_BER}%, &asn_DEF_Rectangle, buffer, buf_size);
394
395if(er.encoded > buf_size) {
396 fprintf(stderr, "Buffer of size %\%%zu is too small for %\%%s, need %\%%zu\n",
397 buf_size, asn_DEF_Rectangle.name, er.encoded);
398 ASN_STRUCT_FREE(asn_DEF_Rectangle, rect);
399}
400\end{codesample}
401
402\noindent{}Decoding:
403
404\begin{codesample}[basicstyle=\scriptsize\listingfont]
405Rectangle_t *%$\underbracket{\textrm{\listingfont rect = 0}}$%; /* %\textbf{\color{red}Note this 0\footnote{Forgetting to properly initialize the pointer to a destination structure is a major source of support requests.}!}% */
406
407... = %\textbf{asn\_decode}%(0, %\textbf{ATS\_BER}%, &asn_DEF_Rectangle, (void **)%$\underbracket{\textrm{\listingfont \&rect}}$%, buffer, buf_size);
408\end{codesample}
Lev Walkined44bf42010-11-08 02:04:55 -0800409
410\subsection{\label{sub:Decoding-BER}Decoding BER}
411
412The Basic Encoding Rules describe the most widely used (by the ASN.1
413community) way to encode and decode a given structure in a machine-independent
414way. Several other encoding rules (CER, DER) define a more restrictive
415versions of BER, so the generic BER parser is also capable of decoding
Lev Walkin6a0b3632017-09-13 01:36:47 -0700416the data encoded by the CER and DER encoders. The opposite is not true.
Lev Walkined44bf42010-11-08 02:04:55 -0800417
418\emph{The ASN.1 compiler provides the generic BER decoder which is
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700419capable of decoding BER, CER and DER encoded data.}
Lev Walkined44bf42010-11-08 02:04:55 -0800420
421The decoder is restartable (stream-oriented), which means that in
422case the buffer has less data than it is expected, the decoder will
423process whatever there is available and ask for more data to be provided.
424Please note that the decoder may actually process less data than it
425was given in the buffer, which means that you must be able to make
426the next buffer contain the unprocessed part of the previous buffer.
427
428Suppose, you have two buffers of encoded data: 100 bytes and 200 bytes.
429\begin{itemize}
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700430\item You can concatenate these buffers and feed the BER decoder with 300
Lev Walkined44bf42010-11-08 02:04:55 -0800431bytes of data, or
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700432\item You can feed it the first buffer of 100 bytes of data, realize that
Lev Walkined44bf42010-11-08 02:04:55 -0800433the ber\_decoder consumed only 95 bytes from it and later feed the
434decoder with 205 bytes buffer which consists of 5 unprocessed bytes
435from the first buffer and the additional 200 bytes from the second
436buffer.
437\end{itemize}
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700438This is not as convenient as it could be (the BER encoder could
Lev Walkined44bf42010-11-08 02:04:55 -0800439consume the whole 100 bytes and keep these 5 bytes in some temporary
440storage), but in case of existing stream based processing it might
441actually fit well into existing algorithm. Suggestions are welcome.
442
Lev Walkin6a0b3632017-09-13 01:36:47 -0700443Here is the example of BER decoding of a simple structure:
Lev Walkined44bf42010-11-08 02:04:55 -0800444
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700445\begin{codesample}
446Rectangle_t *
447simple_deserializer(const void *buffer, size_t buf_size) {
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700448 asn_dec_rval_t rval;
Lev Walkin194b2102013-03-28 01:29:06 -0700449 Rectangle_t *%$\underbracket{\textrm{\listingfont rect = 0}}$%; /* %\textbf{\color{red}Note this 0\footnote{Forgetting to properly initialize the pointer to a destination structure is a major source of support requests.}!}% */
Lev Walkined44bf42010-11-08 02:04:55 -0800450
Lev Walkin6a0b3632017-09-13 01:36:47 -0700451 rval = %\textbf{asn\_DEF\_Rectangle.op->ber\_decoder}%(0,
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700452 &asn_DEF_Rectangle,
Lev Walkin6a0b3632017-09-13 01:36:47 -0700453 (void **)%$\underbracket{\textrm{\listingfont \&rect}}$%, /* Decoder %\emph{changes}% the pointer */
Lev Walkin194b2102013-03-28 01:29:06 -0700454 buffer, buf_size, 0);
Lev Walkined44bf42010-11-08 02:04:55 -0800455
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700456 if(rval%\textbf{.code}% == RC_OK) {
457 return rect; /* Decoding succeeded */
458 } else {
Lev Walkin6a0b3632017-09-13 01:36:47 -0700459 /* Free the partially decoded rectangle */
Lev Walkin8d99d7b2017-08-25 01:06:00 -0700460 ASN_STRUCT_FREE(asn_DEF_Rectangle, rect);
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700461 return 0;
462 }
463}
464\end{codesample}
Lev Walkin6a0b3632017-09-13 01:36:47 -0700465
Lev Walkined44bf42010-11-08 02:04:55 -0800466The code above defines a function, \emph{simple\_deserializer}, which
467takes a buffer and its length and is expected to return a pointer
468to the Rectangle\_t structure. Inside, it tries to convert the bytes
469passed into the target structure (rect) using the BER decoder and
470returns the rect pointer afterwards. If the structure cannot be deserialized,
471it frees the memory which might be left allocated by the unfinished
472\emph{ber\_decoder} routine and returns 0 (no data). (This \textbf{freeing
473is necessary} because the ber\_decoder is a restartable procedure,
474and may fail just because there is more data needs to be provided
475before decoding could be finalized). The code above obviously does
476not take into account the way the \emph{ber\_decoder()} failed, so
477the freeing is necessary because the part of the buffer may already
478be decoded into the structure by the time something goes wrong.
479
480A little less wordy would be to invoke a globally available \emph{ber\_decode()}
481function instead of dereferencing the asn\_DEF\_Rectangle type descriptor:
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700482\begin{codesample}
483rval = ber_decode(0, &asn_DEF_Rectangle, (void **)&rect, buffer, buf_size);
484\end{codesample}
Lev Walkin6a0b3632017-09-13 01:36:47 -0700485Note that the initial (asn\_DEF\_Rectangle.op->ber\_decoder) reference
Lev Walkined44bf42010-11-08 02:04:55 -0800486is gone, and also the last argument (0) is no longer necessary.
487
488These two ways of BER decoder invocations are fully equivalent.
489
490The BER de\emph{coder} may fail because of (\emph{the following RC\_\ldots{}
491codes are defined in ber\_decoder.h}):
492\begin{itemize}
493\item RC\_WMORE: There is more data expected than it is provided (stream
494mode continuation feature);
495\item RC\_FAIL: General failure to decode the buffer;
496\item \ldots{} other codes may be defined as well.
497\end{itemize}
498Together with the return code (.code) the asn\_dec\_rval\_t type contains
499the number of bytes which is consumed from the buffer. In the previous
500hypothetical example of two buffers (of 100 and 200 bytes), the first
501call to ber\_decode() would return with .code = RC\_WMORE and .consumed
502= 95. The .consumed field of the BER decoder return value is \textbf{always}
503valid, even if the decoder succeeds or fails with any other return
504code.
505
Lev Walkin464166c2010-11-09 08:34:38 -0800506Look into ber\_decoder.h for the precise definition of ber\_decode()
Lev Walkined44bf42010-11-08 02:04:55 -0800507and related types.
508
509
510\subsection{\label{sub:Encoding-DER}Encoding DER}
511
512The Distinguished Encoding Rules is the \emph{canonical} variant of
513BER encoding rules. The DER is best suited to encode the structures
514where all the lengths are known beforehand. This is probably exactly
515how you want to encode: either after a BER decoding or after a manual
516fill-up, the target structure contains the data which size is implicitly
517known before encoding. Among other uses, the DER encoding is used
518to encode X.509 certificates.
519
520As with BER decoder, the DER encoder may be invoked either directly
521from the ASN.1 type descriptor (asn\_DEF\_Rectangle) or from the stand-alone
522function, which is somewhat simpler:
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700523\begin{codesample}
524/*
525 * This is the serializer itself.
526 * It supplies the DER encoder with the
527 * pointer to the custom output function.
528 */
529ssize_t
530simple_serializer(FILE *ostream, Rectangle_t *rect) {
531 asn_enc_rval_t er; /* Encoder return value */
Lev Walkined44bf42010-11-08 02:04:55 -0800532
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700533 er = der_encode(&asn_DEF_Rect, rect, write_stream, ostream);
534 if(er%\textbf{.encoded}% == -1) {
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700535 fprintf(stderr, "Cannot encode %\%%s: %\%%s\n",
536 er%\textbf{.failed\_type}%->name, strerror(errno));
537 return -1;
538 } else {
539 /* Return the number of bytes */
540 return er.encoded;
541 }
542}
543\end{codesample}
Lev Walkined44bf42010-11-08 02:04:55 -0800544As you see, the DER encoder does not write into some sort of buffer
545or something. It just invokes the custom function (possible, multiple
546times) which would save the data into appropriate storage. The optional
547argument \emph{app\_key} is opaque for the DER encoder code and just
548used by \emph{\_write\_stream()} as the pointer to the appropriate
549output stream to be used.
550
551If the custom write function is not given (passed as 0), then the
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700552DER encoder will essentially do the same thing (i.~e., encode the data)
Lev Walkined44bf42010-11-08 02:04:55 -0800553but no callbacks will be invoked (so the data goes nowhere). It may
554prove useful to determine the size of the structure's encoding before
555actually doing the encoding%
556\footnote{It is actually faster too: the encoder might skip over some computations
557which aren't important for the size determination.%
558}.
559
Lev Walkin464166c2010-11-09 08:34:38 -0800560Look into der\_encoder.h for the precise definition of der\_encode()
Lev Walkined44bf42010-11-08 02:04:55 -0800561and related types.
562
563
564\subsection{\label{sub:Encoding-XER}Encoding XER}
565
566The XER stands for XML Encoding Rules, where XML, in turn, is eXtensible
567Markup Language, a text-based format for information exchange. The
568encoder routine API comes in two flavors: stdio-based and callback-based.
569With the callback-based encoder, the encoding process is very similar
Lev Walkin194b2102013-03-28 01:29:06 -0700570to the DER one, described in Section~\ref{sub:Encoding-DER}. The
Lev Walkined44bf42010-11-08 02:04:55 -0800571following example uses the definition of write\_stream() from up there.
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700572\begin{codesample}
573/*
Lev Walkin6a0b3632017-09-13 01:36:47 -0700574 * This procedure generates an XML document
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700575 * by invoking the XER encoder.
576 * NOTE: Do not copy this code verbatim!
577 * If the stdio output is necessary,
578 * use the xer_fprint() procedure instead.
Lev Walkin6a0b3632017-09-13 01:36:47 -0700579 * See Section %\ref{sub:Printing-the-target}%.
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700580 */
Lev Walkined44bf42010-11-08 02:04:55 -0800581int
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700582print_as_XML(FILE *ostream, Rectangle_t *rect) {
583 asn_enc_rval_t er; /* Encoder return value */
Lev Walkined44bf42010-11-08 02:04:55 -0800584
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700585 er = xer_encode(&asn_DEF_Rectangle, rect,
586 XER_F_BASIC, /* BASIC-XER or CANONICAL-XER */
587 write_stream, ostream);
Lev Walkined44bf42010-11-08 02:04:55 -0800588
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700589 return (er.encoded == -1) ? -1 : 0;
590}
591\end{codesample}
Lev Walkin464166c2010-11-09 08:34:38 -0800592Look into xer\_encoder.h for the precise definition of xer\_encode()
Lev Walkined44bf42010-11-08 02:04:55 -0800593and related types.
594
Lev Walkin194b2102013-03-28 01:29:06 -0700595See Section~\ref{sub:Printing-the-target} for the example of stdio-based
Lev Walkined44bf42010-11-08 02:04:55 -0800596XML encoder and other pretty-printing suggestions.
597
598
599\subsection{\label{sub:Decoding-XER}Decoding XER}
600
601The data encoded using the XER rules can be subsequently decoded using
602the xer\_decode() API call:
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700603\begin{codesample}
604Rectangle_t *
605XML_to_Rectangle(const void *buffer, size_t buf_size) {
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700606 asn_dec_rval_t rval;
Lev Walkin194b2102013-03-28 01:29:06 -0700607 Rectangle_t *%$\underbracket{\textrm{\listingfont rect = 0}}$%; /* %\textbf{\color{red}Note this 0\footnote{Forgetting to properly initialize the pointer to a destination structure is a major source of support requests.}!}% */
Lev Walkined44bf42010-11-08 02:04:55 -0800608
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700609 rval = xer_decode(0, &asn_DEF_Rectangle, (void **)&rect, buffer, buf_size);
Lev Walkined44bf42010-11-08 02:04:55 -0800610
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700611 if(rval%\textbf{.code}% == RC_OK) {
612 return rect; /* Decoding succeeded */
613 } else {
614 /* Free partially decoded rect */
Lev Walkin8d99d7b2017-08-25 01:06:00 -0700615 ASN_STRUCT_FREE(asn_DEF_Rectangle, rect);
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700616 return 0;
617 }
618}
619\end{codesample}
Lev Walkined44bf42010-11-08 02:04:55 -0800620The decoder takes both BASIC-XER and CANONICAL-XER encodings.
621
622The decoder shares its data consumption properties with BER decoder;
Lev Walkin194b2102013-03-28 01:29:06 -0700623please read the Section~\ref{sub:Decoding-BER} to know more.
Lev Walkined44bf42010-11-08 02:04:55 -0800624
Lev Walkin464166c2010-11-09 08:34:38 -0800625Look into xer\_decoder.h for the precise definition of xer\_decode()
Lev Walkined44bf42010-11-08 02:04:55 -0800626and related types.
627
628
629\subsection{\label{sub:Validating-the-target}Validating the target structure}
630
631Sometimes the target structure needs to be validated. For example,
632if the structure was created by the application (as opposed to being
633decoded from some external source), some important information required
634by the ASN.1 specification might be missing. On the other hand, the
635successful decoding of the data from some external source does not
636necessarily mean that the data is fully valid either. It might well
637be the case that the specification describes some subtype constraints
638that were not taken into account during decoding, and it would actually
639be useful to perform the last check when the data is ready to be encoded
640or when the data has just been decoded to ensure its validity according
641to some stricter rules.
642
643The asn\_check\_constraints() function checks the type for various
644implicit and explicit constraints. It is recommended to use asn\_check\_constraints()
645function after each decoding and before each encoding.
646
Lev Walkin464166c2010-11-09 08:34:38 -0800647Look into constraints.h for the precise definition of asn\_check\_constraints()
Lev Walkined44bf42010-11-08 02:04:55 -0800648and related types.
649
650
651\subsection{\label{sub:Printing-the-target}Printing the target structure}
652
653There are two ways to print the target structure: either invoke the
654print\_struct member of the ASN.1 type descriptor, or using the asn\_fprint()
655function, which is a simpler wrapper of the former:
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700656\begin{codesample}
657asn_fprint(stdout, &asn_DEF_Rectangle, rect);
658\end{codesample}
Lev Walkin464166c2010-11-09 08:34:38 -0800659Look into constr\_TYPE.h for the precise definition of asn\_fprint()
Lev Walkined44bf42010-11-08 02:04:55 -0800660and related types.
661
662Another practical alternative to this custom format printing would
663be to invoke XER encoder. The default BASIC-XER encoder performs reasonable
664formatting for the output to be useful and human readable. To invoke
665the XER decoder in a manner similar to asn\_fprint(), use the xer\_fprint()
666call:
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700667\begin{codesample}
668xer_fprint(stdout, &asn_DEF_Rectangle, rect);
669\end{codesample}
Lev Walkin194b2102013-03-28 01:29:06 -0700670See Section~\ref{sub:Encoding-XER} for XML-related details.
Lev Walkined44bf42010-11-08 02:04:55 -0800671
672
673\subsection{\label{sub:Freeing-the-target}Freeing the target structure}
674
675Freeing the structure is slightly more complex than it may seem to.
676When the ASN.1 structure is freed, all the members of the structure
677and their submembers are recursively freed as well. But it might not
678be feasible to free the structure itself. Consider the following case:
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700679\begin{codesample}
680struct my_figure { /* The custom structure */
681 int flags; /* <some custom member> */
682 /* The type is generated by the ASN.1 compiler */
683 Rectangle_t rect;
684 /* other members of the structure */
685};
686\end{codesample}
Lev Walkin8d99d7b2017-08-25 01:06:00 -0700687In this example, the application programmer defines a custom structure
Lev Walkined44bf42010-11-08 02:04:55 -0800688with one ASN.1-derived member (rect). This member is not a reference
689to the Rectangle\_t, but an in-place inclusion of the Rectangle\_t
690structure. If the freeing is necessary, the usual procedure of freeing
691everything must not be applied to the \&rect pointer itself, because
692it does not point to the memory block directly allocated by the memory
693allocation routine, but instead lies within a block allocated for
694the my\_figure structure.
695
Lev Walkin8d99d7b2017-08-25 01:06:00 -0700696To solve this problem, in addition to ASN\_STRUCT\_FREE macro, the asn1c
697skeletons define the ASN\_STRUCT\_RESET macro which doesn't free the passed
698pointer and instead resets the structure into the clean and safe state.
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700699\begin{codesample}
700/* %\textbf{1. Rectangle\_t is defined within my\_figure}% */
701struct my_figure {
702 Rectangle_t rect;
703} *mf = ...;
704/*
705 * Freeing the Rectangle_t
706 * without freeing the mf->rect area.
707 */
Lev Walkin8d99d7b2017-08-25 01:06:00 -0700708ASN_STRUCT_RESET(asn_DEF_Rectangle, &mf->rect);
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700709
710/* %\textbf{2. Rectangle\_t is a stand-alone pointer}% */
711Rectangle_t *rect = ...;
712/*
713 * Freeing the Rectangle_t
714 * and freeing the rect pointer.
715 */
Lev Walkin6a0b3632017-09-13 01:36:47 -0700716ASN_STRUCT_FREE(asn_DEF_Rectangle, rect);
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700717\end{codesample}
Lev Walkin8d99d7b2017-08-25 01:06:00 -0700718It is safe to invoke both macros with the target structure pointer
719set to 0 (NULL). In this case, the function will do nothing.
Lev Walkined44bf42010-11-08 02:04:55 -0800720
721\chapter{\label{cha:Step-by-step-examples}Step by step examples}
722
723
Lev Walkin464166c2010-11-09 08:34:38 -0800724\section{A ``Rectangle'' Encoder}
Lev Walkined44bf42010-11-08 02:04:55 -0800725
726This example will help you create a simple BER and XER encoder of
Lev Walkin464166c2010-11-09 08:34:38 -0800727a ``Rectangle'' type used throughout this document.
Lev Walkined44bf42010-11-08 02:04:55 -0800728\begin{enumerate}
729\item Create a file named \textbf{rectangle.asn1} with the following contents:
730
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700731\begin{asn}
732RectangleModule1 DEFINITIONS ::= BEGIN
Lev Walkined44bf42010-11-08 02:04:55 -0800733
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700734Rectangle ::= SEQUENCE {
735 height INTEGER,
736 width INTEGER
737}
Lev Walkined44bf42010-11-08 02:04:55 -0800738
739END
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700740\end{asn}
Lev Walkined44bf42010-11-08 02:04:55 -0800741\item Compile it into the set of .c and .h files using asn1c compiler \cite{ASN1C}:
742
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700743\begin{bash}
Lev Walkin2a744a72013-03-27 01:56:23 -0700744asn1c %\textbf{rectangle.asn1}%
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700745\end{bash}
Lev Walkined44bf42010-11-08 02:04:55 -0800746\item Alternatively, use the Online ASN.1 compiler \cite{AONL} by uploading
747the \textbf{rectangle.asn1} file into the Web form and unpacking the
748produced archive on your computer.
749\item By this time, you should have gotten multiple files in the current
750directory, including the \textbf{Rectangle.c} and \textbf{Rectangle.h}.
751\item Create a main() routine which creates the Rectangle\_t structure in
752memory and encodes it using BER and XER encoding rules. Let's name
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700753the file \textbf{main.c}:
Lev Walkined44bf42010-11-08 02:04:55 -0800754
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700755\begin{codesample}[basicstyle=\scriptsize\listingfont]
756#include <stdio.h>
757#include <sys/types.h>
758#include <Rectangle.h> /* Rectangle ASN.1 type */
Lev Walkined44bf42010-11-08 02:04:55 -0800759
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700760/* Write the encoded output into some FILE stream. */
761static int write_out(const void *buffer, size_t size, void *app_key) {
762 FILE *out_fp = app_key;
763 size_t wrote = fwrite(buffer, 1, size, out_fp);
764 return (wrote == size) ? 0 : -1;
765}
766
767int main(int ac, char **av) {
768 Rectangle_t *rectangle; /* Type to encode */
769 asn_enc_rval_t ec; /* Encoder return value */
Lev Walkined44bf42010-11-08 02:04:55 -0800770
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700771 /* Allocate the Rectangle_t */
772 rectangle = calloc(1, sizeof(Rectangle_t)); /* not malloc! */
773 if(!rectangle) {
774 perror("calloc() failed");
775 exit(1);
776 }
Lev Walkined44bf42010-11-08 02:04:55 -0800777
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700778 /* Initialize the Rectangle members */
779 rectangle->height = 42; /* any random value */
780 rectangle->width = 23; /* any random value */
Lev Walkined44bf42010-11-08 02:04:55 -0800781
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700782 /* BER encode the data if filename is given */
783 if(ac < 2) {
784 fprintf(stderr, "Specify filename for BER output\n");
785 } else {
786 const char *filename = av[1];
787 FILE *fp = fopen(filename, "wb"); /* for BER output */
788
789 if(!fp) {
790 perror(filename);
791 exit(1);
792 }
Lev Walkined44bf42010-11-08 02:04:55 -0800793
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700794 /* Encode the Rectangle type as BER (DER) */
795 ec = der_encode(&asn_DEF_Rectangle, rectangle, write_out, fp);
796 fclose(fp);
797 if(ec.encoded == -1) {
798 fprintf(stderr, "Could not encode Rectangle (at %\%%s)\n",
799 ec.failed_type ? ec.failed_type->name : "unknown");
800 exit(1);
801 } else {
802 fprintf(stderr, "Created %\%%s with BER encoded Rectangle\n", filename);
803 }
804 }
Lev Walkined44bf42010-11-08 02:04:55 -0800805
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700806 /* Also print the constructed Rectangle XER encoded (XML) */
807 xer_fprint(stdout, &asn_DEF_Rectangle, rectangle);
Lev Walkined44bf42010-11-08 02:04:55 -0800808
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700809 return 0; /* Encoding finished successfully */
810 }
811\end{codesample}
Lev Walkined44bf42010-11-08 02:04:55 -0800812\item Compile all files together using C compiler (varies by platform):
813
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700814\begin{bash}
815cc -I. -o %\textbf{\emph{rencode}} \emph{*.c}%
816\end{bash}
Lev Walkined44bf42010-11-08 02:04:55 -0800817\item Voila! You have just created the BER and XER encoder of a Rectangle
818type, named \textbf{rencode}!
819\end{enumerate}
Lev Walkined44bf42010-11-08 02:04:55 -0800820
Lev Walkin464166c2010-11-09 08:34:38 -0800821\section{\label{sec:A-Rectangle-Decoder}A ``Rectangle'' Decoder}
Lev Walkined44bf42010-11-08 02:04:55 -0800822
823This example will help you to create a simple BER decoder of a simple
Lev Walkin464166c2010-11-09 08:34:38 -0800824``Rectangle'' type used throughout this document.
Lev Walkined44bf42010-11-08 02:04:55 -0800825\begin{enumerate}
826\item Create a file named \textbf{rectangle.asn1} with the following contents:
827
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700828\begin{asn}
829RectangleModule1 DEFINITIONS ::= BEGIN
Lev Walkined44bf42010-11-08 02:04:55 -0800830
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700831Rectangle ::= SEQUENCE {
832 height INTEGER,
833 width INTEGER
834}
Lev Walkined44bf42010-11-08 02:04:55 -0800835
836END
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700837\end{asn}
Lev Walkined44bf42010-11-08 02:04:55 -0800838\item Compile it into the set of .c and .h files using asn1c compiler \cite{ASN1C}:
839
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700840\begin{bash}
Lev Walkin2a744a72013-03-27 01:56:23 -0700841asn1c %\textbf{rectangle.asn1}%
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700842\end{bash}
Lev Walkined44bf42010-11-08 02:04:55 -0800843\item Alternatively, use the Online ASN.1 compiler \cite{AONL} by uploading
844the \textbf{rectangle.asn1} file into the Web form and unpacking the
845produced archive on your computer.
846\item By this time, you should have gotten multiple files in the current
847directory, including the \textbf{Rectangle.c} and \textbf{Rectangle.h}.
848\item Create a main() routine which takes the binary input file, decodes
849it as it were a BER-encoded Rectangle type, and prints out the text
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700850(XML) representation of the Rectangle type. Let's name the file \textbf{main.c}:
Lev Walkined44bf42010-11-08 02:04:55 -0800851
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700852\begin{codesample}[basicstyle=\scriptsize\listingfont]
853#include <stdio.h>
854#include <sys/types.h>
855#include <Rectangle.h> /* Rectangle ASN.1 type */
Lev Walkined44bf42010-11-08 02:04:55 -0800856
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700857int main(int ac, char **av) {
858 char buf[1024]; /* Temporary buffer */
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700859 asn_dec_rval_t rval; /* Decoder return value */
Lev Walkin194b2102013-03-28 01:29:06 -0700860 Rectangle_t *%$\underbracket{\textrm{\listingfont rectangle = 0}}$%; /* Type to decode. %\textbf{\color{red}Note this 0\footnote{Forgetting to properly initialize the pointer to a destination structure is a major source of support requests.}!}% */
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700861 FILE *fp; /* Input file handler */
862 size_t size; /* Number of bytes read */
863 char *filename; /* Input file name */
Lev Walkined44bf42010-11-08 02:04:55 -0800864
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700865 /* Require a single filename argument */
866 if(ac != 2) {
867 fprintf(stderr, "Usage: %\%%s <file.ber>\n", av[0]);
868 exit(1);
869 } else {
870 filename = av[1];
871 }
Lev Walkined44bf42010-11-08 02:04:55 -0800872
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700873 /* Open input file as read-only binary */
874 fp = fopen(filename, "rb");
875 if(!fp) {
876 perror(filename);
877 exit(1);
878 }
Lev Walkined44bf42010-11-08 02:04:55 -0800879
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700880 /* Read up to the buffer size */
881 size = fread(buf, 1, sizeof(buf), fp);
882 fclose(fp);
883 if(!size) {
884 fprintf(stderr, "%\%%s: Empty or broken\n", filename);
885 exit(1);
886 }
Lev Walkined44bf42010-11-08 02:04:55 -0800887
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700888 /* Decode the input buffer as Rectangle type */
889 rval = ber_decode(0, &asn_DEF_Rectangle, (void **)&rectangle, buf, size);
890 if(rval.code != RC_OK) {
891 fprintf(stderr, "%\%%s: Broken Rectangle encoding at byte %\%%ld\n", filename, (long)rval.consumed);
892 exit(1);
893 }
Lev Walkined44bf42010-11-08 02:04:55 -0800894
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700895 /* Print the decoded Rectangle type as XML */
896 xer_fprint(stdout, &asn_DEF_Rectangle, rectangle);
Lev Walkined44bf42010-11-08 02:04:55 -0800897
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700898 return 0; /* Decoding finished successfully */
Lev Walkin194b2102013-03-28 01:29:06 -0700899}
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700900\end{codesample}
Lev Walkined44bf42010-11-08 02:04:55 -0800901\item Compile all files together using C compiler (varies by platform):
902
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700903\begin{bash}
904cc -I. -o %\textbf{\emph{rdecode}} \emph{*.c}%
905\end{bash}
Lev Walkined44bf42010-11-08 02:04:55 -0800906\item Voila! You have just created the BER decoder of a Rectangle type,
907named \textbf{rdecode}!
908\end{enumerate}
909
910\chapter{Constraint validation examples}
911
912This chapter shows how to define ASN.1 constraints and use the generated
913validation code.
914
915
Lev Walkin464166c2010-11-09 08:34:38 -0800916\section{Adding constraints into ``Rectangle'' type}
Lev Walkined44bf42010-11-08 02:04:55 -0800917
918This example shows how to add basic constraints to the ASN.1 specification
919and how to invoke the constraints validation code in your application.
920\begin{enumerate}
921\item Create a file named \textbf{rectangle.asn1} with the following contents:
922
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700923\begin{asn}
924RectangleModuleWithConstraints DEFINITIONS ::= BEGIN
Lev Walkined44bf42010-11-08 02:04:55 -0800925
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700926Rectangle ::= SEQUENCE {
927 height INTEGER (0..100), -- Value range constraint
928 width INTEGER (0..MAX) -- Makes width non-negative
929}
Lev Walkined44bf42010-11-08 02:04:55 -0800930
931END
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700932\end{asn}
Lev Walkined44bf42010-11-08 02:04:55 -0800933\item Compile the file according to procedures shown in the previous chapter.
934\item Modify the Rectangle type processing routine (you can start with the
Lev Walkin194b2102013-03-28 01:29:06 -0700935main() routine shown in the Section~\ref{sec:A-Rectangle-Decoder})
Lev Walkined44bf42010-11-08 02:04:55 -0800936by placing the following snippet of code \emph{before} encoding and/or
937\emph{after} decoding the Rectangle type%
Lev Walkin2e554fc2014-10-26 19:21:58 -0700938\footnote{Placing the constraint checking code \emph{before encoding} helps
939to make sure the data is correct and within constraints before
Lev Walkined44bf42010-11-08 02:04:55 -0800940sharing the data with anyone else.
Lev Walkin2e554fc2014-10-26 19:21:58 -0700941Placing the constraint checking code \emph{after decoding} helps to make sure
Lev Walkined44bf42010-11-08 02:04:55 -0800942the application got the valid contents before making use of it.%
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700943}:
Lev Walkined44bf42010-11-08 02:04:55 -0800944
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700945\begin{codesample}
946int ret; /* Return value */
947char errbuf[128]; /* Buffer for error message */
948size_t errlen = sizeof(errbuf); /* Size of the buffer */
Lev Walkined44bf42010-11-08 02:04:55 -0800949
Lev Walkin2e554fc2014-10-26 19:21:58 -0700950/* ... here goes the Rectangle %\emph{decoding}% code ... */
Lev Walkined44bf42010-11-08 02:04:55 -0800951
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700952ret = asn_check_constraints(&asn_DEF_Rectangle, rectangle, errbuf, &errlen);
953/* assert(errlen < sizeof(errbuf)); // you may rely on that */
954if(ret) {
955 fprintf(stderr, "Constraint validation failed: %\%%s\n",
956 errbuf /* errbuf is properly nul-terminated */
957 );
958 /* exit(...); // Replace with appropriate action */
959 }
Lev Walkined44bf42010-11-08 02:04:55 -0800960
Lev Walkin2e554fc2014-10-26 19:21:58 -0700961/* ... here goes the Rectangle %\emph{encoding}% code ... */
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700962\end{codesample}
Lev Walkined44bf42010-11-08 02:04:55 -0800963\item Compile the resulting C code as shown in the previous chapters.
964\item Try to test the constraints checking code by assigning integer value
965101 to the \textbf{.height} member of the Rectangle structure, or
966a negative value to the \textbf{.width} member. In either case, the
Lev Walkin464166c2010-11-09 08:34:38 -0800967program should print ``Constraint validation failed'' message, followed
Lev Walkin11c9a8c2013-03-26 00:46:55 -0700968by a short explanation why validation did not succeed.
Lev Walkined44bf42010-11-08 02:04:55 -0800969\item Done.
970\end{enumerate}
971
972\part{\label{par:ASN.1-Basics}ASN.1 Basics}
973
974
975\chapter{\label{cha:Abstract-Syntax-Notation:}Abstract Syntax Notation: ASN.1}
976
977\emph{This chapter defines some basic ASN.1 concepts and describes
978several most widely used types. It is by no means an authoritative
979or complete reference. For more complete ASN.1 description, please
980refer to Olivier Dubuisson's book \cite{Dub00} or the ASN.1 body
981of standards itself \cite{ITU-T/ASN.1}.}
982
983The Abstract Syntax Notation One is used to formally describe the
Lev Walkin507f6002014-10-26 20:22:16 -0700984data transmitted across the network. Two communicating parties may employ
985different formats of their native data types (e.~g., different number
986of bits for the native integer type), thus it is important to have
Lev Walkined44bf42010-11-08 02:04:55 -0800987a way to describe the data in a manner which is independent from the
Lev Walkin507f6002014-10-26 20:22:16 -0700988particular machine's representation.
989The ASN.1 specifications are used to achieve the following:
Lev Walkined44bf42010-11-08 02:04:55 -0800990\begin{itemize}
991\item The specification expressed in the ASN.1 notation is a formal and
Lev Walkin507f6002014-10-26 20:22:16 -0700992precise way to communicate the structure of data to human readers;
Lev Walkined44bf42010-11-08 02:04:55 -0800993\item The ASN.1 specifications may be used as input for automatic compilers
994which produce the code for some target language (C, C++, Java, etc)
Lev Walkin507f6002014-10-26 20:22:16 -0700995to encode and decode the data according to some encoding formats.
996Several such encoding formats (called Transfer Encoding Rules)
997have been defined by the ASN.1 standard.
Lev Walkined44bf42010-11-08 02:04:55 -0800998\end{itemize}
999Consider the following example:
Lev Walkin11c9a8c2013-03-26 00:46:55 -07001000\begin{asn}
1001Rectangle ::= SEQUENCE {
1002 height INTEGER,
1003 width INTEGER
1004}
1005\end{asn}
Lev Walkined44bf42010-11-08 02:04:55 -08001006This ASN.1 specification describes a constructed type, \emph{Rectangle},
1007containing two integer fields. This specification may tell the reader
1008that there exists this kind of data structure and that some entity
1009may be prepared to send or receive it. The question on \emph{how}
1010that entity is going to send or receive the \emph{encoded data} is
1011outside the scope of ASN.1. For example, this data structure may be
1012encoded according to some encoding rules and sent to the destination
1013using the TCP protocol. The ASN.1 specifies several ways of encoding
Lev Walkin464166c2010-11-09 08:34:38 -08001014(or ``serializing'', or ``marshaling'') the data: BER, PER, XER
Lev Walkined44bf42010-11-08 02:04:55 -08001015and others, including CER and DER derivatives from BER.
1016
1017The complete specification must be wrapped in a module, which looks
1018like this:
Lev Walkin11c9a8c2013-03-26 00:46:55 -07001019\begin{asn}
Lev Walkined44bf42010-11-08 02:04:55 -08001020RectangleModule1
Lev Walkin11c9a8c2013-03-26 00:46:55 -07001021 { iso org(3) dod(6) internet(1) private(4)
1022 enterprise(1) spelio(9363) software(1)
1023 asn1c(5) docs(2) rectangle(1) 1 }
1024 DEFINITIONS AUTOMATIC TAGS ::=
Lev Walkined44bf42010-11-08 02:04:55 -08001025BEGIN
1026
Lev Walkin11c9a8c2013-03-26 00:46:55 -07001027-- This is a comment which describes nothing.
1028Rectangle ::= SEQUENCE {
1029 height INTEGER, -- Height of the rectangle
1030 width INTEGER -- Width of the rectangle
1031}
Lev Walkined44bf42010-11-08 02:04:55 -08001032
1033END
Lev Walkin11c9a8c2013-03-26 00:46:55 -07001034\end{asn}
Lev Walkined44bf42010-11-08 02:04:55 -08001035The module header consists of module name (RectangleModule1), the
Lev Walkin464166c2010-11-09 08:34:38 -08001036module object identifier (\{...\}), a keyword ``DEFINITIONS'', a
1037set of module flags (AUTOMATIC TAGS) and ``::= BEGIN''. The module
1038ends with an ``END'' statement.
Lev Walkined44bf42010-11-08 02:04:55 -08001039
1040
1041\section{Some of the ASN.1 Basic Types}
1042
1043
1044\subsection{The BOOLEAN type}
1045
1046The BOOLEAN type models the simple binary TRUE/FALSE, YES/NO, ON/OFF
1047or a similar kind of two-way choice.
1048
1049
1050\subsection{The INTEGER type}
1051
1052The INTEGER type is a signed natural number type without any restrictions
1053on its size. If the automatic checking on INTEGER value bounds are
1054necessary, the subtype constraints must be used.
Lev Walkin11c9a8c2013-03-26 00:46:55 -07001055\begin{asn}
1056SimpleInteger ::= INTEGER
Lev Walkined44bf42010-11-08 02:04:55 -08001057
Lev Walkin11c9a8c2013-03-26 00:46:55 -07001058-- An integer with a very limited range
1059SmallPositiveInt ::= INTEGER (0..127)
Lev Walkined44bf42010-11-08 02:04:55 -08001060
Lev Walkin11c9a8c2013-03-26 00:46:55 -07001061-- Integer, negative
1062NegativeInt ::= INTEGER (MIN..0)
1063\end{asn}
Lev Walkined44bf42010-11-08 02:04:55 -08001064
1065\subsection{The ENUMERATED type}
1066
1067The ENUMERATED type is semantically equivalent to the INTEGER type
1068with some integer values explicitly named.
Lev Walkin11c9a8c2013-03-26 00:46:55 -07001069\begin{asn}
1070FruitId ::= ENUMERATED { apple(1), orange(2) }
Lev Walkined44bf42010-11-08 02:04:55 -08001071
Lev Walkin11c9a8c2013-03-26 00:46:55 -07001072-- The numbers in braces are optional,
1073-- the enumeration can be performed
1074-- automatically by the compiler
1075ComputerOSType ::= ENUMERATED {
1076 FreeBSD, -- acquires value 0
1077 Windows, -- acquires value 1
1078 Solaris(5), -- remains 5
1079 Linux, -- becomes 6
1080 MacOS -- becomes 7
1081}
1082\end{asn}
Lev Walkined44bf42010-11-08 02:04:55 -08001083
1084\subsection{The OCTET STRING type}
1085
1086This type models the sequence of 8-bit bytes. This may be used to
1087transmit some opaque data or data serialized by other types of encoders
Lev Walkin507f6002014-10-26 20:22:16 -07001088(e.~g., video file, photo picture, etc).
Lev Walkined44bf42010-11-08 02:04:55 -08001089
1090\subsection{The OBJECT IDENTIFIER type}
1091
1092The OBJECT IDENTIFIER is used to represent the unique identifier of
1093any object, starting from the very root of the registration tree.
1094If your organization needs to uniquely identify something (a router,
1095a room, a person, a standard, or whatever), you are encouraged to
1096get your own identification subtree at \url{http://www.iana.org/protocols/forms.htm}.
1097
1098For example, the very first ASN.1 module in this Chapter (RectangleModule1)
1099has the following OBJECT IDENTIFIER: 1 3 6 1 4 1 9363 1 5 2 1 1.
Lev Walkin11c9a8c2013-03-26 00:46:55 -07001100\begin{asn}
1101ExampleOID ::= OBJECT IDENTIFIER
Lev Walkined44bf42010-11-08 02:04:55 -08001102
Lev Walkin11c9a8c2013-03-26 00:46:55 -07001103rectangleModule1-oid ExampleOID
1104 ::= { 1 3 6 1 4 1 9363 1 5 2 1 1 }
Lev Walkined44bf42010-11-08 02:04:55 -08001105
Lev Walkin11c9a8c2013-03-26 00:46:55 -07001106-- An identifier of the Internet.
1107internet-id OBJECT IDENTIFIER
1108 ::= { iso(1) identified-organization(3)
1109 dod(6) internet(1) }
1110\end{asn}
Lev Walkined44bf42010-11-08 02:04:55 -08001111As you see, names are optional.
1112
1113
1114\subsection{The RELATIVE-OID type}
1115
1116The RELATIVE-OID type has the semantics of a subtree of an OBJECT
1117IDENTIFIER. There may be no need to repeat the whole sequence of numbers
1118from the root of the registration tree where the only thing of interest
1119is some of the tree's subsequence.
Lev Walkin11c9a8c2013-03-26 00:46:55 -07001120\begin{asn}
1121this-document RELATIVE-OID ::= { docs(2) usage(1) }
Lev Walkined44bf42010-11-08 02:04:55 -08001122
Lev Walkin11c9a8c2013-03-26 00:46:55 -07001123this-example RELATIVE-OID ::= {
1124 this-document assorted-examples(0) this-example(1) }
1125\end{asn}
Lev Walkined44bf42010-11-08 02:04:55 -08001126
1127\section{Some of the ASN.1 String Types}
1128
1129
1130\subsection{The IA5String type}
1131
1132This is essentially the ASCII, with 128 character codes available
1133(7 lower bits of an 8-bit byte).
1134
1135
1136\subsection{The UTF8String type}
1137
1138This is the character string which encodes the full Unicode range
1139(4 bytes) using multibyte character sequences.
1140
1141
1142\subsection{The NumericString type}
1143
1144This type represents the character string with the alphabet consisting
Lev Walkin464166c2010-11-09 08:34:38 -08001145of numbers (``0'' to ``9'') and a space.
Lev Walkined44bf42010-11-08 02:04:55 -08001146
1147
1148\subsection{The PrintableString type}
1149
Lev Walkin464166c2010-11-09 08:34:38 -08001150The character string with the following alphabet: space, ``\textbf{'}''
1151(single quote), ``\textbf{(}'', ``\textbf{)}'', ``\textbf{+}'',
1152``\textbf{,}'' (comma), ``\textbf{-}'', ``\textbf{.}'', ``\textbf{/}'',
1153digits (``0'' to ``9''), ``\textbf{:}'', ``\textbf{=}'', ``\textbf{?}'',
1154upper-case and lower-case letters (``A'' to ``Z'' and ``a''
1155to ``z'').
Lev Walkined44bf42010-11-08 02:04:55 -08001156
1157
1158\subsection{The VisibleString type}
1159
1160The character string with the alphabet which is more or less a subset
Lev Walkin464166c2010-11-09 08:34:38 -08001161of ASCII between the space and the ``\textbf{\textasciitilde{}}''
Lev Walkined44bf42010-11-08 02:04:55 -08001162symbol (tilde).
1163
1164Alternatively, the alphabet may be described as the PrintableString
Lev Walkin464166c2010-11-09 08:34:38 -08001165alphabet presented earlier, plus the following characters: ``\textbf{!}'',
1166``\textbf{``}'', ``\textbf{\#}'', ``\textbf{\$}'', ``\textbf{\%}'',
Lev Walkin11c9a8c2013-03-26 00:46:55 -07001167``\textbf{\&}'', ``\textbf{*}'', ``\textbf{;}'', ``\textbf{<}'',
Lev Walkin464166c2010-11-09 08:34:38 -08001168``\textbf{>}'', ``\textbf{{[}}'', ``\textbf{\textbackslash{}}'',
1169``\textbf{{]}}'', ``\textbf{\textasciicircum{}}'', ``\textbf{\_}'',
1170``\textbf{`}`` (single left quote), ``\textbf{\{}'', ``\textbf{|}'',
1171``\textbf{\}}'', ``\textbf{\textasciitilde{}}''.
Lev Walkined44bf42010-11-08 02:04:55 -08001172
1173
1174\section{ASN.1 Constructed Types}
1175
1176
1177\subsection{The SEQUENCE type}
1178
1179This is an ordered collection of other simple or constructed types.
Lev Walkin464166c2010-11-09 08:34:38 -08001180The SEQUENCE constructed type resembles the C ``struct'' statement.
Lev Walkin11c9a8c2013-03-26 00:46:55 -07001181\begin{asn}
1182Address ::= SEQUENCE {
1183 -- The apartment number may be omitted
1184 apartmentNumber NumericString OPTIONAL,
1185 streetName PrintableString,
1186 cityName PrintableString,
1187 stateName PrintableString,
1188 -- This one may be omitted too
1189 zipNo NumericString OPTIONAL
1190}
1191\end{asn}
Lev Walkined44bf42010-11-08 02:04:55 -08001192
1193\subsection{The SET type}
1194
1195This is a collection of other simple or constructed types. Ordering
1196is not important. The data may arrive in the order which is different
1197from the order of specification. Data is encoded in the order not
1198necessarily corresponding to the order of specification.
1199
1200
1201\subsection{The CHOICE type}
1202
1203This type is just a choice between the subtypes specified in it. The
1204CHOICE type contains at most one of the subtypes specified, and it
1205is always implicitly known which choice is being decoded or encoded.
Lev Walkin464166c2010-11-09 08:34:38 -08001206This one resembles the C ``union'' statement.
Lev Walkined44bf42010-11-08 02:04:55 -08001207
1208The following type defines a response code, which may be either an
Lev Walkin464166c2010-11-09 08:34:38 -08001209integer code or a boolean ``true''/``false'' code.
Lev Walkin11c9a8c2013-03-26 00:46:55 -07001210\begin{asn}
1211ResponseCode ::= CHOICE {
1212 intCode INTEGER,
1213 boolCode BOOLEAN
1214}
1215\end{asn}
Lev Walkined44bf42010-11-08 02:04:55 -08001216
1217\subsection{The SEQUENCE OF type}
1218
1219This one is the list (array) of simple or constructed types:
Lev Walkin11c9a8c2013-03-26 00:46:55 -07001220\begin{asn}
1221-- Example 1
1222ManyIntegers ::= SEQUENCE OF INTEGER
Lev Walkined44bf42010-11-08 02:04:55 -08001223
Lev Walkin11c9a8c2013-03-26 00:46:55 -07001224-- Example 2
1225ManyRectangles ::= SEQUENCE OF Rectangle
Lev Walkined44bf42010-11-08 02:04:55 -08001226
Lev Walkin11c9a8c2013-03-26 00:46:55 -07001227-- More complex example:
1228-- an array of structures defined in place.
1229ManyCircles ::= SEQUENCE OF SEQUENCE {
1230 radius INTEGER
1231 }
1232\end{asn}
Lev Walkined44bf42010-11-08 02:04:55 -08001233
1234\subsection{The SET OF type}
1235
1236The SET OF type models the bag of structures. It resembles the SEQUENCE
Lev Walkin507f6002014-10-26 20:22:16 -07001237OF type, but the order is not important. The elements may arrive
Lev Walkined44bf42010-11-08 02:04:55 -08001238in the order which is not necessarily the same as the in-memory order
1239on the remote machines.
Lev Walkin11c9a8c2013-03-26 00:46:55 -07001240\begin{asn}
1241-- A set of structures defined elsewhere
1242SetOfApples :: SET OF Apple
Lev Walkined44bf42010-11-08 02:04:55 -08001243
Lev Walkin11c9a8c2013-03-26 00:46:55 -07001244-- Set of integers encoding the kind of a fruit
1245FruitBag ::= SET OF ENUMERATED { apple, orange }
1246\end{asn}
Lev Walkined44bf42010-11-08 02:04:55 -08001247\begin{thebibliography}{ITU-T/ASN.1}
1248\bibitem[ASN1C]{ASN1C}The Open Source ASN.1 Compiler. \url{http://lionet.info/asn1c}
1249
1250\bibitem[AONL]{AONL}Online ASN.1 Compiler. \url{http://lionet.info/asn1c/asn1c.cgi}
1251
1252\bibitem[Dub00]{Dub00}Olivier Dubuisson --- \emph{ASN.1 Communication
Lev Walkin11c9a8c2013-03-26 00:46:55 -07001253between heterogeneous systems} --- Morgan Kaufmann Publishers, 2000.
Lev Walkined44bf42010-11-08 02:04:55 -08001254\url{http://asn1.elibel.tm.fr/en/book/}. ISBN:0-12-6333361-0.
1255
Lev Walkin464166c2010-11-09 08:34:38 -08001256\bibitem[ITU-T/ASN.1]{ITU-T/ASN.1}ITU-T Study Group 17 --- Languages
Lev Walkined44bf42010-11-08 02:04:55 -08001257for Telecommunication Systems \url{http://www.itu.int/ITU-T/studygroups/com17/languages/}
1258\end{thebibliography}
1259
1260\end{document}