# ankraft/akasn1lib architecture

> Architecture diagram of the GitHub repository ankraft/akasn1lib, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-15). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ankraft/akasn1lib
- Repository: https://github.com/ankraft/akasn1lib

## Overview

##### Project type and purpose
- AKASN1Lib is a C-level library (not a full-stack app or service) whose sole purpose is to encode and decode ASN.1 data using Basic Encoding Rules (BER).
- It provides per-type encoder/decoder modules for INTEGER, OCTETSTRING, NULL, OBJECTID, ENUMERATED, SEQUENCE/SET, all string classes, plus generic tag/length support and basic file I/O.

##### File structure
- Top-level:
- src/ – C code broken out by type (booldec.c, boolenc.c, …, tagdec.c, tagenc.c, writebuf.c, readbuf.c).
- src/*.h – Public headers (akasn1.h, vlARGS.h).
- test/ – a minimal test harness (test.c).
- doc/ – auto-generated Doxygen HTML docs.
- Makefile, LICENSE, README.md.
- Architectural patterns:
- Layered: public API ⟶ type‐specific encoders/decoders ⟶ shared tag/length routines ⟶ buffer I/O ⟶ file handling.
- Modular: each ASN.1 type lives in its own C module.
- Single‐process runtime, no network or external services.

##### Additional insights from README
- Library entry point: functions exposed in akasn1.h.
- Dependency: ANSI C99, no external libs.
- Limitations: primitive file handling, 32-bit values.

##### Main components and their interactions
a. Components
1. Public API layer (akasn1.h)
2. Type encoder modules (e.g. intenc.c, octenc.c, tagenc.c)
3. Type decoder modules (e.g. intdec.c, octdec.c, tagdec.c)
4. Tag & length support (taglenrd.c, tagwr.c, writebuf.c, readbuf.c)
5. File I/O layer (clfile.c, skipfile.c, asnfseek.c/asnftell.c)
6. Test harness (test.c)
7. Doxygen docs (doc/html)
b. Relationships & data flow
- Client app calls API → dispatch to specific encoder/decoder
- Encoder/decoder calls tag/length routines to write header
- Buffer routines manage in-memory buffers
- File I/O routines write/read to physical file
- Decoder pulls from file via readbuf & skipfile
c. Architectural patterns
- Layered, single‐address‐space library
- Module per data type for easy extensibility
- Shared utility modules (tag/length, buffers, file)
d. Technologies
- ANSI C (C99), Makefile for build
- Doxygen for docs
- MIT license

##### Diagramming recommendations
- Use clear labels for each component (e.g. “intenc.c – INTEGER Encoder”).
- API → Encoder/Decoder
- Encoder/Decoder → Tag/Length → Buffer → File I/O
- Decoder → Buffer → File I/O
- Green for encoders, yellow for decoders
- Gray for shared utilities
- Orange for file I/O
- Rectangles for modules

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Public API Layer
    subgraph "Public API"
        APIENTRY["Public API"]:::api
        AKASN1["akasn1.h"]:::api
        VLARGS["vlARGS.h"]:::api
    end

    %% Encoders Layer
    subgraph "Encoders" 
        INTENC["intenc.c\n(INTEGER Encoder)"]:::enc
        OCTENC["octenc.c\n(OCTET STRING Encoder)"]:::enc
        NULLENC["nullenc.c\n(NULL Encoder)"]:::enc
        OIDENC["oidenc.c\n(OBJECT ID Encoder)"]:::enc
        ENUMENC["enumenc.c\n(ENUMERATED Encoder)"]:::enc
        IA5ENC["ia5enc.c\n(IA5String Encoder)"]:::enc
    end

    %% Decoders Layer
    subgraph "Decoders"
        INTDEC["intdec.c\n(INTEGER Decoder)"]:::dec
        OCTDEC["octdec.c\n(OCTET STRING Decoder)"]:::dec
        NULLDEC["nullrd.c\n(NULL Decoder)"]:::dec
        OIDDEC["oiddec.c\n(OBJECT ID Decoder)"]:::dec
        ENUMDEC["enumdec.c\n(ENUMERATED Decoder)"]:::dec
        IA5DEC["ia5dec.c\n(IA5String Decoder)"]:::dec
    end

    %% Shared Utilities
    subgraph "Tag/Length Utilities"
        LENENC["lenenc.c\n(Length Encoding)"]:::util
        LENDEC["lendec.c\n(Length Decoding)"]:::util
        TAGENC["tagenc.c\n(Tag Encoding)"]:::util
        TAGDEC["tagdec.c\n(Tag Decoding)"]:::util
        TAGLENRD["taglenrd.c\n(Generic Tag/Length Read)"]:::util
        TAGRD["tagrd.c\n(Tag Read Utility)"]:::util
        TAGWR["tagwr.c\n(Tag Write Utility)"]:::util
    end

    %% Buffer I/O
    subgraph "Buffer I/O"
        READBUF["readbuf.c"]:::buf
        WRITEBUF["writebuf.c"]:::buf
    end

    %% File I/O Layer
    subgraph "File I/O"
        CLFILE["clfile.c"]:::file
        SKIPFILE["skipfile.c"]:::file
        FSEEK["asnfseek.c"]:::file
        FTELL["asnftell.c"]:::file
        OPRDFILE["oprdfile.c"]:::file
        OPWRFILE["opwrfile.c"]:::file
    end

    %% Test Harness and Docs
    TEST["Test Harness"]:::test
    DOCS["Doxygen Docs"]:::docs

    %% Connections
    APIENTRY -->|uses| INTENC
    APIENTRY -->|uses| OCTENC
    APIENTRY -->|uses| NULLENC
    APIENTRY -->|uses| OIDENC
    APIENTRY -->|uses| ENUMENC
    APIENTRY -->|uses| IA5ENC

    APIENTRY -->|uses| INTDEC
    APIENTRY -->|uses| OCTDEC
    APIENTRY -->|uses| NULLDEC
    APIENTRY -->|uses| OIDDEC
    APIENTRY -->|uses| ENUMDEC
    APIENTRY -->|uses| IA5DEC

    INTENC -->|encodes via| TAGENC
    OCTENC -->|encodes via| TAGENC
    NULLENC -->|encodes via| TAGENC
    OIDENC -->|encodes via| TAGENC
    ENUMENC -->|encodes via| TAGENC
    IA5ENC -->|encodes via| TAGENC

    INTDEC -->|decodes via| TAGDEC
    OCTDEC -->|decodes via| TAGDEC
    NULLDEC -->|decodes via| TAGDEC
    OIDDEC -->|decodes via| TAGDEC
    ENUMDEC -->|decodes via| TAGDEC
    IA5DEC -->|decodes via| TAGDEC

    TAGENC -->|uses| TAGLENRD
    TAGDEC -->|uses| TAGLENRD
    TAGLENRD -->|reads/writes| TAGRD
    TAGLENRD -->|reads/writes| TAGWR

    TAGWR -->|buffer| WRITEBUF
    TAGRD -->|buffer| READBUF

    WRITEBUF -->|file ops| OPWRFILE
    READBUF -->|file ops| OPRDFILE

    OPWRFILE -->|C file I/O| CLFILE
    OPRDFILE -->|C file I/O| CLFILE
    CLFILE -->|seek| FSEEK
    CLFILE -->|tell| FTELL
    CLFILE -->|skip| SKIPFILE

    TEST -->|calls API| APIENTRY
    DOCS --- TEST

    %% Click Events
    click AKASN1 "https://github.com/ankraft/akasn1lib/blob/master/src/akasn1.h"
    click VLARGS "https://github.com/ankraft/akasn1lib/blob/master/src/vlARGS.h"
    click INTENC "https://github.com/ankraft/akasn1lib/blob/master/src/intenc.c"
    click OCTENC "https://github.com/ankraft/akasn1lib/blob/master/src/octenc.c"
    click NULLENC "https://github.com/ankraft/akasn1lib/blob/master/src/nullenc.c"
    click OIDENC "https://github.com/ankraft/akasn1lib/blob/master/src/oidenc.c"
    click ENUMENC "https://github.com/ankraft/akasn1lib/blob/master/src/enumenc.c"
    click IA5ENC "https://github.com/ankraft/akasn1lib/blob/master/src/ia5enc.c"
    click INTDEC "https://github.com/ankraft/akasn1lib/blob/master/src/intdec.c"
    click OCTDEC "https://github.com/ankraft/akasn1lib/blob/master/src/octdec.c"
    click NULLDEC "https://github.com/ankraft/akasn1lib/blob/master/src/nullrd.c"
    click OIDDEC "https://github.com/ankraft/akasn1lib/blob/master/src/oiddec.c"
    click ENUMDEC "https://github.com/ankraft/akasn1lib/blob/master/src/enumdec.c"
    click IA5DEC "https://github.com/ankraft/akasn1lib/blob/master/src/ia5dec.c"
    click LENENC "https://github.com/ankraft/akasn1lib/blob/master/src/lenenc.c"
    click LENDEC "https://github.com/ankraft/akasn1lib/blob/master/src/lendec.c"
    click TAGENC "https://github.com/ankraft/akasn1lib/blob/master/src/tagenc.c"
    click TAGDEC "https://github.com/ankraft/akasn1lib/blob/master/src/tagdec.c"
    click TAGLENRD "https://github.com/ankraft/akasn1lib/blob/master/src/taglenrd.c"
    click TAGRD "https://github.com/ankraft/akasn1lib/blob/master/src/tagrd.c"
    click TAGWR "https://github.com/ankraft/akasn1lib/blob/master/src/tagwr.c"
    click READBUF "https://github.com/ankraft/akasn1lib/blob/master/src/readbuf.c"
    click WRITEBUF "https://github.com/ankraft/akasn1lib/blob/master/src/writebuf.c"
    click CLFILE "https://github.com/ankraft/akasn1lib/blob/master/src/clfile.c"
    click SKIPFILE "https://github.com/ankraft/akasn1lib/blob/master/src/skipfile.c"
    click FSEEK "https://github.com/ankraft/akasn1lib/blob/master/src/asnfseek.c"
    click FTELL "https://github.com/ankraft/akasn1lib/blob/master/src/asnftell.c"
    click OPRDFILE "https://github.com/ankraft/akasn1lib/blob/master/src/oprdfile.c"
    click OPWRFILE "https://github.com/ankraft/akasn1lib/blob/master/src/opwrfile.c"
    click TEST "https://github.com/ankraft/akasn1lib/blob/master/test/test.c"
    click DOCS "https://github.com/ankraft/akasn1lib/tree/master/doc/html"

    %% Styles
    classDef api fill:#cce5ff,stroke:#339,stroke-width:1px;
    classDef enc fill:#d4edda,stroke:#2a6f2b,stroke-width:1px;
    classDef dec fill:#fff3cd,stroke:#8a6d1b,stroke-width:1px;
    classDef util fill:#e2e3e5,stroke:#6c757d,stroke-width:1px;
    classDef buf fill:#d1ecf1,stroke:#0c5460,stroke-width:1px;
    classDef file fill:#ffe5b4,stroke:#d67f00,stroke-width:1px;
    classDef test fill:#f5c6cb,stroke:#721c24,stroke-width:1px;
    classDef docs fill:#e2e3e5,stroke:#5a6268,stroke-width:1px;
```
