Commit f14de88a authored by Drew's avatar Drew

update readme

parent e0c0c5bb
Pipeline #80 skipped
# What is FISA
FISA is a multi-user secure wallet for secrets, passwords, tokens, etc. You may consider using FISA if:
* You want to share secrets between multiple developers, QA engineers, build servers, etc.
* You want to check secrets into source control
* You need to script or gain programmatic access to your secrets, e.g. to use them in unit tests or to do a deploy
The S3 key we use to release FISA is checked into this repository and secured with FISA. Dogfood tastes good.
# Satisfied users of FISA
* [FISA](https://code.sealedabstract.com/drewcrawford/FISA) (yo dawg)
* [NaOH](https://code.sealedabstract.com/drewcrawford/NaOH)
* [CLIKit](https://code.sealedabstract.com/drewcrawford/CLIKit)
# Security considerations
If an attacker gains write/commit access to your secrets file, they may be able to replace it with secrets of their own choosing. FISA provides confidentiality, but you must use another mechanism, like a commit bit, to ensure secret integrity.
# Usage
FISA supports these commands:
$ FISAcli
createIdentity: Create a new identity and save it to the specified file.
createFISA: Create a new FISA secrets file and save it to the specified location.
printFISA: Print the FISA file.
getPublicIdentity: Get the public portion of your identity
addPublicIdentity: Add the public portion of an identity to the specified FISA file
removePublicIdentity: Remove the public portion of an identity from the specified FISA file
setSecret: Creates a secret or sets an existing one to a new value
removeSecret: Removes a secret from the FISA file
getSecret: Retrieves the secret from the FISA file
legal: Display legal information
version: Displays version information
# Installation
You can download an [official binary](https://fisareleases.s3.amazonaws.com/files.html).
Note that FISA.app does not do anything (yet), the real action happens in `Contents/MacOS/FISAcli`.
# Mailing list
We use [code.sa](http://discuss.sealedabstract.com/c/code-sa/clikit)
# License
This software is licensed under an open-source strong copyleft license, the [RPL](http://opensource.org/licenses/RPL-1.5). If that doesn't work for you, commercial licensing is available from the [author](drew@sealedabstract.com).
# Okay, but how does it work?
FISA: a method for sharing secrets
......@@ -108,20 +161,3 @@
│ │ ┃ ┃
Application────────┘ ┗━━━━━━━━━━━━━━━━━┛
# Usage
FISA supports these commands:
$ FISAcli
createIdentity: Create a new identity and save it to the specified file.
createFISA: Create a new FISA secrets file and save it to the specified location.
printFISA: Print the FISA file.
getPublicIdentity: Get the public portion of your identity
addPublicIdentity: Add the public portion of an identity to the specified FISA file
removePublicIdentity: Remove the public portion of an identity from the specified FISA file
setSecret: Creates a secret or sets an existing one to a new value
removeSecret: Removes a secret from the FISA file
getSecret: Retrieves the secret from the FISA file
legal: Display legal information
version: Displays version information
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment