upleb.uk

Public git repos — served from a NIP-34 GRASP relay at git.upleb.uk

summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDanConwayDev <DanConwayDev@protonmail.com>2025-07-03 09:49:24 +0100
committerDanConwayDev <DanConwayDev@protonmail.com>2025-07-03 09:49:24 +0100
commit78f28284dac5d6521f0308f49c16646b17bad483 (patch)
treebb0cbad3c88aed09e87201854baf343a1ead25ba
parentbddbcbb97f238760fd346f88bfdd8470f3eddf2a (diff)
docs: remove old planning.md
the doc shouldn't have been commited to the project in the first place.
-rw-r--r--planning.md78
1 files changed, 0 insertions, 78 deletions
diff --git a/planning.md b/planning.md
deleted file mode 100644
index d17d176..0000000
--- a/planning.md
+++ /dev/null
@@ -1,78 +0,0 @@
1/* !
2
3# Authentication and Key Management Requirements
4
5## User Experience
6
7For a smooth UX:
81. a private key should only need to be imported once
92. authentication to sign events should persist at least across multiple calls
10to the cli tool within a single terminal session.
11
12## Security
13
141. key material must be encrypted with a salted passphrase when stored on disk.
152. the passphase should only be accessable
16 a) by this specific cli tool; or alternatively
17 b) only within the terminal session
18
19
20# Implementation
21
22Every private key entired into the tool is encrypted with a salted user
23provided passphrase and stored on disk in the tool's configuration file
24alongside display_name and public key for identification.
25
26The private key of the current logged-in user is encrypted with a salted
27randomly generated token and stored on disk in the configuration file alongside
28the public key for identification. The token is stored in the OS's keyring
29using a rust crate called 'keyring'. On Linux this expires after a few days
30whilst on Windows and MacOS it never expires.
31
32Should the token be cycled? cycling the token would prevent an attacker who had
33access to only the token or the encrypted key from returning after the token
34had been cycled. This isn't worth it. An attacker is much more likely to have
35access to both simultainiously.
36
37logout should delete the key encrypted with the token and the token. It should
38give the option to clear encrypted key material for the current user or all
39users.
40
41*/
42
43init
44
45initialize repoisiotr
46
47
48replaceable event
49
50commit id
51
52search by initial commit / initial 5 commits
53name
54
55
56
57initialising a reposistory
58
59
60git nostr init
61 > intialise repo
62
63
64git nostr init - request patches / PRs, issues,
65 features to support
66 -- branch
67 -- patches / PRs
68 -- issues
69
70 -- override git push to also push to nostr.
71
72 settings
73 --git-repos - one or more git repositories where the latest commits can be pulled from
74 --name
75 --description
76
77
78git push nostr main