aboutsummaryrefslogtreecommitdiff
path: root/spec/rend-spec-v3/hidden-service-directory-format-hidservdir-format.md
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2023-10-12 12:27:58 -0400
committerNick Mathewson <nickm@torproject.org>2023-10-12 12:27:58 -0400
commitf7e5a95ee96d8ef52c1732d066c1249a6f84391e (patch)
tree2e1ddd85f471143518d0df7c7645d066d43bc149 /spec/rend-spec-v3/hidden-service-directory-format-hidservdir-format.md
parente4e0d93d56ee8c1aec4c2efaa7046b651f0fe55c (diff)
downloadtorspec-f7e5a95ee96d8ef52c1732d066c1249a6f84391e.tar.gz
torspec-f7e5a95ee96d8ef52c1732d066c1249a6f84391e.zip
Convert text specifications to mdbook.
Diffstat (limited to 'spec/rend-spec-v3/hidden-service-directory-format-hidservdir-format.md')
-rw-r--r--spec/rend-spec-v3/hidden-service-directory-format-hidservdir-format.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/spec/rend-spec-v3/hidden-service-directory-format-hidservdir-format.md b/spec/rend-spec-v3/hidden-service-directory-format-hidservdir-format.md
new file mode 100644
index 0000000..6c56bba
--- /dev/null
+++ b/spec/rend-spec-v3/hidden-service-directory-format-hidservdir-format.md
@@ -0,0 +1,30 @@
+<a id="rend-spec-v3.txt-F"></a>
+# Appendix F: Hidden service directory format [HIDSERVDIR-FORMAT]
+
+This appendix section specifies the contents of the HiddenServiceDir directory:
+
+- "hostname" [FILE]
+
+This file contains the onion address of the onion service.
+
+- "private_key_ed25519" [FILE]
+
+This file contains the private master ed25519 key of the onion service.
+[TODO: Offline keys]
+
+```text
+ - "./authorized_clients/" [DIRECTORY]
+ "./authorized_clients/alice.auth" [FILE]
+ "./authorized_clients/bob.auth" [FILE]
+ "./authorized_clients/charlie.auth" [FILE]
+```
+
+If client authorization is enabled, this directory MUST contain a ".auth"
+file for each authorized client. Each such file contains the public key of
+the respective client. The files are transmitted to the service operator by
+the client.
+
+See section [CLIENT-AUTH-MGMT] for more details and the format of the client file.
+
+(NOTE: client authorization is implemented as of 0.3.5.1-alpha.)
+