# FreeHSM C --- Documentation Index (bilingual / bilingue)

| Document                 | English             | Français               | CC class      |
|--------------------------|---------------------|------------------------|---------------|
| Project overview         | [`../README.md`](../README.md) | [`../README.fr.md`](../README.fr.md) | ---           |
| Architecture             | [`ARCHITECTURE.md`](ARCHITECTURE.md) | [`ARCHITECTURE.fr.md`](ARCHITECTURE.fr.md) | ADV_TDS.3 |
| Network access — the design (#111) | [`REST_API_DESIGN.md`](REST_API_DESIGN.md) | — | decided, being built |
| Network access — deploying it (#111) | [`DEPLOYING_THE_SERVICE.md`](DEPLOYING_THE_SERVICE.md) | — | AGD_OPE.1 |
| The daemon's token PIN (#111) | [`DAEMON_PIN.md`](DAEMON_PIN.md) | — | AGD_OPE.1 |
| Rate limiting by identity (#111) | [`RATE_LIMIT.md`](RATE_LIMIT.md) | — | decided and built |
| PKCS#11 over a socket with p11-kit — setup, and the two limits | [`P11_KIT_REMOTING.md`](P11_KIT_REMOTING.md) | — | AGD_OPE.1 |
| FIPS 140-3 Security Policy | [`FIPS_140_3.md`](FIPS_140_3.md) | [`FIPS_140_3.fr.md`](FIPS_140_3.fr.md) | (FIPS) |
| CC EAL4+ Target of Evaluation | [`EAL4_PLUS.md`](EAL4_PLUS.md) | [`EAL4_PLUS.fr.md`](EAL4_PLUS.fr.md) | ASE_*    |
| Mechanism reference (auto-generated) | [`MECHANISMS.md`](MECHANISMS.md) | [`MECHANISMS.fr.md`](MECHANISMS.fr.md) | ADV_FSP.4 |
| Reproducible build       | [`REPRODUCIBLE_BUILD.md`](REPRODUCIBLE_BUILD.md) | [`REPRODUCIBLE_BUILD.fr.md`](REPRODUCIBLE_BUILD.fr.md) | ALC_CMC.4 |
| Functional testing       | [`ATE_FUN.md`](ATE_FUN.md) | [`ATE_FUN.fr.md`](ATE_FUN.fr.md) | ATE_FUN.1 + COV.2 + DPT.1 |
| Vulnerability analysis   | [`AVA_VAN.md`](AVA_VAN.md) | [`AVA_VAN.fr.md`](AVA_VAN.fr.md) | AVA_VAN.5 |
| Configuration management | [`ALC_CMC.md`](ALC_CMC.md) | [`ALC_CMC.fr.md`](ALC_CMC.fr.md) | ALC_CMC.4 |
| Preparative procedures (install) | [`AGD_PRE.md`](AGD_PRE.md) | [`AGD_PRE.fr.md`](AGD_PRE.fr.md) | AGD_PRE.1 |
| Operational guidance (operator manual) | [`AGD_OPE.md`](AGD_OPE.md) | [`AGD_OPE.fr.md`](AGD_OPE.fr.md) | AGD_OPE.1 |
| FIPS 140-3 Security Target (Annex B draft) | [`FIPS_140_3_SECURITY_TARGET.md`](FIPS_140_3_SECURITY_TARGET.md) | --- | (FIPS Annex B) |
| NIST CST Lab submission checklist | [`CST_LAB_SUBMISSION_CHECKLIST.md`](CST_LAB_SUBMISSION_CHECKLIST.md) | --- | (FIPS CMVP) |
| Hardened DRBG pipeline + SP 800-90B health tests | [`RNG.md`](RNG.md) | --- | ADV_TDS.3 + FIPS §7.10.3 |
| Side-channel posture audit (Level 1 + Level 2 gaps) | [`SIDE_CHANNEL.md`](SIDE_CHANNEL.md) | --- | AVA_VAN.5 |
| Post-quantum support matrix (Kyber alias, Falcon, LMS, XMSS, HQC) | [`POST_QUANTUM.md`](POST_QUANTUM.md) | --- | ADV_FSP.4 |
| Primacy audit — PQC composite claim (#118, verdict + competitor matrix) | [`PRIMACY_AUDIT_PQC_COMPOSITE.md`](PRIMACY_AUDIT_PQC_COMPOSITE.md) | --- | (marketing / positioning) |
| Token store on-disk format (#108 + #110, byte-level spec + invariants) | [`TOKEN_STORE_FORMAT.md`](TOKEN_STORE_FORMAT.md) | --- | ADV_TDS.3 + ADV_FSP.4 |
| `fhsm-csr` — composite keys, requests, and the CA's own certificate (#112) | [`FHSM_CSR.md`](FHSM_CSR.md) | --- | AGD_OPE.1 |
| `fhsm-ca` — issuance, profiles, revocation, CRLs, OCSP and the delegated responder (#112) | [`FHSM_CA.md`](FHSM_CA.md) | --- | AGD_OPE.1 |
| `fhsm-token` tool — provisioning a token | [`FHSM_TOKEN.md`](FHSM_TOKEN.md) | --- | AGD_OPE.1 |
| `fhsm-sign` tool — detached signatures over arbitrary data (#123) | [`FHSM_SIGN.md`](FHSM_SIGN.md) | --- | AGD_OPE.1 |
| Composite ML-DSA — spec gap, measurements, target OID (#112) | [`COMPOSITE_SIGS_GAP.md`](COMPOSITE_SIGS_GAP.md) | --- | ADV_FSP.4 |

## Conventions

- **Canonical files** (no language suffix) are written in **English**, the lingua franca of NIST / NIAP / CMVP submissions. They are the binding reference for the international evaluation labs (atsec, Acumen, Leidos, BSI).
- **`.fr.md` files** are French translations, primarily for the ANSSI / CESTI submission stream (CC EAL4+ via French centres of evaluation). The translation is functionally equivalent ; in case of discrepancy the English version prevails.
- **`README.md` at project root** is in English (the default international showcase). `README.fr.md` mirrors it in French.
- **Code blocks, command-line snippets, and source-symbol names** are NOT translated --- they are technical artefacts.
- **`MECHANISMS.md`** is auto-generated by `scripts/gen_p11_thunks.py`. Its French version is a thin wrapper that points to the English (auto-gen does not produce French ; localising the generator is tracked as a future task).

## Documents non traduits / Documents not translated

The following technical artefacts remain English-only :
- All inline comments in `src/`, `include/`, `scripts/`
- The generated `MECHANISMS.md` body (auto-gen output)
- The `kat/cavp/*.rsp` files (NIST CAVP format, by definition English)

These technical artefacts use precise vocabulary inherited from the standards (FIPS, NIST SP, RFC, PKCS#11 OASIS) and are commonly read in English by francophone evaluators.
