Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
A
asn1c
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Libraries
asn1c
Commits
79a75f24
Commit
79a75f24
authored
Jan 23, 2016
by
Lev Walkin
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
update README
parent
36b913f7
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
33 additions
and
20 deletions
+33
-20
README.md
README.md
+33
-20
No files found.
README.md
View file @
79a75f24
# About
# Installation
ASN.1 to C compiler takes the ASN.1 module files (example) and generates
the C++ compatible C source code. That code can be used to serialize
the native C structures into compact and unambiguous BER/XER/PER-based
data files, and deserialize the files back.
Various ASN.1 based formats are widely used in the industry,
such as to encode the X.509 certificates employed in the HTTPS handshake,
to exchange control data between mobile phones and cellular networks,
to car-to-car communication in intelligent transportation networks.
The ASN.1 standard is large and complex and no open source compiler supports
it in its entirety. The asn1c is arguably the most evolved open source
ASN.1 compiler.
# Build and Install
If you haven't installed the asn1c yet, read the
[
INSTALL
](
INSTALL
)
file for a
If you haven't installed the asn1c yet, read the
[
INSTALL
](
INSTALL
)
file for a
short installation guide.
short installation guide.
...
@@ -8,11 +23,7 @@ short installation guide.
...
@@ -8,11 +23,7 @@ short installation guide.
For the list of asn1c command line options, see
`asn1c -h`
or
`man asn1c`
.
For the list of asn1c command line options, see
`asn1c -h`
or
`man asn1c`
.
The comprehensive documentation on this compiler is in
[
asn1c-usage.pdf
](
doc/asn1c-usage.pdf
)
.
The comprehensive documentation on this compiler is in
[
doc/asn1c-usage.pdf
](
doc/asn1c-usage.pdf
)
.
If you are building the compiler from the sources, the PDFs reside
in the ./doc directory. Normally the file is installed together with the
README.md file you're reading right now.
Please also read the
[
FAQ
](
FAQ
)
file.
Please also read the
[
FAQ
](
FAQ
)
file.
...
@@ -21,31 +32,33 @@ An excellent book on ASN.1 is written by Olivier Dubuisson:
...
@@ -21,31 +32,33 @@ An excellent book on ASN.1 is written by Olivier Dubuisson:
# Quick start
# Quick start
(also check out
[
asn1c-quick.pdf
](
doc/asn1c-quick.pdf
)
)
(also check out
[
doc/
asn1c-quick.pdf
](
doc/asn1c-quick.pdf
)
)
After
building [and installing] the compiler (see INSTALL
), you may use
After
installing the compiler (see
[
INSTALL
](
INSTALL
)
), you may use
the asn1c command to compile the ASN.1 specification:
the asn1c command to compile the ASN.1 specification:
asn1c <module.asn1> # Compile module
asn1c <module.asn1> # Compile module
If several specifications contain interdependencies, all of them must be
If several specifications contain interdependencies, all of them must be
specified:
specified
at the same time
:
asn1c <module1.asn1> <module2.asn1> ... # Compile interdependent modules
asn1c <module1.asn1> <module2.asn1> ... # Compile interdependent modules
If you are building the asn1c from the sources, the ./examples directory
The asn1c source tarball contains the
[
examples/
](
examples/
)
directory
contains several ASN.1 modules and a script to extract the ASN.1 modules
with several ASN.1 modules and a
[
script
](
examples/crfc2asn1.pl
)
from RFC documents. Refer to the README file in that directory.
to extract the ASN.1 modules from RFC documents.
Refer to the
[
examples/README
](
examples/README
)
file in that directory.
To compile the X.509 PKI module:
To compile the X.509 PKI module:
./asn1c/asn1c -P ./examples/rfc3280-*.asn1 # Compile-n-print
./asn1c/asn1c -P ./examples/rfc3280-*.asn1 # Compile-n-print
In this example,
-P option is used to instruct the compiler to print
the
In this example,
the
**-P**
option is to print the compiled text on
the
compiled text on the standard output instead of creating multiple .c
standard output. The default behavior is that asn1c compiler creates
and .h files for every ASN.1 type found inside the specified ASN.1 modules.
multiple .c and .h files for every ASN.1 type found inside the specified
This is useful for debugging and test automation
.
ASN.1 modules
.
The compiler
-E and -EF
options are used for testing the parser and
The compiler
's
*-E*
and
*-EF*
options are used for testing the parser and
the semantic fixer, respectively. These options will instruct the compiler
the semantic fixer, respectively. These options will instruct the compiler
to dump out the parsed (and fixed) ASN.1 specification as it was
to dump out the parsed (and fixed) ASN.1 specification as it was
"understood" by the compiler. It might be useful for checking
"understood" by the compiler. It might be useful for checking
...
@@ -59,12 +72,12 @@ by the compiler.
...
@@ -59,12 +72,12 @@ by the compiler.
The asn1c compiler works by processing the ASN.1 module specifications
The asn1c compiler works by processing the ASN.1 module specifications
in several stages:
in several stages:
1.
In
the first stage, the ASN.1 file is parsed.
1.
During
the first stage, the ASN.1 file is parsed.
(Parsing produces an ASN.1 syntax tree for the subsequent levels)
(Parsing produces an ASN.1 syntax tree for the subsequent levels)
2.
In
the second stage, the syntax tree is "fixed".
2.
During
the second stage, the syntax tree is "fixed".
(Fixing is a process of checking the tree for semantic errors,
(Fixing is a process of checking the tree for semantic errors,
accompanied by the tree transformation into the canonical form)
accompanied by the tree transformation into the canonical form)
3.
In
the third stage, the syntax tree is compiled into the target language.
3.
During
the third stage, the syntax tree is compiled into the target language.
There are several command-line options reserved for printing the results
There are several command-line options reserved for printing the results
after each stage of operation:
after each stage of operation:
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment