[tor-commits] [tor/master] HACKING/design: turn the remaining parts of crypto into a certs doc

[nickm@xxxxxxxxxxxxxx]

commit 91f377deec9d2d65f8bebe1ac7ea01974b90d376
Author: Nick Mathewson <nickm@xxxxxxxxxxxxxx>
Date:   Tue Nov 12 12:01:33 2019 -0500

    HACKING/design: turn the remaining parts of crypto into a certs doc
---
 .../design/01d-crypto.md => src/lib/crypt_ops/certs.dox       | 11 ++++++++---
 src/mainpage.dox                                              |  2 ++
 2 files changed, 10 insertions(+), 3 deletions(-)

diff --git a/doc/HACKING/design/01d-crypto.md b/src/lib/crypt_ops/certs.dox
similarity index 84%
rename from doc/HACKING/design/01d-crypto.md
rename to src/lib/crypt_ops/certs.dox
index 3e23a0701..4703f07bc 100644
--- a/doc/HACKING/design/01d-crypto.md
+++ b/src/lib/crypt_ops/certs.dox
@@ -1,6 +1,6 @@
+/**
 
-
-### Certificates ###
+@page certificates Certificates in Tor.
 
 We have, alas, several certificate types in Tor.
 
@@ -9,6 +9,8 @@ won't explain X.509 to you -- possibly, no document can. (OTOH, Peter
 Gutmann's "x.509 style guide", though severely dated, does a good job of
 explaining how awful x.509 can be.)  Do not introduce any new usages of
 X.509. Right now we only use it in places where TLS forces us to do so.
+See x509.c for more information about using this type.
+
 
 The authority_cert_t type is used only for directory authority keys. It
 has a medium-term signing key (which the authorities actually keep
@@ -19,9 +21,12 @@ certificate.
 For new places where you need a certificate, consider tor_cert_t: it
 represents a typed and dated _something_ signed by an Ed25519 key.  The
 format is described in tor-spec. Unlike x.509, you can write it on a
-napkin.
+napkin.  The torcert.c file is used for manipulating these certificates and
+their associated keys.
 
 (Additionally, the Tor directory design uses a fairly wide variety of
 documents that include keys and which are signed by keys. You can
 consider these documents to be an additional kind of certificate if you
 want.)
+
+**/
diff --git a/src/mainpage.dox b/src/mainpage.dox
index eb29eb5fa..a5988aecf 100644
--- a/src/mainpage.dox
+++ b/src/mainpage.dox
@@ -31,6 +31,8 @@ Tor repository.
 @subpage intro
 
 @subpage dataflow
+
+@subpage certificates
 **/
 
 /**



_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits