Skip to content
This repository was archived by the owner on Sep 20, 2023. It is now read-only.

Commit 04667f6

Browse files
Emmett J. Butlerrnystrom
authored andcommitted
Security FAQ (#2069)
* add stub of security FAQ document * add basics to security FAQ
1 parent 8a8da14 commit 04667f6

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed

SECURITY.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# GitHawk Security FAQ
2+
3+
## How does GitHawk authenticate access to repositories?
4+
5+
GitHawk requests a GitHub OAuth token with the `repo`, `user`, and
6+
`notifications` scopes. According to the GitHub
7+
[documentation](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/),
8+
these scopes allow read/write access to profile information, read access to
9+
the authenticated user's notifications, and read/write access to code and
10+
commit messages for all public and private repositories to which the
11+
authenticating user has access.
12+
13+
## How does GitHawk store passwords?
14+
15+
By using OAuth, GitHawk avoids needing to store any passwords on the device or
16+
in the cloud.
17+
18+
## How does GitHawk store authentication tokens?
19+
20+
GitHawk stores an OAuth session token on the device in order to maintain the user's
21+
OAuth session across multiple runs of the app. This token has an expiry and is
22+
never uploaded to any servers.
23+
24+
## Does GitHawk store source code?
25+
26+
GitHawk stores some repository information on the device, including source
27+
code, pull request contents, and issue contents. This information is stored
28+
for the purpose of speeding up the app's user experience and reducing the
29+
nuber of redundant calls it needs to make to the GitHub API. Source code and
30+
other information downloaded using the `repo` OAuth scope is never uploaded to
31+
any servers.
32+
33+
## When does GitHawk read source code from my repository?
34+
35+
GitHawk reads source code from repositories only in the form of pull request
36+
diffs. Git patches, which contain multiple versions of relevant source code
37+
snippets, are read via GitHub API requests when the user asks to read the code
38+
corresponding to a given pull request. GitHawk does not read repo source code
39+
at any other time.
40+
41+
## Does GitHawk ever clone my repositories?
42+
43+
GitHawk does not clone Git repositories for any reason. All repo-specific
44+
information is acquired via OAuth-authenticated requests to the GitHub API.
45+
46+
## When does GitHawk write to repositories?
47+
48+
GitHawk writes to repositories only at the user's request. This includes
49+
actions like commenting on an issue or merging a pull request. GitHawk never
50+
writes to repositories without some explicit form of user confirmation
51+
immediately preceding the action.
52+
53+
## What data does GitHawk upload to non-GitHub servers?
54+
55+
GitHawk does not upload any information gathered via the GitHub API to
56+
third-party servers.
57+
58+
## Are logs kept on who accesses what data via GitHawk?
59+
60+
Logs are kept locally on the device for the purpose of debugging.

0 commit comments

Comments
 (0)