mirror of
https://github.com/AGWA/git-crypt.git
synced 2026-01-01 15:49:58 -08:00
Compare commits
13 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a1e6311f56 | ||
|
|
12c422228a | ||
|
|
1c905faeb5 | ||
|
|
7c129cdd38 | ||
|
|
89bcafa1a6 | ||
|
|
88705f996c | ||
|
|
d1fd1353f8 | ||
|
|
ce716b130f | ||
|
|
8618098bcc | ||
|
|
29974b4fba | ||
|
|
af846389e5 | ||
|
|
699d7eb246 | ||
|
|
549ce4a490 |
46
.github/workflows/release-linux.yml
vendored
Normal file
46
.github/workflows/release-linux.yml
vendored
Normal file
@@ -0,0 +1,46 @@
|
||||
on:
|
||||
release:
|
||||
types: [published]
|
||||
name: Build Release Binary (Linux)
|
||||
jobs:
|
||||
build:
|
||||
name: Build Release Binary
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: read
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v2
|
||||
- name: Install dependencies
|
||||
run: sudo apt install libssl-dev
|
||||
- name: Build binary
|
||||
run: make
|
||||
- name: Upload release artifact
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: git-crypt-artifacts
|
||||
path: git-crypt
|
||||
upload:
|
||||
name: Upload Release Binary
|
||||
runs-on: ubuntu-latest
|
||||
needs: build
|
||||
permissions:
|
||||
contents: write
|
||||
steps:
|
||||
- name: Download release artifact
|
||||
uses: actions/download-artifact@v3
|
||||
with:
|
||||
name: git-crypt-artifacts
|
||||
- name: Upload release asset
|
||||
uses: actions/github-script@v3
|
||||
with:
|
||||
github-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
script: |
|
||||
const fs = require("fs").promises;
|
||||
const { repo: { owner, repo }, sha } = context;
|
||||
await github.repos.uploadReleaseAsset({
|
||||
owner, repo,
|
||||
release_id: ${{ github.event.release.id }},
|
||||
name: 'git-crypt-${{ github.event.release.name }}-linux-x86_64',
|
||||
data: await fs.readFile('git-crypt'),
|
||||
});
|
||||
56
.github/workflows/release-windows.yml
vendored
Normal file
56
.github/workflows/release-windows.yml
vendored
Normal file
@@ -0,0 +1,56 @@
|
||||
on:
|
||||
release:
|
||||
types: [published]
|
||||
name: Build Release Binary (Windows)
|
||||
jobs:
|
||||
build:
|
||||
name: Build Release Binary
|
||||
runs-on: windows-2022
|
||||
permissions:
|
||||
contents: read
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v2
|
||||
- name: Setup msys2
|
||||
uses: msys2/setup-msys2@v2
|
||||
with:
|
||||
msystem: MINGW64
|
||||
update: true
|
||||
install: >-
|
||||
base-devel
|
||||
msys2-devel
|
||||
mingw-w64-x86_64-toolchain
|
||||
mingw-w64-x86_64-openssl
|
||||
openssl-devel
|
||||
- name: Build binary
|
||||
shell: msys2 {0}
|
||||
run: make LDFLAGS="-static-libstdc++ -static -lcrypto -lws2_32"
|
||||
- name: Upload release artifact
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: git-crypt-artifacts
|
||||
path: git-crypt.exe
|
||||
upload:
|
||||
name: Upload Release Binary
|
||||
runs-on: ubuntu-latest
|
||||
needs: build
|
||||
permissions:
|
||||
contents: write
|
||||
steps:
|
||||
- name: Download release artifact
|
||||
uses: actions/download-artifact@v3
|
||||
with:
|
||||
name: git-crypt-artifacts
|
||||
- name: Upload release asset
|
||||
uses: actions/github-script@v3
|
||||
with:
|
||||
github-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
script: |
|
||||
const fs = require("fs").promises;
|
||||
const { repo: { owner, repo }, sha } = context;
|
||||
await github.repos.uploadReleaseAsset({
|
||||
owner, repo,
|
||||
release_id: ${{ github.event.release.id }},
|
||||
name: 'git-crypt-${{ github.event.release.name }}-x86_64.exe',
|
||||
data: await fs.readFile('git-crypt.exe'),
|
||||
});
|
||||
@@ -4,8 +4,7 @@ documentation, bug reports, or anything else that improves git-crypt.
|
||||
|
||||
When contributing code, please consider the following guidelines:
|
||||
|
||||
* You are encouraged to open an issue on GitHub or send mail to
|
||||
git-crypt-discuss@lists.cloudmutt.com to discuss any non-trivial
|
||||
* You are encouraged to open an issue on GitHub to discuss any non-trivial
|
||||
changes before you start coding.
|
||||
|
||||
* Please mimic the existing code style as much as possible. In
|
||||
@@ -15,8 +14,7 @@ When contributing code, please consider the following guidelines:
|
||||
* To minimize merge commits, please rebase your changes before opening
|
||||
a pull request.
|
||||
|
||||
* To submit your patch, open a pull request on GitHub or send a
|
||||
properly-formatted patch to git-crypt-discuss@lists.cloudmutt.com.
|
||||
* To submit your patch, open a pull request on GitHub.
|
||||
|
||||
Finally, be aware that since git-crypt is security-sensitive software,
|
||||
the bar for contributions is higher than average. Please don't be
|
||||
|
||||
5
NEWS
5
NEWS
@@ -1,3 +1,8 @@
|
||||
v0.7.0 (2022-04-21)
|
||||
* Avoid "argument list too long" errors on macOS.
|
||||
* Fix handling of "-" arguments.
|
||||
* Minor documentation improvements.
|
||||
|
||||
v0.6.0 (2017-11-26)
|
||||
* Add support for OpenSSL 1.1 (still works with OpenSSL 1.0).
|
||||
* Switch to C++11 (gcc 4.9 or higher now required to build).
|
||||
|
||||
5
NEWS.md
5
NEWS.md
@@ -1,6 +1,11 @@
|
||||
News
|
||||
====
|
||||
|
||||
######v0.7.0 (2022-04-21)
|
||||
* Avoid "argument list too long" errors on macOS.
|
||||
* Fix handling of "-" arguments.
|
||||
* Minor documentation improvements.
|
||||
|
||||
######v0.6.0 (2017-11-26)
|
||||
* Add support for OpenSSL 1.1 (still works with OpenSSL 1.0).
|
||||
* Switch to C++11 (gcc 4.9 or higher now required to build).
|
||||
|
||||
37
README
37
README
@@ -30,6 +30,7 @@ Specify files to encrypt by creating a .gitattributes file:
|
||||
|
||||
secretfile filter=git-crypt diff=git-crypt
|
||||
*.key filter=git-crypt diff=git-crypt
|
||||
secretdir/** filter=git-crypt diff=git-crypt
|
||||
|
||||
Like a .gitignore file, it can match wildcards and should be checked into
|
||||
the repository. See below for more information about .gitattributes.
|
||||
@@ -54,7 +55,7 @@ are added to your repository):
|
||||
|
||||
$ git-crypt export-key /path/to/key
|
||||
|
||||
After cloning a repository with encrypted files, unlock with with GPG:
|
||||
After cloning a repository with encrypted files, unlock with GPG:
|
||||
|
||||
$ git-crypt unlock
|
||||
|
||||
@@ -69,7 +70,7 @@ encryption and decryption happen transparently.
|
||||
|
||||
CURRENT STATUS
|
||||
|
||||
The latest version of git-crypt is 0.6.0, released on 2017-11-26.
|
||||
The latest version of git-crypt is 0.7.0, released on 2022-04-21.
|
||||
git-crypt aims to be bug-free and reliable, meaning it shouldn't
|
||||
crash, malfunction, or expose your confidential data. However,
|
||||
it has not yet reached maturity, meaning it is not as documented,
|
||||
@@ -108,6 +109,16 @@ git-crypt does not hide when a file does or doesn't change, the length
|
||||
of a file, or the fact that two files are identical (see "Security"
|
||||
section above).
|
||||
|
||||
git-crypt does not support revoking access to an encrypted repository
|
||||
which was previously granted. This applies to both multi-user GPG
|
||||
mode (there's no del-gpg-user command to complement add-gpg-user)
|
||||
and also symmetric key mode (there's no support for rotating the key).
|
||||
This is because it is an inherently complex problem in the context
|
||||
of historical data. For example, even if a key was rotated at one
|
||||
point in history, a user having the previous key can still access
|
||||
previous repository history. This problem is discussed in more detail in
|
||||
<https://github.com/AGWA/git-crypt/issues/47>.
|
||||
|
||||
Files encrypted with git-crypt are not compressible. Even the smallest
|
||||
change to an encrypted file requires git to store the entire changed file,
|
||||
instead of just a delta.
|
||||
@@ -138,20 +149,12 @@ specifying merely a directory (e.g. `/dir/`) is NOT sufficient to
|
||||
encrypt all files beneath it.
|
||||
|
||||
Also note that the pattern `dir/*` does not match files under
|
||||
sub-directories of dir/. To encrypt an entire sub-tree dir/, place the
|
||||
following in dir/.gitattributes:
|
||||
sub-directories of dir/. To encrypt an entire sub-tree dir/, use `dir/**`:
|
||||
|
||||
dir/** filter=git-crypt diff=git-crypt
|
||||
|
||||
The .gitattributes file must not be encrypted, so make sure wildcards don't
|
||||
match it accidentally. If necessary, you can exclude .gitattributes from
|
||||
encryption like this:
|
||||
|
||||
* filter=git-crypt diff=git-crypt
|
||||
.gitattributes !filter !diff
|
||||
|
||||
The second pattern is essential for ensuring that .gitattributes itself
|
||||
is not encrypted.
|
||||
|
||||
|
||||
MAILING LISTS
|
||||
|
||||
To stay abreast of, and provide input to, git-crypt development, consider
|
||||
subscribing to one or both of our mailing lists:
|
||||
|
||||
Announcements: https://lists.cloudmutt.com/mailman/listinfo/git-crypt-announce
|
||||
Discussion: https://lists.cloudmutt.com/mailman/listinfo/git-crypt-discuss
|
||||
|
||||
39
README.md
39
README.md
@@ -31,6 +31,7 @@ Specify files to encrypt by creating a .gitattributes file:
|
||||
|
||||
secretfile filter=git-crypt diff=git-crypt
|
||||
*.key filter=git-crypt diff=git-crypt
|
||||
secretdir/** filter=git-crypt diff=git-crypt
|
||||
|
||||
Like a .gitignore file, it can match wildcards and should be checked into
|
||||
the repository. See below for more information about .gitattributes.
|
||||
@@ -55,7 +56,7 @@ are added to your repository):
|
||||
|
||||
git-crypt export-key /path/to/key
|
||||
|
||||
After cloning a repository with encrypted files, unlock with with GPG:
|
||||
After cloning a repository with encrypted files, unlock with GPG:
|
||||
|
||||
git-crypt unlock
|
||||
|
||||
@@ -70,8 +71,8 @@ encryption and decryption happen transparently.
|
||||
Current Status
|
||||
--------------
|
||||
|
||||
The latest version of git-crypt is [0.6.0](NEWS.md), released on
|
||||
2017-11-26. git-crypt aims to be bug-free and reliable, meaning it
|
||||
The latest version of git-crypt is [0.7.0](NEWS.md), released on
|
||||
2022-04-21. git-crypt aims to be bug-free and reliable, meaning it
|
||||
shouldn't crash, malfunction, or expose your confidential data.
|
||||
However, it has not yet reached maturity, meaning it is not as
|
||||
documented, featureful, or easy-to-use as it should be. Additionally,
|
||||
@@ -110,6 +111,16 @@ git-crypt does not hide when a file does or doesn't change, the length
|
||||
of a file, or the fact that two files are identical (see "Security"
|
||||
section above).
|
||||
|
||||
git-crypt does not support revoking access to an encrypted repository
|
||||
which was previously granted. This applies to both multi-user GPG
|
||||
mode (there's no del-gpg-user command to complement add-gpg-user)
|
||||
and also symmetric key mode (there's no support for rotating the key).
|
||||
This is because it is an inherently complex problem in the context
|
||||
of historical data. For example, even if a key was rotated at one
|
||||
point in history, a user having the previous key can still access
|
||||
previous repository history. This problem is discussed in more detail in
|
||||
<https://github.com/AGWA/git-crypt/issues/47>.
|
||||
|
||||
Files encrypted with git-crypt are not compressible. Even the smallest
|
||||
change to an encrypted file requires git to store the entire changed file,
|
||||
instead of just a delta.
|
||||
@@ -140,20 +151,12 @@ specifying merely a directory (e.g. `/dir/`) is *not* sufficient to
|
||||
encrypt all files beneath it.
|
||||
|
||||
Also note that the pattern `dir/*` does not match files under
|
||||
sub-directories of dir/. To encrypt an entire sub-tree dir/, place the
|
||||
following in dir/.gitattributes:
|
||||
sub-directories of dir/. To encrypt an entire sub-tree dir/, use `dir/**`:
|
||||
|
||||
dir/** filter=git-crypt diff=git-crypt
|
||||
|
||||
The .gitattributes file must not be encrypted, so make sure wildcards don't
|
||||
match it accidentally. If necessary, you can exclude .gitattributes from
|
||||
encryption like this:
|
||||
|
||||
* filter=git-crypt diff=git-crypt
|
||||
.gitattributes !filter !diff
|
||||
|
||||
The second pattern is essential for ensuring that .gitattributes itself
|
||||
is not encrypted.
|
||||
|
||||
Mailing Lists
|
||||
-------------
|
||||
|
||||
To stay abreast of, and provide input to, git-crypt development,
|
||||
consider subscribing to one or both of our mailing lists:
|
||||
|
||||
* [Announcements](https://lists.cloudmutt.com/mailman/listinfo/git-crypt-announce)
|
||||
* [Discussion](https://lists.cloudmutt.com/mailman/listinfo/git-crypt-discuss)
|
||||
|
||||
28
commands.cpp
28
commands.cpp
@@ -51,6 +51,12 @@
|
||||
#include <exception>
|
||||
#include <vector>
|
||||
|
||||
enum {
|
||||
// # of arguments per git checkout call; must be large enough to be efficient but small
|
||||
// enough to avoid operating system limits on argument length
|
||||
GIT_CHECKOUT_BATCH_SIZE = 100
|
||||
};
|
||||
|
||||
static std::string attribute_name (const char* key_name)
|
||||
{
|
||||
if (key_name) {
|
||||
@@ -183,15 +189,19 @@ static void deconfigure_git_filters (const char* key_name)
|
||||
}
|
||||
}
|
||||
|
||||
static bool git_checkout (const std::vector<std::string>& paths)
|
||||
static bool git_checkout_batch (std::vector<std::string>::const_iterator paths_begin, std::vector<std::string>::const_iterator paths_end)
|
||||
{
|
||||
if (paths_begin == paths_end) {
|
||||
return true;
|
||||
}
|
||||
|
||||
std::vector<std::string> command;
|
||||
|
||||
command.push_back("git");
|
||||
command.push_back("checkout");
|
||||
command.push_back("--");
|
||||
|
||||
for (std::vector<std::string>::const_iterator path(paths.begin()); path != paths.end(); ++path) {
|
||||
for (auto path(paths_begin); path != paths_end; ++path) {
|
||||
command.push_back(*path);
|
||||
}
|
||||
|
||||
@@ -202,6 +212,18 @@ static bool git_checkout (const std::vector<std::string>& paths)
|
||||
return true;
|
||||
}
|
||||
|
||||
static bool git_checkout (const std::vector<std::string>& paths)
|
||||
{
|
||||
auto paths_begin(paths.begin());
|
||||
while (paths.end() - paths_begin >= GIT_CHECKOUT_BATCH_SIZE) {
|
||||
if (!git_checkout_batch(paths_begin, paths_begin + GIT_CHECKOUT_BATCH_SIZE)) {
|
||||
return false;
|
||||
}
|
||||
paths_begin += GIT_CHECKOUT_BATCH_SIZE;
|
||||
}
|
||||
return git_checkout_batch(paths_begin, paths.end());
|
||||
}
|
||||
|
||||
static bool same_key_name (const char* a, const char* b)
|
||||
{
|
||||
return (!a && !b) || (a && b && std::strcmp(a, b) == 0);
|
||||
@@ -1171,7 +1193,7 @@ int lock (int argc, const char** argv)
|
||||
}
|
||||
if (!git_checkout(encrypted_files)) {
|
||||
std::clog << "Error: 'git checkout' failed" << std::endl;
|
||||
std::clog << "git-crypt has been locked but up but existing decrypted files have not been encrypted" << std::endl;
|
||||
std::clog << "git-crypt has been locked up but existing decrypted files have not been encrypted" << std::endl;
|
||||
return 1;
|
||||
}
|
||||
|
||||
|
||||
@@ -31,7 +31,7 @@
|
||||
#ifndef GIT_CRYPT_GIT_CRYPT_HPP
|
||||
#define GIT_CRYPT_GIT_CRYPT_HPP
|
||||
|
||||
#define VERSION "0.6.0"
|
||||
#define VERSION "0.7.0"
|
||||
|
||||
extern const char* argv0; // initialized in main() to argv[0]
|
||||
|
||||
|
||||
@@ -7,8 +7,8 @@
|
||||
-->
|
||||
<refentryinfo>
|
||||
<title>git-crypt</title>
|
||||
<date>2017-11-26</date>
|
||||
<productname>git-crypt 0.6.0</productname>
|
||||
<date>2022-04-21</date>
|
||||
<productname>git-crypt 0.7.0</productname>
|
||||
|
||||
<author>
|
||||
<othername>Andrew Ayer</othername>
|
||||
|
||||
@@ -43,7 +43,7 @@ int parse_options (const Options_list& options, int argc, const char** argv)
|
||||
{
|
||||
int argi = 0;
|
||||
|
||||
while (argi < argc && argv[argi][0] == '-') {
|
||||
while (argi < argc && argv[argi][0] == '-' && argv[argi][1] != '\0') {
|
||||
if (std::strcmp(argv[argi], "--") == 0) {
|
||||
++argi;
|
||||
break;
|
||||
|
||||
Reference in New Issue
Block a user