diff options
Diffstat (limited to 'doc/hacking.rst')
| -rw-r--r-- | doc/hacking.rst | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/doc/hacking.rst b/doc/hacking.rst new file mode 100644 index 000000000..d9481a4c0 --- /dev/null +++ b/doc/hacking.rst @@ -0,0 +1,71 @@ + +Source Code Layout +================================================= + +Under `src` there are directories + +* `lib` is the library itself, more on that below +* `cmd` is the implementation of the command line application. + It is structed as a multicall binary so each program is relatively + independent. +* `tests` contain what you would expect. Input files go under `tests/data`. +* `build-data` contains files read by the configure script. For + example `build-data/cc/gcc.txt` describes various gcc options. +* `scripts` contains various scripts: install, distribution, various + codegen things. Scripts controlling CI go under `scripts/ci`. +* `python` and `ocaml` are the FFI bindings for those languages + +Library Layout +======================================== + +* `base` defines some high level types +* `utils` contains various utility functions +* `codec` has hex, base64 +* `block` contains the block cipher implementations +* `modes` contains block cipher modes +* `stream` contains the stream ciphers +* `hash` contains the hash function implementations +* `passhash` contains password hashing algorithms for authentication +* `kdf` contains the key derivation functions +* `mac` contains the message authentication codes +* `pbkdf` contains password hashing algorithms for key derivation +* `math` is the math library for public key operations. It is divided into + four parts: `mp` which are the low level algorithms; `bigint` which is + a C++ wrapper around `mp`; `numbertheory` which contains algorithms like + primality testing and exponentiation; and `ec_gfp` which defines elliptic + curves over prime fields. +* `pubkey` contains the public key implementations +* `pk_pad` contains padding schemes for public key algorithms +* `rng` contains the random number generators +* `entropy` has various entropy sources +* `asn1` is the DER encoder/decoder +* `cert` has `x509` (X.509 PKI OCSP is also here) and `cvc` (Card Verifiable Ceritifcates, + for ePassports) +* `tls` contains the TLS implementation +* `filters` has a filter/pipe API for data transforms +* `misc` contains odds and ends: format preserving encryption, SRP, threshold + secret sharing, all or nothing transform, and others +* `compression` has the compression wrappers (zlib, bzip2, lzma) +* `ffi` is the C99 API +* `vendor` contains bindings to external libraries like OpenSSL and Sqlite3 + +Style Conventions +======================================== + +A formatting setup for emacs is included in `scripts/indent.el` but +the basic formatting style should be obvious. No tabs, and remove +trailing whitespace. + +Use m_ prefix on all member variables. The current code is not +consistent but all new code should use it. + +Prefer using braces on both sides of if/else blocks, even if only +using a single statement. Again the current code doesn't always do +this. + +Sending patches +======================================== + +All contributions should be submitted as pull requests via the github +page. If you are planning a large change email the mailing list or open +a discussion ticket on github before starting out. |