Skip to content

Commit

Permalink
Clarification on security and privacy
Browse files Browse the repository at this point in the history
  • Loading branch information
shombando committed Nov 18, 2022
1 parent ff73ee3 commit dee8bed
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
2 changes: 2 additions & 0 deletions keyoxidizer.sh
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ EOF
# Generate and upload
newKey()
{
echo "This function will generate a 3072-bit RSA key, if you want to generate additional sub keys or configure other options, please generate a key outside this tool."
echo "Generating new key..."
read -p "Enter full name: " keyoxidizer_name
read -p "Enter email: " keyoxidizer_email
Expand Down Expand Up @@ -274,6 +275,7 @@ matrix()
addProof()
{
existingKey
echo -e "Consult https://blog.keyoxide.org/hashing-identity-proofs/ to conceal identity proofs"
echo -e "Select platform to add proof"
echo -e "01. DNS/Domain"
echo -e "02. Gitea"
Expand Down
4 changes: 4 additions & 0 deletions readme.org
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
This is a simple utility designed to make working with [[https://keyoxide.org][Keyoxide]] easier. Keyoxidizer guides the user with prompts to gather their (name, email, etc.) and then handles all the details to generate the PGP key and exports it to [[https://keys.openpgp.org][OpenPGP]] key server. It will then guide the user in proving ownership their online accounts supported by Keyoxide. Keyoxide will also guide the user through viewing and modifying the proofs (notations) in their key.
This is an unofficial helper around Keyoxide but it does not (and may never) support all Keyoxide features. The goal is to lower the barrier to entry so this will remain a single file utility and have no external dependencies aside from ~bash~ and ~gpg~.

* Security and Privacy
The author is not an authority on security or privacy, please use at your own risk. The current default option will generate a 3072-bit RSA key with a single sub-key. If you want to generate multiple sub-keys or change other security options, please generate key outside of this script and use this script. If you want to hash your proofs then please consult [[https://blog.keyoxide.org/hashing-identity-proofs/][this Keyoxide blog post]]. Please take a look at [[https://github.com/shombando/keyoxidizer/issues/7][the discussion here]] for further information and feedback from the community.

* Usage
** Option 1
Clone the repo. Run the script.
Expand Down Expand Up @@ -46,6 +49,7 @@ The releases link on Github and Codeberg will contain tagged versions with chang
- Incrementally add support for adding proofs to [[https://docs.keyoxide.org/][the supported service providers]]. They will be listed under the [[Supported Platforms]] sections.
- +List and delete proofs+ - done but delete is a bit tedious
- Setup a build pipeline to automate releases for a tagged release.
- Additional security and privacy options.

* Contributing
I absolutely welcome feedback in the form of PRs, whether it is improving my shell scripting or adding new functionality. A few guidelines to help me out:
Expand Down

0 comments on commit dee8bed

Please sign in to comment.