diff --git a/FAQ.md b/FAQ.md new file mode 100644 index 0000000..612f079 --- /dev/null +++ b/FAQ.md @@ -0,0 +1,25 @@ +# FAQ + +### Secretive doesn't work with my git client + +Secretive relies on the `SSH_AUTH_SOCK` environment variable being respected. The `git` and `ssh` command line tools natively respect this, but third party apps may require some configuration to work. A non-exhaustive list of clients is provided here: + +Tower - [Instructions](https://www.git-tower.com/help/mac/integration/environment) + +GitHub Desktop: Should just work, no configuration needed + +### Why should I trust you? + +You shouldn't, for a piece of software like this. Secretive, by design, has an auditable build process. Each build has a fully auditable build log, showing the source it was built from and a SHA of the build product. You can check the SHA of the zip you download against the SHA output in the build log (which is linked in the About window). + +### I want to build Secretive from source + +Awesome! Just bear in mind that because an app only has access to the keychain items that it created, if you have secrets that you created with the prebuilt version of Secretive, you'll be unable to access them using your own custom build (since you'll have changed the bundled ID). + +### I have a security issue + +Please contact [max.goedjen@gmail.com](mailto:max.goedjen@gmail.com) with a subject containing "SECRETIVE SECURITY" immediately with details, and I'll address the issue and credit you ASAP. + +### I want to contribute to Secretive + +Sweet! Please check out the [contributing guidelines](CONTRIBUTING.md) and go from there. \ No newline at end of file diff --git a/README.md b/README.md index 0c9e89b..5b592ba 100644 --- a/README.md +++ b/README.md @@ -30,13 +30,9 @@ For Macs without Secure Enclaves, you can configure a Smart Card (such as a Yubi ## Getting Started -### Setup for Third Party Apps - -When you first launch Secretive, you'll be prompted to set up your command line environment. You can redisplay this prompt at any time by going to `Menu > Help -> Set Up Helper App`. -For non-command-line based apps, like GUI Git clients, you may need to go through app-specific setup. - -[Tower](https://www.git-tower.com/help/mac/integration/environment) +### FAQ +There's a [FAQ here](FAQ.md). ### Auditable Build Process @@ -52,4 +48,4 @@ Beacuse secrets in the Secure Enclave are not exportable, they are not able to b ## Security -If you discover any vulnerabilities in this project, please notify max.goedjen@gmail.com +If you discover any vulnerabilities in this project, please notify [max.goedjen@gmail.com](mailto:max.goedjen@gmail.com) with the subject containing "SECRETIVE SECURITY."