├── .gitignore ├── .travis.yml ├── COPYING ├── README.md ├── aes.go ├── cmd ├── git-crypt-add-key │ ├── LICENSE │ ├── go.mod │ └── main.go └── git-decrypt │ ├── LICENSE │ ├── Makefile │ ├── go.mod │ └── main.go ├── decrypt.go ├── gitcrypt.go ├── go.mod ├── go.work ├── gpg.go ├── gpg ├── COPYING ├── go.mod ├── gpg.go ├── gpg_test.go └── util.go ├── hmac.go ├── key.go ├── key_test.go ├── util.go └── vars.go /.gitignore: -------------------------------------------------------------------------------- 1 | go.sum 2 | *~ 3 | aes_test.go 4 | decrypt_test.go 5 | testdata/repo 6 | cmd/git-crypt-add-key/git-crypt-add-key 7 | cmd/git-decrypt/git-decrypt 8 | git-crypt-debug 9 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: go 2 | go: 3 | - tip 4 | script: 5 | - go get -d -v 6 | - go build 7 | sudo: false 8 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # GO-GIT-CRYPT 2 | 3 | [![Build Status](https://secure.travis-ci.org/jbuchbinder/go-git-crypt.png)](http://travis-ci.org/jbuchbinder/go-git-crypt) 4 | [![GoDoc](https://godoc.org/github.com/jbuchbinder/go-git-crypt?status.png)](https://godoc.org/github.com/jbuchbinder/go-git-crypt) 5 | 6 | A Go-flavored attempt to reimplement the git-crypt algorithm in native Go. Primary focus is on providing decryption and key-handling functionality. 7 | 8 | _WARNING: Until version 0.1 is tagged, the API is subject to arbitrary change._ 9 | 10 | ## Features 11 | 12 | - [X] Decryption 13 | - [ ] Parsing/interpretation of .gitattributes 14 | - [ ] Encryption 15 | - [X] GPG keys - Add to repository 16 | - [ ] GPG keys - Remove from repository 17 | - [ ] New repository initialization 18 | 19 | -------------------------------------------------------------------------------- /aes.go: -------------------------------------------------------------------------------- 1 | package gitcrypt 2 | 3 | import ( 4 | "crypto/aes" 5 | "encoding/binary" 6 | "fmt" 7 | "io" 8 | "log" 9 | ) 10 | 11 | // AesCtrEncryptor represents an AES encryptor/decryptor 12 | type AesCtrEncryptor struct { 13 | // Debug represents whether debug logging is turned on or not 14 | Debug bool 15 | 16 | ctrValue []byte // Current CTR value (used as input to AES to derive pad) 17 | pad []byte // Current encryption pad (output of AES) 18 | byteCounter uint32 // How many bytes processed so far? 19 | key []byte 20 | } 21 | 22 | // NewAesCtrEncryptor creates a new AesCtrEncryptor instance with a key and nonce 23 | func NewAesCtrEncryptor(rawKey []byte, nonce []byte) AesCtrEncryptor { 24 | obj := AesCtrEncryptor{} 25 | obj.ctrValue = make([]byte, aesEncryptorBlockLen) 26 | obj.pad = make([]byte, aesEncryptorBlockLen) 27 | obj.key = rawKey 28 | // Set first 12 bytes of the CTR value to the nonce. 29 | // This stays the same for the entirety of this object's lifetime. 30 | for i := 0; i < nonceLength; i++ { 31 | obj.ctrValue[i] = nonce[i] 32 | } 33 | obj.byteCounter = 0 34 | return obj 35 | } 36 | 37 | // TODO: Deal with implementing destructor 38 | /* 39 | Aes_ctr_encryptor::~Aes_ctr_encryptor () 40 | { 41 | explicit_memset(pad, '\0', BLOCK_LEN); 42 | } 43 | */ 44 | 45 | func (a *AesCtrEncryptor) process(in []byte, out []byte, len uint32) error { 46 | var i uint32 47 | //log.Printf("process for length = %d", len) 48 | for i = 0; i < len; i++ { 49 | if a.byteCounter%aesEncryptorBlockLen == 0 { 50 | //log.Printf("a.byteCounter = %d, aesEncryptorBlockLen = %d", a.byteCounter, aesEncryptorBlockLen) 51 | // Set last 4 bytes of CTR to the (big-endian) block number (sequentially increasing with each block) 52 | tmp := make([]byte, 4) 53 | binary.BigEndian.PutUint32(tmp, a.byteCounter/aesEncryptorBlockLen) 54 | if a.Debug { 55 | log.Printf("tmp = %#v, bytecounter = %d, blockLen = %d", tmp, a.byteCounter, aesEncryptorBlockLen) 56 | } 57 | //store_be32(ctr_value + NONCE_LEN, byte_counter / BLOCK_LEN) 58 | if a.Debug { 59 | log.Printf("last four bytes of CTR : %x", tmp) 60 | } 61 | for i := 0; i < 4; i++ { 62 | a.ctrValue[aesEncryptorNonceLen+i] = tmp[i] 63 | } 64 | //log.Printf("ctrValue = %#v", a.ctrValue) 65 | 66 | // Generate a new pad 67 | c, err := aes.NewCipher(a.key) 68 | if err != nil { 69 | return err 70 | } 71 | c.Encrypt(a.pad, a.ctrValue) 72 | 73 | //log.Printf("pad = %x", a.pad) 74 | } 75 | 76 | // encrypt one byte 77 | out[i] = in[i] ^ a.pad[a.byteCounter%aesEncryptorBlockLen] 78 | a.byteCounter++ 79 | //log.Printf("pos %d, in = %x, out = %x, pad = %x", i, in[i], out[i], a.pad[a.byteCounter%aesEncryptorBlockLen]) 80 | 81 | if a.byteCounter == 0 { 82 | return fmt.Errorf("Aes_ctr_encryptor::process - Too much data to encrypt securely") 83 | } 84 | } 85 | return nil 86 | } 87 | 88 | // Encrypt/decrypt an entire input stream, writing to the given output stream 89 | func (a *AesCtrEncryptor) processStream(in io.Reader, out io.Writer, key []byte, nonce []byte) error { 90 | c := NewAesCtrEncryptor(key, nonce) 91 | if len(c.key) == 0 { 92 | return fmt.Errorf("bad key") 93 | } 94 | ibuf := make([]byte, 1024) 95 | obuf := make([]byte, 1024) 96 | for { 97 | n, err := in.Read(ibuf) 98 | if err != nil { 99 | break 100 | } 101 | err = c.process(ibuf, obuf, uint32(n)) 102 | if err != nil { 103 | return err 104 | } 105 | _, err = out.Write(obuf) 106 | if err != nil { 107 | return err 108 | } 109 | } 110 | return nil 111 | } 112 | -------------------------------------------------------------------------------- /cmd/git-crypt-add-key/LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /cmd/git-crypt-add-key/go.mod: -------------------------------------------------------------------------------- 1 | module github.com/jbuchbinder/go-git-crypt/cmd/git-crypt-add-key 2 | 3 | go 1.23 4 | 5 | toolchain go1.23.2 6 | 7 | replace ( 8 | github.com/jbuchbinder/go-git-crypt => ../.. 9 | github.com/jbuchbinder/go-git-crypt/gpg => ../../gpg 10 | ) 11 | 12 | require ( 13 | github.com/ProtonMail/go-crypto v1.1.5 14 | github.com/jbuchbinder/go-git-crypt v0.0.0-20250212140507-1b2044cb2630 15 | github.com/jbuchbinder/go-git-crypt/gpg v0.0.0-20240127160537-0b99b456d912 16 | ) 17 | 18 | require ( 19 | github.com/cloudflare/circl v1.6.0 // indirect 20 | golang.org/x/crypto v0.33.0 // indirect 21 | golang.org/x/sys v0.30.0 // indirect 22 | golang.org/x/tools v0.30.0 // indirect 23 | ) 24 | -------------------------------------------------------------------------------- /cmd/git-crypt-add-key/main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "bytes" 5 | "flag" 6 | "log" 7 | "os" 8 | "strings" 9 | 10 | "github.com/ProtonMail/go-crypto/openpgp" 11 | gitcrypt "github.com/jbuchbinder/go-git-crypt" 12 | "github.com/jbuchbinder/go-git-crypt/gpg" 13 | ) 14 | 15 | var ( 16 | path = flag.String("path", "", "Path to repository base") 17 | gpgkey = flag.String("key", "", "GPG key file") 18 | addkey = flag.String("addkey", "", "GPG public key file to add") 19 | debug = flag.Bool("debug", false, "Debug") 20 | ) 21 | 22 | func main() { 23 | flag.Parse() 24 | 25 | if *path == "" || *gpgkey == "" || *addkey == "" { 26 | panic("no path, key, or addkey specified") 27 | } 28 | 29 | var keydata *openpgp.Entity 30 | var newkeydata *openpgp.Entity 31 | 32 | { 33 | rawkeydata, err := os.ReadFile(*gpgkey) 34 | if err != nil { 35 | panic("unable to ingest GPG key") 36 | } 37 | keydata, err = gpg.ArmoredKeyIngest(rawkeydata) 38 | if err != nil { 39 | panic("unable to ingest GPG key") 40 | } 41 | } 42 | 43 | { 44 | rawkeydata, err := os.ReadFile(*addkey) 45 | if err != nil { 46 | panic("unable to ingest public GPG key") 47 | } 48 | newkeydata, err = gpg.ArmoredKeyIngest(rawkeydata) 49 | if err != nil { 50 | panic("unable to ingest public GPG key") 51 | } 52 | } 53 | 54 | g := gitcrypt.GitCrypt{Debug: *debug} 55 | 56 | keyring := openpgp.EntityList{keydata} 57 | keysPath := *path + string(os.PathSeparator) + ".git-crypt" + string(os.PathSeparator) + "keys" 58 | keys, err := g.DecryptRepoKeys(keyring, uint32(0), listKeys(keysPath), keysPath) 59 | if err != nil { 60 | panic(err) 61 | } 62 | 63 | if *debug { 64 | log.Printf("keys = %#v", keys) 65 | } 66 | 67 | buf := make([]byte, 0) 68 | plainOut := bytes.NewBuffer(buf) 69 | err = keys[0].Store(plainOut) 70 | if err != nil { 71 | panic(err) 72 | } 73 | 74 | out, err := gpg.Encrypt(plainOut.Bytes(), openpgp.EntityList{newkeydata}, "", "") 75 | if err != nil { 76 | panic(err) 77 | } 78 | 79 | outfilename := keysPath + string(os.PathSeparator) + "default" + string(os.PathSeparator) + "0" + 80 | string(os.PathSeparator) + gpg.Fingerprint(newkeydata) + ".gpg" 81 | if *debug { 82 | log.Printf("outfilename = %s", outfilename) 83 | } 84 | err = os.WriteFile(outfilename, out, 0600) 85 | if err != nil { 86 | panic(err) 87 | } 88 | } 89 | 90 | func listKeys(keysPath string) []string { 91 | keys := make([]string, 0) 92 | lookin := keysPath + string(os.PathSeparator) + "default" + string(os.PathSeparator) + "0" 93 | entries, err := os.ReadDir(lookin) 94 | if err != nil { 95 | return keys 96 | } 97 | for _, e := range entries { 98 | if !e.IsDir() { 99 | keys = append(keys, strings.TrimSuffix(e.Name(), ".gpg")) 100 | } 101 | } 102 | return keys 103 | } 104 | -------------------------------------------------------------------------------- /cmd/git-decrypt/LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /cmd/git-decrypt/Makefile: -------------------------------------------------------------------------------- 1 | all: clean 2 | CGO_ENABLED=0 GOOS=linux COARCH=i386 go build -v 3 | 4 | clean: 5 | go clean -v 6 | -------------------------------------------------------------------------------- /cmd/git-decrypt/go.mod: -------------------------------------------------------------------------------- 1 | module github.com/jbuchbinder/go-git-crypt/cmd/git-decrypt 2 | 3 | go 1.23 4 | 5 | toolchain go1.23.2 6 | 7 | replace ( 8 | github.com/jbuchbinder/go-git-crypt => ../.. 9 | github.com/jbuchbinder/go-git-crypt/gpg => ../../gpg 10 | ) 11 | 12 | require ( 13 | github.com/ProtonMail/go-crypto v1.1.5 14 | github.com/jbuchbinder/go-git-crypt v0.0.0-20250212140507-1b2044cb2630 15 | github.com/jbuchbinder/go-git-crypt/gpg v0.0.0-20240127160537-0b99b456d912 16 | ) 17 | 18 | require ( 19 | github.com/cloudflare/circl v1.6.0 // indirect 20 | golang.org/x/crypto v0.33.0 // indirect 21 | golang.org/x/sys v0.30.0 // indirect 22 | golang.org/x/tools v0.30.0 // indirect 23 | ) 24 | -------------------------------------------------------------------------------- /cmd/git-decrypt/main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "bufio" 5 | "bytes" 6 | "flag" 7 | "io/fs" 8 | "log" 9 | "os" 10 | "path/filepath" 11 | "strings" 12 | 13 | "github.com/ProtonMail/go-crypto/openpgp" 14 | gitcrypt "github.com/jbuchbinder/go-git-crypt" 15 | "github.com/jbuchbinder/go-git-crypt/gpg" 16 | ) 17 | 18 | var ( 19 | path = flag.String("path", "", "Path to repository base") 20 | gpgkey = flag.String("key", "", "GPG key file") 21 | debug = flag.Bool("debug", false, "Debug") 22 | ) 23 | 24 | func main() { 25 | flag.Parse() 26 | 27 | if *path == "" || *gpgkey == "" { 28 | panic("no path or key specified") 29 | } 30 | 31 | rawkeydata, err := os.ReadFile(*gpgkey) 32 | if err != nil { 33 | panic("unable to ingest GPG key") 34 | } 35 | keydata, err := gpg.ArmoredKeyIngest(rawkeydata) 36 | if err != nil { 37 | panic("unable to ingest GPG key") 38 | } 39 | 40 | g := gitcrypt.GitCrypt{Debug: *debug} 41 | 42 | keyring := openpgp.EntityList{keydata} 43 | keysPath := *path + string(os.PathSeparator) + ".git-crypt" + string(os.PathSeparator) + "keys" 44 | keys, err := g.DecryptRepoKeys(keyring, uint32(0), listKeys(keysPath), keysPath) 45 | if err != nil { 46 | panic(err) 47 | } 48 | 49 | if *debug { 50 | log.Printf("keys = %#v", keys) 51 | } 52 | 53 | err = filepath.WalkDir(*path, func(path string, d fs.DirEntry, err error) error { 54 | if strings.Contains(path, string(os.PathSeparator)+".git") { 55 | // Skip 56 | return nil 57 | } 58 | if !d.IsDir() { 59 | if g.IsGitCrypted(path) { 60 | log.Printf("GIT-CRYPTED: %s", path) 61 | in, err := os.Open(path) 62 | if err != nil { 63 | return err 64 | } 65 | defer in.Close() 66 | 67 | header, err := g.ReadFileHeader(in) 68 | if err != nil { 69 | return err 70 | } 71 | var buf bytes.Buffer 72 | out := bufio.NewWriter(&buf) 73 | 74 | err = g.DecryptStream(keys[0], header, in, out) 75 | if err != nil { 76 | return err 77 | } 78 | out.Flush() 79 | 80 | err = os.WriteFile(path+".decrypted", buf.Bytes(), 0600) 81 | if err != nil { 82 | log.Printf("ERR: ioutil.WriteFile(%s): %s", path+".decrypted", err.Error()) 83 | } 84 | 85 | err = os.Rename(path+".decrypted", path) 86 | if err != nil { 87 | log.Printf("ERR: os.Rename(%s, %s): %s", path+".decrypted", path, err.Error()) 88 | } 89 | 90 | log.Printf("%s: Decrypted %d bytes", path, len(buf.Bytes())) 91 | } 92 | } 93 | //log.Printf("path = %s, d = %#v", path, d) 94 | return nil 95 | }) 96 | 97 | if err != nil { 98 | panic(err) 99 | } 100 | } 101 | 102 | func listKeys(keysPath string) []string { 103 | keys := make([]string, 0) 104 | lookin := keysPath + string(os.PathSeparator) + "default" + string(os.PathSeparator) + "0" 105 | entries, err := os.ReadDir(lookin) 106 | if err != nil { 107 | return keys 108 | } 109 | for _, e := range entries { 110 | if !e.IsDir() { 111 | keys = append(keys, strings.TrimSuffix(e.Name(), ".gpg")) 112 | } 113 | } 114 | return keys 115 | } 116 | -------------------------------------------------------------------------------- /decrypt.go: -------------------------------------------------------------------------------- 1 | package gitcrypt 2 | 3 | import ( 4 | "bytes" 5 | "errors" 6 | "fmt" 7 | "io" 8 | "log" 9 | "os" 10 | "strings" 11 | 12 | "github.com/ProtonMail/go-crypto/openpgp" 13 | "github.com/jbuchbinder/go-git-crypt/gpg" 14 | ) 15 | 16 | /* 17 | // Decrypt decrypts a git-crypt encrypted file, given a key and a data 18 | // stream 19 | func (g *GitCrypt) Decrypt(key []byte, data []byte) ([]byte, error) { 20 | var out []byte 21 | block, err := aes.NewCipher(key) 22 | if err != nil { 23 | return out, err 24 | } 25 | 26 | h := hmac.New(sha1.New, key) 27 | 28 | block.Decrypt(data, out) 29 | _, err = h.Write(out) 30 | if err != nil { 31 | return out, err 32 | } 33 | 34 | return out, nil 35 | } 36 | */ 37 | 38 | // DecryptRepoKey decrypts a repository key, given: 39 | // - keyring: A GPG keyring to use for the decryption. 40 | // - keyName: Name of the key set being used. Empty defaults to "default". 41 | // - keyVersion: Version of the git-crypt keys. 42 | // - secretKeys: Array of private keys to attempt to decrypt 43 | // - keysPath: Root path to the repository key directory (should be $REPOPATH/.git-crypt/keys) 44 | func (g *GitCrypt) DecryptRepoKey(keyring openpgp.EntityList, keyName string, keyVersion uint32, secretKeys []string, keysPath string) (Key, error) { 45 | //var err error 46 | keyFile := Key{} 47 | 48 | for _, seckey := range secretKeys { 49 | path := keysPath + string(os.PathSeparator) 50 | if keyName == "" { 51 | path += "default" 52 | } else { 53 | path += keyName 54 | } 55 | path += string(os.PathSeparator) + fmt.Sprintf("%d", keyVersion) + string(os.PathSeparator) + seckey + ".gpg" 56 | 57 | if g.fileExists(path) { 58 | log.Printf("Decrypting key %v in path %s", keyring, path) 59 | 60 | decryptedContents, err := g.GpgDecryptFromFile(keyring, path) 61 | if err != nil { 62 | log.Printf("decryption of file %s : %s", path, err.Error()) 63 | continue 64 | } 65 | if len(decryptedContents) == 0 { 66 | log.Printf("") 67 | continue 68 | } 69 | 70 | var thisVersionKeyFile Key 71 | br := bytes.NewBuffer(decryptedContents) 72 | err = thisVersionKeyFile.Load(br) 73 | if err != nil { 74 | return keyFile, fmt.Errorf("unable to load version key file") 75 | } 76 | thisVersionEntry, err := thisVersionKeyFile.Get(keyVersion) 77 | if err != nil { 78 | return keyFile, fmt.Errorf("GPG-encrypted keyfile is malformed because it does not contain expected key version") 79 | 80 | } 81 | if strings.Compare(keyName, thisVersionKeyFile.KeyName) != 0 { 82 | return keyFile, fmt.Errorf("GPG-encrypted keyfile is malformed because it does not contain expected key name") 83 | 84 | } 85 | keyFile.Entries = append(keyFile.Entries, thisVersionEntry) 86 | return keyFile, nil 87 | } 88 | } 89 | 90 | return keyFile, errors.New("no secret keys") 91 | } 92 | 93 | // DecryptRepoKeys decrypts all available repository keys, given a GPG key 94 | func (g *GitCrypt) DecryptRepoKeys(keyring openpgp.EntityList, keyVersion uint32, secretKeys []string, keysPath string) ([]Key, error) { 95 | successful := false 96 | dirents := make([]string, 0) 97 | keyFiles := make([]Key, 0) 98 | 99 | if g.fileExists(keysPath) { 100 | if g.Vfs == nil { 101 | fp, err := os.Open(keysPath) 102 | if err != nil { 103 | return keyFiles, err 104 | } 105 | defer fp.Close() 106 | entries, err := fp.ReadDir(0) 107 | if err != nil { 108 | return keyFiles, err 109 | } 110 | for _, entry := range entries { 111 | dirents = append(dirents, entry.Name()) 112 | } 113 | } else { 114 | entries, err := g.Vfs.ReadDir(keysPath) 115 | if err != nil { 116 | return keyFiles, err 117 | } 118 | for _, entry := range entries { 119 | dirents = append(dirents, entry.Name()) 120 | } 121 | } 122 | } 123 | 124 | for _, dirent := range dirents { 125 | log.Printf("decryptRepoKeys : %s", dirent) 126 | keyName := "" 127 | if strings.Compare(dirent, "default") != 0 { 128 | if err := validateKeyName(dirent); err != nil { 129 | continue 130 | } 131 | keyName = dirent 132 | } 133 | 134 | keyFile, err := g.DecryptRepoKey(keyring, keyName, keyVersion, secretKeys, keysPath) 135 | if err == nil { 136 | keyFiles = append(keyFiles, keyFile) 137 | successful = true 138 | } 139 | } 140 | if !successful { 141 | return keyFiles, fmt.Errorf("unsuccessful") 142 | } 143 | return keyFiles, nil 144 | } 145 | 146 | // ReadFileHeaderFromFile fetches the git-crypt file header from an unopened 147 | // file 148 | func (g *GitCrypt) ReadFileHeaderFromFile(filename string) ([]byte, error) { 149 | header := make([]byte, 10+aesEncryptorNonceLen) 150 | fp, err := os.Open(filename) 151 | if err != nil { 152 | return header, err 153 | } 154 | defer fp.Close() 155 | n, err := fp.Read(header) 156 | if g.Debug { 157 | log.Printf("readFileHeaderFromFile : read %d bytes : %s", n, header) 158 | } 159 | return header, err 160 | } 161 | 162 | // ReadFileHeader fetches the git-crypt file header from an open seekable 163 | // file 164 | func (g *GitCrypt) ReadFileHeader(fp io.ReadSeekCloser) ([]byte, error) { 165 | header := make([]byte, 10+aesEncryptorNonceLen) 166 | _, err := fp.Seek(0, io.SeekStart) 167 | if err != nil { 168 | return header, err 169 | } 170 | n, err := fp.Read(header) 171 | if g.Debug { 172 | log.Printf("readFileHeader : read %d bytes : %#v", n, header) 173 | } 174 | if err != nil { 175 | return header, err 176 | } 177 | pos, err := fp.Seek(10+aesEncryptorNonceLen, io.SeekStart) 178 | if g.Debug { 179 | log.Printf("readFileHeader : seek'd to %d: err = %#v", pos, err) 180 | } 181 | return header, err 182 | } 183 | 184 | // IsGitCrypted returns whether or not a file has been encrypted in 185 | // the git-crypt encryption format. Supports optional Vfs methods. 186 | func (g *GitCrypt) IsGitCrypted(fn string) bool { 187 | var err error 188 | if g.Vfs != nil { 189 | _, err = g.Vfs.Stat(fn) 190 | } else { 191 | _, err = os.Stat(fn) 192 | } 193 | if err != nil { 194 | // If we can't open the file, skip git-crypting 195 | log.Printf("ERR: %s", err.Error()) 196 | return false 197 | } 198 | 199 | var n int 200 | b := make([]byte, 10) 201 | 202 | if g.Vfs != nil { 203 | fp, err := g.Vfs.Open(fn) 204 | if err != nil { 205 | // If we can't open the file, skip git-crypting 206 | log.Printf("ERR: %s", err.Error()) 207 | return false 208 | } 209 | defer fp.Close() 210 | _, err = fp.Seek(0, io.SeekStart) 211 | if err != nil { 212 | log.Printf("ERR: %s", err.Error()) 213 | return false 214 | } 215 | n, err = fp.Read(b) 216 | if err != nil { 217 | log.Printf("ERR: %s", err.Error()) 218 | return false 219 | } 220 | } else { 221 | fp, err := os.Open(fn) 222 | if err != nil { 223 | // If we can't open the file, skip git-crypting 224 | log.Printf("ERR: %s", err.Error()) 225 | return false 226 | } 227 | defer fp.Close() 228 | n, err = fp.ReadAt(b, 0) 229 | if err != nil { 230 | log.Printf("ERR: %s", err.Error()) 231 | return false 232 | } 233 | } 234 | if n < 10 { 235 | log.Printf("ERR: only read %d bytes", n) 236 | return false 237 | } 238 | return bytes.Equal(b[0:9], gitCryptHeader) 239 | } 240 | 241 | // DecryptStream decrypts a stream of encrypted git-crypt format data 242 | // given a key file and header 243 | func (g *GitCrypt) DecryptStream(keyFile Key, header []byte, in io.ReadSeeker, out io.Writer) error { 244 | if g.Debug { 245 | log.Printf("header: %#v", header) 246 | } 247 | nonce := header[10:] 248 | if g.Debug { 249 | log.Printf("nonce: %#v", nonce) 250 | } 251 | keyVersion := keyFile.Version 252 | 253 | key, err := keyFile.Get(keyVersion) 254 | if err != nil { 255 | return fmt.Errorf("git-crypt: error: key version %d not available - please unlock with the latest version of the key", keyVersion) 256 | } 257 | 258 | // Attempt to detect if we've read anything already; if we haven't, ignore 259 | // the header bytes, if not, keep going 260 | currentPos, err := in.Seek(0, io.SeekCurrent) 261 | if err != nil { 262 | return err 263 | } 264 | if currentPos == 0 { 265 | // Skip past the header before we begin calculations 266 | ignore := make([]byte, len(header)) 267 | _, err = in.Read(ignore) 268 | if err != nil { 269 | return fmt.Errorf("git-crypt: unable to read header: %s", err.Error()) 270 | } 271 | } 272 | 273 | aes := NewAesCtrEncryptor(key.AesKey, nonce) 274 | h := NewHMac(key.HmacKey) 275 | counter := 0 276 | for { 277 | ibuf := make([]byte, 1024) 278 | obuf := make([]byte, 1024) 279 | n, err := in.Read(ibuf) 280 | if err != nil { 281 | //log.Printf("ERR: %s", err.Error()) 282 | break 283 | } 284 | if g.Debug { 285 | log.Printf("size = %d, ibuf = %x", n, ibuf) 286 | } 287 | err = aes.process(ibuf, obuf, uint32(n)) 288 | if err != nil { 289 | return err 290 | } 291 | if g.Debug { 292 | log.Printf("input : %x", string(ibuf)) 293 | log.Printf("output : %x", string(obuf)) 294 | } 295 | 296 | // Only iterate to number of read bytes to avoid ending nulls 297 | for i := 0; i < n; i++ { 298 | out.Write([]byte{obuf[i]}) 299 | h.Write([]byte{obuf[i]}) 300 | } 301 | 302 | counter++ 303 | } 304 | 305 | // HMAC checksumming 306 | digest := h.Result() 307 | if g.Debug { 308 | log.Printf("digest = %#v, nonce = %#v, len = %d", digest, nonce, aesEncryptorNonceLen) 309 | } 310 | if !leaklessEquals(digest, nonce, aesEncryptorNonceLen) { 311 | return fmt.Errorf("git-crypt: error: encrypted file has been tampered with") 312 | // Although we've already written the tampered file to stdout, exiting 313 | // with a non-zero status will tell git the file has not been filtered, 314 | // so git will not replace it. 315 | } 316 | 317 | return nil 318 | } 319 | 320 | // GpgDecryptFromFile decrypts a file using a PGP/GPG key 321 | func (g *GitCrypt) GpgDecryptFromFile(keyring openpgp.EntityList, path string) ([]byte, error) { 322 | var filedata []byte 323 | var err error 324 | 325 | if g.Vfs == nil { 326 | filedata, err = os.ReadFile(path) 327 | } else { 328 | fp, err := g.Vfs.Open(path) 329 | if err != nil { 330 | return filedata, err 331 | } 332 | defer fp.Close() 333 | filedata, _ = io.ReadAll(fp) 334 | } 335 | if err != nil { 336 | log.Printf("GpgDecryptFromFile(%#v, %s): ERR: %s", keyring, path, err.Error()) 337 | return []byte{}, err 338 | } 339 | out, err := gpg.Decrypt(filedata, keyring) 340 | if err != nil { 341 | log.Printf("GpgDecryptFromFile(%#v, %s): ERR: %s", keyring, path, err.Error()) 342 | } 343 | return out, err 344 | } 345 | -------------------------------------------------------------------------------- /gitcrypt.go: -------------------------------------------------------------------------------- 1 | package gitcrypt 2 | 3 | import "golang.org/x/tools/godoc/vfs" 4 | 5 | // GitCrypt is the namespace 6 | type GitCrypt struct { 7 | // Debug represents whether debug output will be enabled. Do not turn 8 | // this on until you really mean it. 9 | Debug bool 10 | // Vfs represents an optional virtual filesystem. If it is nil, the 11 | // standard OS file opening functions will be used. 12 | Vfs vfs.FileSystem 13 | } 14 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/jbuchbinder/go-git-crypt 2 | 3 | go 1.23 4 | 5 | toolchain go1.23.2 6 | 7 | replace github.com/jbuchbinder/go-git-crypt/gpg => ./gpg 8 | 9 | require ( 10 | github.com/ProtonMail/go-crypto v1.1.5 11 | github.com/jbuchbinder/go-git-crypt/gpg v0.0.0-20240127160537-0b99b456d912 12 | golang.org/x/crypto v0.33.0 13 | golang.org/x/tools v0.30.0 14 | ) 15 | 16 | require ( 17 | github.com/cloudflare/circl v1.6.0 // indirect 18 | github.com/kr/text v0.2.0 // indirect 19 | golang.org/x/sys v0.30.0 // indirect 20 | ) 21 | -------------------------------------------------------------------------------- /go.work: -------------------------------------------------------------------------------- 1 | go 1.23 2 | 3 | toolchain go1.23.2 4 | 5 | use ( 6 | . 7 | ./cmd/git-crypt-add-key 8 | ./cmd/git-decrypt 9 | ./gpg 10 | ) 11 | -------------------------------------------------------------------------------- /gpg.go: -------------------------------------------------------------------------------- 1 | package gitcrypt 2 | 3 | import ( 4 | "bytes" 5 | "errors" 6 | "io" 7 | "log" 8 | "strings" 9 | 10 | "github.com/ProtonMail/go-crypto/openpgp" 11 | "github.com/ProtonMail/go-crypto/openpgp/armor" 12 | "github.com/ProtonMail/go-crypto/openpgp/packet" 13 | ) 14 | 15 | type rawKeyData []byte 16 | 17 | func gpgArmoredKeyIngest(input rawKeyData) (*openpgp.Entity, error) { 18 | block, err := armor.Decode(bytes.NewReader([]byte(input))) 19 | if err != nil { 20 | return nil, err 21 | } 22 | switch block.Type { 23 | case openpgp.PublicKeyType: 24 | // Handle public key block 25 | log.Printf("gpgArmoredKeyIngest(): ingesting public key") 26 | return openpgp.ReadEntity(packet.NewReader(block.Body)) 27 | case openpgp.PrivateKeyType: 28 | // Handle private key block 29 | log.Printf("gpgArmoredKeyIngest(): ingesting private key") 30 | return openpgp.ReadEntity(packet.NewReader(block.Body)) 31 | default: 32 | return nil, errors.New("gpgArmoredKeyIngest(): Error ingesting key, unsupported type " + block.Type) 33 | } 34 | } 35 | 36 | func gpgDecrypt(in []byte, secretKeyring openpgp.EntityList) ([]byte, error) { 37 | // Determine if there's any armoring going on 38 | if strings.Contains(string(in), "BEGIN PGP MESSAGE") { 39 | result, err := armor.Decode(bytes.NewReader(in)) 40 | if err != nil { 41 | log.Printf("gpgDecrypt(): Decode(armored): %s", err.Error()) 42 | return []byte{}, err 43 | } 44 | md, err := openpgp.ReadMessage(result.Body, secretKeyring, nil, nil) 45 | if err != nil { 46 | log.Printf("gpgDecrypt(): ReadMessage(armored): %s", err.Error()) 47 | return []byte{}, err 48 | } 49 | return io.ReadAll(md.UnverifiedBody) 50 | } 51 | 52 | md, err := openpgp.ReadMessage(bytes.NewReader(in), secretKeyring, nil, nil) 53 | if err != nil { 54 | log.Printf("gpgDecrypt(): ReadMessage: %s", err.Error()) 55 | return []byte{}, err 56 | } 57 | return io.ReadAll(md.UnverifiedBody) 58 | } 59 | 60 | func gpgEncrypt(in []byte, secretKey *openpgp.Entity) ([]byte, error) { 61 | buf := new(bytes.Buffer) 62 | w, err := openpgp.Encrypt(buf, openpgp.EntityList{secretKey}, nil, nil, nil) 63 | if err != nil { 64 | log.Printf("gpgEncrypt(): Encrypt: %s", err.Error()) 65 | return []byte{}, err 66 | } 67 | _, err = w.Write(in) 68 | if err != nil { 69 | log.Printf("gpgEncrypt(): Write: %s", err.Error()) 70 | return []byte{}, err 71 | } 72 | err = w.Close() 73 | if err != nil { 74 | log.Printf("gpgEncrypt(): Close: %s", err.Error()) 75 | return []byte{}, err 76 | } 77 | return buf.Bytes(), nil 78 | } 79 | -------------------------------------------------------------------------------- /gpg/COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /gpg/go.mod: -------------------------------------------------------------------------------- 1 | module github.com/jbuchbinder/go-git-crypt/gpg 2 | 3 | go 1.23 4 | 5 | toolchain go1.23.2 6 | 7 | require ( 8 | github.com/ProtonMail/go-crypto v1.1.5 9 | github.com/bmizerany/assert v0.0.0-20160611221934-b7ed37b82869 10 | ) 11 | 12 | require ( 13 | github.com/cloudflare/circl v1.6.0 // indirect 14 | github.com/kr/pretty v0.1.0 // indirect 15 | github.com/kr/text v0.1.0 // indirect 16 | golang.org/x/crypto v0.33.0 // indirect 17 | golang.org/x/sys v0.30.0 // indirect 18 | ) 19 | -------------------------------------------------------------------------------- /gpg/gpg.go: -------------------------------------------------------------------------------- 1 | package gpg 2 | 3 | import ( 4 | "bytes" 5 | "encoding/hex" 6 | "errors" 7 | "io" 8 | "log" 9 | "os" 10 | "strings" 11 | 12 | "github.com/ProtonMail/go-crypto/openpgp" 13 | "github.com/ProtonMail/go-crypto/openpgp/armor" 14 | "github.com/ProtonMail/go-crypto/openpgp/packet" 15 | ) 16 | 17 | // Decrypt decrypts an input byte array with keys in secretkeyring 18 | func Decrypt(in []byte, secretKeyring openpgp.EntityList) ([]byte, error) { 19 | log.Printf("gpg.Decrypt(%d bytes)", len(in)) 20 | 21 | // Determine if there's any armoring going on 22 | if strings.Contains(string(in), "BEGIN PGP MESSAGE") { 23 | log.Printf("gpg.Decrypt(): Found armored message data") 24 | result, err := armor.Decode(bytes.NewReader(in)) 25 | if err != nil { 26 | return []byte{}, err 27 | } 28 | md, err := openpgp.ReadMessage(result.Body, secretKeyring, nil, nil) 29 | if err != nil { 30 | return []byte{}, err 31 | } 32 | return io.ReadAll(md.UnverifiedBody) 33 | } 34 | 35 | log.Printf("gpg.Decrypt(): Processing raw data") 36 | md, err := openpgp.ReadMessage(bytes.NewReader(in), secretKeyring, nil, nil) 37 | if err != nil { 38 | return []byte{}, err 39 | } 40 | return io.ReadAll(md.UnverifiedBody) 41 | } 42 | 43 | // Encrypt encrypts an input byte array using an opengpg.EntityList 44 | // and a specific key identifier. It can optionally read a file containing 45 | // keys if specified in masterKeyFilePath. It returns encrypted data 46 | // or an error if one is encountered. 47 | func Encrypt(in []byte, publicKeyring openpgp.EntityList, id string, masterKeyFilePath string) ([]byte, error) { 48 | log.Printf("gpg.Encrypt(%d bytes, key %s)", len(in), id) 49 | 50 | myID := id 51 | if myID == "" && len(publicKeyring) > 0 { 52 | myID = EntityID(publicKeyring[0]) 53 | log.Printf("gpg.Encrypt(): Autodetected entity id %s", myID) 54 | } 55 | 56 | key := getKeyByID(publicKeyring, myID) 57 | if key == nil { 58 | return []byte{}, errors.New("gpg.Encrypt(): Unable to locate key " + myID) 59 | } 60 | 61 | var el openpgp.EntityList 62 | if masterKeyFilePath == "" || !fileExists(masterKeyFilePath) { 63 | // Just use the extracted db key 64 | el = openpgp.EntityList{key} 65 | } else { 66 | // Attach the master key to it so that we can decrypt 67 | masterkeyfile, err := os.ReadFile(masterKeyFilePath) 68 | if err != nil { 69 | log.Printf("gpg.Encrypt(): Unable to ingest master GPG key: %s", err.Error()) 70 | el = openpgp.EntityList{key} 71 | } else { 72 | masterkey, err := ArmoredKeyIngest([]byte(masterkeyfile)) 73 | if err != nil { 74 | log.Printf("gpg.Encrypt(): Unable to ingest master GPG key: %s", err.Error()) 75 | el = openpgp.EntityList{key} 76 | } else { 77 | log.Printf("gpg.Encrypt(): Encrypting data with key %s and master key", EntityID(key)) 78 | el = openpgp.EntityList{key, masterkey} 79 | } 80 | } 81 | } 82 | 83 | buf := new(bytes.Buffer) 84 | w, err := openpgp.Encrypt(buf, el, nil, nil, nil) 85 | if err != nil { 86 | return []byte{}, err 87 | } 88 | _, err = w.Write(in) 89 | if err != nil { 90 | return []byte{}, err 91 | } 92 | err = w.Close() 93 | if err != nil { 94 | return []byte{}, err 95 | } 96 | log.Printf("Encrypt(): Outputting %d bytes", len(buf.Bytes())) 97 | return io.ReadAll(buf) 98 | } 99 | 100 | // RawKeyData is a convenience type for []byte, used for ingesting raw GPG 101 | // key data. 102 | type RawKeyData []byte 103 | 104 | // ArmoredKeyIngest extracts a single entity, public or private, from an array 105 | // of bytes. Theoretically we could use openpgp's ReadArmoredKeyRing, but we 106 | // can't really build our own keyring that way, and we're storing these keys 107 | // in separate database records. 108 | func ArmoredKeyIngest(input RawKeyData) (*openpgp.Entity, error) { 109 | block, err := armor.Decode(bytes.NewReader([]byte(input))) 110 | if err != nil { 111 | return nil, err 112 | } 113 | switch block.Type { 114 | case openpgp.PublicKeyType: 115 | // Handle public key block 116 | return openpgp.ReadEntity(packet.NewReader(block.Body)) 117 | case openpgp.PrivateKeyType: 118 | // Handle private key block 119 | return openpgp.ReadEntity(packet.NewReader(block.Body)) 120 | default: 121 | return nil, errors.New("gpg.ArmoredKeyIngest(): Error ingesting key, unsupported type " + block.Type) 122 | } 123 | } 124 | 125 | // KeyArrayToEntityList converts an array of armored GPG key data into an 126 | // opengpg.EntityList, throwing errors if no keys are found or errors are 127 | // encountered during the ingest process. 128 | func KeyArrayToEntityList(ka []RawKeyData) (openpgp.EntityList, error) { 129 | el := make([]*openpgp.Entity, 0) 130 | for _, k := range ka { 131 | e, err := ArmoredKeyIngest(k) 132 | if err != nil { 133 | log.Printf("gpg.KeyArrayToEntityList(): %s", err.Error()) 134 | continue 135 | } 136 | el = append(el, e) 137 | } 138 | if len(el) < 1 { 139 | return openpgp.EntityList(el), errors.New("gpg.KeyArrayToEntityList(): No keys found") 140 | } 141 | return openpgp.EntityList(el), nil 142 | } 143 | 144 | // EntityID extracts the short name string for the ID for an entity. 145 | func EntityID(e *openpgp.Entity) string { 146 | return e.PrimaryKey.KeyIdShortString() 147 | } 148 | 149 | // Fingerprint returns the 40-byte fingerprint name associated with an entity 150 | func Fingerprint(e *openpgp.Entity) string { 151 | return strings.ToUpper(hex.EncodeToString(e.PrimaryKey.Fingerprint[:])) 152 | } 153 | 154 | func getKeyByID(keyring openpgp.EntityList, id string) *openpgp.Entity { 155 | for _, entity := range keyring { 156 | if EntityID(entity) == id { 157 | return entity 158 | } 159 | } 160 | return nil 161 | } 162 | -------------------------------------------------------------------------------- /gpg/gpg_test.go: -------------------------------------------------------------------------------- 1 | package gpg 2 | 3 | import ( 4 | "testing" 5 | 6 | "github.com/ProtonMail/go-crypto/openpgp" 7 | "github.com/bmizerany/assert" 8 | ) 9 | 10 | const ( 11 | PUBKEYTEST = ` 12 | -----BEGIN PGP PUBLIC KEY BLOCK----- 13 | 14 | mQENBFiKxP8BCACkX7sPYKv3NlctXA95y177ylrPQGJ6b97L2aZ7NCGZ6fE1caiG 15 | tMlOLIzbCBFO4Sx0eir4+uSGrLaGbe5S0KHICpHJaFs1eO1AZ3n9DZ9ILN6HkLDh 16 | zhVPrfTMYO3U/Y+Y/CKdRZ4JT/9TqJrRZ3Mm+4kIY1c9KE6FyvsfWg8beovGwG4X 17 | lFN9xG/QFIVnGrNp/a8GdZ8PstG2j21CgFMMZ8ubGEJPV+yOIBnlsnQrm7MQ/fAF 18 | mfSjeUeDmamAgeyoP1PpkHc48S+FIiDztkFTv7Z/80tsh4eUq+M590FbGz5N/HGH 19 | zhn5e94Qtr4f33BhNiiqa0uS+YDJhPKvVmt9ABEBAAG0H1Rlc3QgR1BHIEtleSA8 20 | dGVzdEBnZXRyYXZlLmNvbT6JATcEEwEIACEFAliKxP8CGwMFCwkIBwIGFQgJCgsC 21 | BBYCAwECHgECF4AACgkQWdPltIb1OTOfeQf8Daqfe/iv8qnzncJU2ORrypPFt/Dx 22 | CJPFVVrBZSGo+YoePnpcsgpOUZ5ou1chUc0IwRu7WBQBnqqw1pfbtsAHovk1Bmrj 23 | hc8O2j9Ar++sk1yRvNZrjDTifiYvPpoDmHSK7RXGqzVArwY6tW1p9gc3yeqyGY5K 24 | NTm93h51Wel8TH/lFwwUSdKVc5TuXtQTbI+FIsEt+iHtBSX0gv+5jQihZRzUicQO 25 | SuEEqR3BGlW/rj8gwPHBFjXn4mQ1TKvYDMMCpzlE06zQXVyaQ0Nw6wcPzbHUitE3 26 | xcKXJw1kABKypkwp00w71nAOOtVgq3nFYtMck+VmSXsy+xS8YlA8hH1LO7kBDQRY 27 | isT/AQgA3pbTBOP1+lxUX0Vox4Q7z8BacB95sSdrojgro2q+/RFPZLF6g3/w228u 28 | B9A/4HoOhax3/f6TN0xELVNKc0WdudT6hBy9tvPjkYYVAnWyPPLEgx+H+d5NiBCM 29 | gbUngLnFE/ghkFHL1sfB8Tfuy28aocTMotTCXi6ZzbFSpEU0eo4o+0zPlHcRkE4D 30 | cSDZtQCZR8EhtTkPwPs6ILLIIT1Rgb4rYz4UubBPzwXRP9MyhJM/tvs+8E2u+Mp+ 31 | lsyaGRLMhQfRIXOT3W1iI8Kr3t0Yo6Ff1JRcv/GAN+AmeyBMvGQG7tRer+zA9Oqh 32 | 2xcrUmIEvkxoeHlseDCEi4gcymkkMwARAQABiQEfBBgBCAAJBQJYisT/AhsMAAoJ 33 | EFnT5bSG9TkzqboIAJfMNcYcGHElrxcfG1LkcJCDoXrbsL41PIXx6A/q2LLsftm/ 34 | BEdjuafqkCCStnm4uhTgulm7qtgd+AHxusM5fdcJgk2ro5GAnJ+0QeIkKYj9BhIY 35 | oUn2dLRBywuangq8h3bkOpMrmgHqZidpyfDOFf+vDnG/UVUNizM1+b5i/sf82jYu 36 | L37vJe/Qcd/hXbBAmzeAyxfakNtQO0qSxFlN8L1BwxV+EglYjeHSP266hI9nKCsL 37 | A9XA49bwcNA7V8eKVD9yC/N4vZ+Yvax1sMRXmXLq/GygY32hDafzPz4/q6qCd7mY 38 | usaU2ATq5LWjNhtbP1PrQivCF12C2e0p48cOGTg= 39 | =bhgK 40 | -----END PGP PUBLIC KEY BLOCK----- 41 | ` 42 | PRIVKEYTEST = ` 43 | -----BEGIN PGP PRIVATE KEY BLOCK----- 44 | 45 | lQOYBFiKxP8BCACkX7sPYKv3NlctXA95y177ylrPQGJ6b97L2aZ7NCGZ6fE1caiG 46 | tMlOLIzbCBFO4Sx0eir4+uSGrLaGbe5S0KHICpHJaFs1eO1AZ3n9DZ9ILN6HkLDh 47 | zhVPrfTMYO3U/Y+Y/CKdRZ4JT/9TqJrRZ3Mm+4kIY1c9KE6FyvsfWg8beovGwG4X 48 | lFN9xG/QFIVnGrNp/a8GdZ8PstG2j21CgFMMZ8ubGEJPV+yOIBnlsnQrm7MQ/fAF 49 | mfSjeUeDmamAgeyoP1PpkHc48S+FIiDztkFTv7Z/80tsh4eUq+M590FbGz5N/HGH 50 | zhn5e94Qtr4f33BhNiiqa0uS+YDJhPKvVmt9ABEBAAEAB/4pPkv1Y9BCS0Q8gWjw 51 | qnK+wttePU14YzGH/KilKUN1FxoKyuX6Rspr7wm4u6F8JUu+PhkiN/G3SQbTXCn8 52 | ZZTyWJST8LdSB3GgQ1Z8hDp/JaMAaPG49riqMX/G+Fs0ohqxzDHzPFCXDZeHKjsO 53 | Z+Kg2WRc0nBFTCPHtlKkXziDMCl0BtPM/kAfQi/x6LBlq48LIPOaqOFSE0+zSN51 54 | c2TB63EVUS9x9poHzjMXJ79Z6hSPRtmj6PFc7y7nnBCSP8WAs6MYWKT4QEzuXk6B 55 | LH4A9cTo8cMJlUGIjSap+Gc4/8u0JsYEKLEIlGZe2Xqx2mJHM+rNxwE5IyyI8oi6 56 | If6RBADFGhaT2f5n0uhX4/NzP9EXllprjplG3fYvsnpmAKXJs7JPEKrFrCQsRsd2 57 | hR59I7ohCfd3jkuWG61Tyvltth7RwOhMxb26Of304N88doLQi4UV2Otz4kNJAAA4 58 | 68tBJZcf5DIivvPBDUX81tVbq9fMII3lS0vsB9xxs5wi95yI2wQA1X4EdfxK7YMY 59 | ItGHeO1/9gRVoVFub1A9ghegbZihxbrYr4eXEpoELOfhN8APGZDbbeN6KFdh9xFI 60 | 30Ck1r/bmu1sw5M7Vaw7sfm11T2TGmNqDLbeTo1QNuSl8s24KAqQUCta7odc6b9a 61 | M1/eXxnX4IHSY9nlCjqHBQ7TLU1SwIcD/itdTZjNUquK8rl5QedbLSRIkSoDVHaF 62 | 8zPBFqRCKvjxnNz0SMEgzO4/mkrHMXhOpkd/zGKM+8VCYAVrzEUKguJQ1LGz1UAr 63 | rK2fgnpZW1f9W0PT21VwAnOXbpvlOF93ncOsUwmi+Vxnfs6y9iVtXCZ4MWR2Zfnz 64 | JebbqMgjkghjRnu0H1Rlc3QgR1BHIEtleSA8dGVzdEBnZXRyYXZlLmNvbT6JATcE 65 | EwEIACEFAliKxP8CGwMFCwkIBwIGFQgJCgsCBBYCAwECHgECF4AACgkQWdPltIb1 66 | OTOfeQf8Daqfe/iv8qnzncJU2ORrypPFt/DxCJPFVVrBZSGo+YoePnpcsgpOUZ5o 67 | u1chUc0IwRu7WBQBnqqw1pfbtsAHovk1Bmrjhc8O2j9Ar++sk1yRvNZrjDTifiYv 68 | PpoDmHSK7RXGqzVArwY6tW1p9gc3yeqyGY5KNTm93h51Wel8TH/lFwwUSdKVc5Tu 69 | XtQTbI+FIsEt+iHtBSX0gv+5jQihZRzUicQOSuEEqR3BGlW/rj8gwPHBFjXn4mQ1 70 | TKvYDMMCpzlE06zQXVyaQ0Nw6wcPzbHUitE3xcKXJw1kABKypkwp00w71nAOOtVg 71 | q3nFYtMck+VmSXsy+xS8YlA8hH1LO50DmARYisT/AQgA3pbTBOP1+lxUX0Vox4Q7 72 | z8BacB95sSdrojgro2q+/RFPZLF6g3/w228uB9A/4HoOhax3/f6TN0xELVNKc0Wd 73 | udT6hBy9tvPjkYYVAnWyPPLEgx+H+d5NiBCMgbUngLnFE/ghkFHL1sfB8Tfuy28a 74 | ocTMotTCXi6ZzbFSpEU0eo4o+0zPlHcRkE4DcSDZtQCZR8EhtTkPwPs6ILLIIT1R 75 | gb4rYz4UubBPzwXRP9MyhJM/tvs+8E2u+Mp+lsyaGRLMhQfRIXOT3W1iI8Kr3t0Y 76 | o6Ff1JRcv/GAN+AmeyBMvGQG7tRer+zA9Oqh2xcrUmIEvkxoeHlseDCEi4gcymkk 77 | MwARAQABAAf+I6DMognDA5Hnx2Aax2S5FiXZ0/yVw+9lYQ/QnFWnwGYW6S0nSQkf 78 | imAfZAzHTKz8yhSzGCq5ca55cy/TyOOpvWcDukXHcBNVp6NolX41S2AoaDyRzULx 79 | 8geEFfbjHc2eZ/XdmXYeRICw4GVtiY59GsufXajke6LF55Csg7K4Fa2DFdjDqnpb 80 | oImv7ni8YjxT1FCRUgMUjNNCBtLgIiChMGA8ViA9q/cqkDn/T0YWKH7Pi1ha765U 81 | 2tHqz+MT2dPBf22HP7A2oPBtxKfX5ybNkgAr2xYJjNnxIqxmAzzbrL74ieTNile7 82 | aPtHCqR4sv7xqb5bj/sLzaiWBXGz9YDh4QQA5jf9v+gjTEjsnpKzzQ9kz1qMDukt 83 | jLI+jOCTAzVwpp5UbN0IUumZ7LkMP3ZNHZwX/+A1oMMZazLpNV9vyDUPOYuo+eJE 84 | SQmRUg4RT9g61wfb8wMTtcI53Yd1VJfXL7nGjcP/VJTjlDtFjreQcOC58+f4AiQg 85 | xQClpGUbmbMnjosEAPeEGwsaiTaXDW6gbEvg/bJioW/cSdOX/asy04HVebW/gQ6o 86 | p5VLZ+JYGLh2E35R7schyvrc4ifskPTU0jXggmUQuYKh1vD99Jifx/4xIPH7faGl 87 | rNtwO/STGESlLhmacTi4GYgNVqPAXRTyVt0DaDVUQTwmmRYlrmp46rJCVV35BACL 88 | cW13pN1iNv7pLbZGln6IT9M45OVcRTUjTk1Cwom1fwhxE8OK0YbekME5kQMJ18D2 89 | lSj4lqXtS6z0ZHiOkdmy7auVcaeInmqEtsoiU50ixwC4/eCVudWBrdKjKdoAk/PY 90 | RO/lGPB18EbOzAXlxbM+jnTQ1wLbzjaMOoS45cqT6FLhiQEfBBgBCAAJBQJYisT/ 91 | AhsMAAoJEFnT5bSG9TkzqboIAJfMNcYcGHElrxcfG1LkcJCDoXrbsL41PIXx6A/q 92 | 2LLsftm/BEdjuafqkCCStnm4uhTgulm7qtgd+AHxusM5fdcJgk2ro5GAnJ+0QeIk 93 | KYj9BhIYoUn2dLRBywuangq8h3bkOpMrmgHqZidpyfDOFf+vDnG/UVUNizM1+b5i 94 | /sf82jYuL37vJe/Qcd/hXbBAmzeAyxfakNtQO0qSxFlN8L1BwxV+EglYjeHSP266 95 | hI9nKCsLA9XA49bwcNA7V8eKVD9yC/N4vZ+Yvax1sMRXmXLq/GygY32hDafzPz4/ 96 | q6qCd7mYusaU2ATq5LWjNhtbP1PrQivCF12C2e0p48cOGTg= 97 | =fvlY 98 | -----END PGP PRIVATE KEY BLOCK----- 99 | ` 100 | ENCODEDPAYLOAD = ` 101 | -----BEGIN PGP MESSAGE----- 102 | 103 | owEBeQGG/pANAwAIAVnT5bSG9TkzAaw3YgtwYXlsb2FkLnR4dFiKxn4wMTIzNDU2 104 | Nzg5MEFCQ0RFRkdISUpLTE1OT1BRUlNUVVZXWFlaCokBLgQAAQgAGAUCWIrGfhEc 105 | dGVzdEBnZXRyYXZlLmNvbQAKCRBZ0+W0hvU5M1s3B/wLuo0oKVgi6edX7+ubyaDC 106 | 4/Is9a+R7KphbfnME1d8aUYwZzXqqrssvjXvYzJmWBQ4F1xxTnyCJmLZXKomYIwz 107 | W5pjVkynVpnLBreu3fj50h9lgpIp+j1wUCT5//FR3K0OzoZuGBcvbr5sOUxAymmM 108 | bnGKyIT9Jag6bIoXmB2Vr6ixJ4oT/XzQUANZasHNBssF56m3pzrNTmg9PY0hMBIj 109 | MucHF7Sncg2j1BnaD5ecba9uaBVzXVyFX4UUe0mbMVFV+nLa72yxWAf0pMre3zz9 110 | GQqPhk9TjDV8Zi3HRLzpNd4kVi0fS6x7rMPNnIXiAd8Lwh62YTbQZIeRKwQ3GAOX 111 | =rJNK 112 | -----END PGP MESSAGE----- 113 | ` 114 | DECODEDPAYLOAD = "01234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ\n" 115 | ) 116 | 117 | func TestGpgKeyArmoredDecode(t *testing.T) { 118 | priv, err := ArmoredKeyIngest([]byte(PRIVKEYTEST)) 119 | if err != nil { 120 | t.Fatal(err.Error()) 121 | } 122 | 123 | out, err := Decrypt([]byte(ENCODEDPAYLOAD), openpgp.EntityList{priv}) 124 | if err != nil { 125 | t.Fatal(err.Error()) 126 | } 127 | assert.Equal(t, string(out), DECODEDPAYLOAD) 128 | } 129 | 130 | func TestGpgRoundtrip(t *testing.T) { 131 | pub, err := ArmoredKeyIngest([]byte(PUBKEYTEST)) 132 | if err != nil { 133 | t.Fatal(err.Error()) 134 | } 135 | priv, err := ArmoredKeyIngest([]byte(PRIVKEYTEST)) 136 | if err != nil { 137 | t.Fatal(err.Error()) 138 | } 139 | 140 | enc, err := Encrypt([]byte(DECODEDPAYLOAD), openpgp.EntityList{pub}, "", "") 141 | if err != nil { 142 | t.Fatal(err.Error()) 143 | } 144 | out, err := Decrypt(enc, openpgp.EntityList{priv}) 145 | if err != nil { 146 | t.Fatal(err.Error()) 147 | } 148 | assert.Equal(t, string(out), DECODEDPAYLOAD) 149 | } 150 | -------------------------------------------------------------------------------- /gpg/util.go: -------------------------------------------------------------------------------- 1 | package gpg 2 | 3 | import ( 4 | "os" 5 | ) 6 | 7 | func fileExists(name string) bool { 8 | if _, err := os.Stat(name); err != nil { 9 | if os.IsNotExist(err) { 10 | return false 11 | } 12 | } 13 | return true 14 | } 15 | 16 | -------------------------------------------------------------------------------- /hmac.go: -------------------------------------------------------------------------------- 1 | package gitcrypt 2 | 3 | import ( 4 | "crypto/hmac" 5 | "crypto/sha1" 6 | "hash" 7 | ) 8 | 9 | // HMac represents an HMAC encryptor/decryptor 10 | type HMac struct { 11 | hmacHash hash.Hash 12 | } 13 | 14 | // NewHMac creates an HMac encryptor/decryptor 15 | func NewHMac(key []byte) HMac { 16 | h := HMac{ 17 | hmacHash: hmac.New(sha1.New, key), 18 | } 19 | return h 20 | } 21 | 22 | // Write adds bytes to the HMAC hash 23 | func (h *HMac) Write(w []byte) { 24 | h.hmacHash.Write(w) 25 | } 26 | 27 | // Result returns the resultant sum 28 | func (h *HMac) Result() []byte { 29 | return h.hmacHash.Sum(nil) 30 | } 31 | -------------------------------------------------------------------------------- /key.go: -------------------------------------------------------------------------------- 1 | package gitcrypt 2 | 3 | import ( 4 | "bytes" 5 | "errors" 6 | "fmt" 7 | "io" 8 | "log" 9 | "os" 10 | ) 11 | 12 | // KeyFromFile instantiates a new key from a specified file 13 | func (g *GitCrypt) KeyFromFile(filename string) (Key, error) { 14 | k := Key{Parent: g} 15 | err := k.LoadFromFile(filename) 16 | return k, err 17 | } 18 | 19 | // Key is a git-crypt key structure 20 | type Key struct { 21 | Parent *GitCrypt 22 | Version uint32 23 | Entries []KeyEntry 24 | KeyName string 25 | Debug bool 26 | } 27 | 28 | // Latest returns the latest of the entries from the key file 29 | func (k *Key) Latest() (KeyEntry, error) { 30 | if len(k.Entries) == 0 { 31 | return KeyEntry{}, fmt.Errorf("no entries") 32 | } 33 | return k.Entries[len(k.Entries)-1], nil 34 | } 35 | 36 | // Get retrieves an entry by version number 37 | func (k *Key) Get(version uint32) (KeyEntry, error) { 38 | for _, v := range k.Entries { 39 | if v.Version == version { 40 | return v, nil 41 | } 42 | } 43 | return KeyEntry{}, fmt.Errorf("not found") 44 | } 45 | 46 | // LoadFromFile loads a key from a filesystem file 47 | func (k *Key) LoadFromFile(filename string) error { 48 | if !k.Parent.fileExists(filename) { 49 | return errors.New("file does not exist") 50 | } 51 | fp, err := os.Open(filename) 52 | if err != nil { 53 | return err 54 | } 55 | defer fp.Close() 56 | return k.Load(fp) 57 | } 58 | 59 | // Load imports a key from an io.Reader 60 | func (k *Key) Load(in io.Reader) error { 61 | preamble, err := readXBytes(in, 16) 62 | if err != nil { 63 | return err 64 | } 65 | if preamble[0] != byte(0) && bytes.Compare(preamble[1:13], []byte("GITCRYPTKEY")) != 0 { 66 | return fmt.Errorf("malformed preamble") 67 | } 68 | format, err := readBigEndianUint32(bytes.NewBuffer(preamble[12:])) 69 | if err != nil { 70 | return err 71 | } 72 | if format != formatVersion { 73 | return fmt.Errorf("incompatible version %d", format) 74 | } 75 | k.Version = format 76 | if k.Debug { 77 | log.Printf("format: %x", format) 78 | } 79 | err = k.loadHeader(in) 80 | if err != nil { 81 | return fmt.Errorf("LoadHeader: %s", err.Error()) 82 | } 83 | k.Entries = make([]KeyEntry, 0) 84 | for { 85 | entry := KeyEntry{} 86 | err = entry.Load(in) 87 | if err != nil { 88 | break 89 | } 90 | k.Entries = append(k.Entries, entry) 91 | } 92 | 93 | return nil 94 | } 95 | 96 | // Store stores a copy of the key to a file 97 | func (k Key) Store(out io.Writer) error { 98 | n, err := out.Write([]byte("\x00GITCRYPTKEY")) 99 | if err != nil { 100 | return err 101 | } 102 | if n != 12 { 103 | return fmt.Errorf("unable to write 12 bytes, wrote %d bytes", n) 104 | } 105 | writeBigEndianUint32(out, formatVersion) 106 | 107 | if k.KeyName != "" { 108 | if k.Debug { 109 | log.Printf("Store: KeyName = %s", k.KeyName) 110 | } 111 | err = writeBigEndianUint32(out, headerFieldKeyName) 112 | if err != nil { 113 | return err 114 | } 115 | kn := stringToASCIIBytes(k.KeyName) 116 | err = writeBigEndianUint32(out, uint32(len(kn))) 117 | if err != nil { 118 | return err 119 | } 120 | _, err = out.Write(kn) 121 | if err != nil { 122 | return err 123 | } 124 | } 125 | _ = writeBigEndianUint32(out, headerFieldEnd) 126 | for _, e := range k.Entries { 127 | if k.Debug { 128 | log.Printf("Store: Write Entry: %#v", e) 129 | } 130 | err = e.Store(out) 131 | if err != nil { 132 | return err 133 | } 134 | } 135 | return nil 136 | } 137 | 138 | func (k *Key) loadHeader(in io.Reader) error { 139 | for { 140 | fieldID, err := readBigEndianUint32(in) 141 | if err != nil { 142 | return errors.New("malformed") 143 | } 144 | if fieldID == headerFieldEnd { 145 | break 146 | } 147 | fieldLen, err := readBigEndianUint32(in) 148 | if err != nil { 149 | return errors.New("malformed") 150 | } 151 | 152 | switch fieldID { 153 | case headerFieldKeyName: 154 | if fieldLen > keyNameMaxLength { 155 | return errors.New("malformed") 156 | } 157 | if fieldLen == 0 { 158 | // special case field_len==0 to avoid possible undefined behavior 159 | // edge cases with an empty std::vector (particularly, &bytes[0]). 160 | k.KeyName = "" 161 | } else { 162 | raw, err := readXBytes(in, int(fieldLen)) 163 | if err != nil { 164 | k.KeyName = "" 165 | return errors.New("malformed") 166 | } 167 | k.KeyName = string(raw) 168 | err = validateKeyName(k.KeyName) 169 | if err != nil { 170 | k.KeyName = "" 171 | return errors.New("malformed") 172 | } 173 | } 174 | case fieldID & 1: 175 | return errors.New("incompatible") 176 | default: 177 | // unknown non-critical field - safe to ignore 178 | if fieldLen > maxFieldLength { 179 | return errors.New("malformed") 180 | } 181 | _, err := readXBytes(in, int(fieldLen)) 182 | if err != nil { 183 | return errors.New("malformed") 184 | } 185 | } 186 | } 187 | return nil 188 | } 189 | 190 | // KeyEntry is a key entry 191 | type KeyEntry struct { 192 | Version uint32 193 | AesKey []byte 194 | HmacKey []byte 195 | } 196 | 197 | // Store implements writing a Key 198 | // TODO: FIXME: XXX: FINISH IMPLEMENT 199 | func (k KeyEntry) Store(out io.Writer) error { 200 | err := writeBigEndianUint32(out, keyFieldVersion) 201 | if err != nil { 202 | return err 203 | } 204 | err = writeBigEndianUint32(out, 4) 205 | if err != nil { 206 | return err 207 | } 208 | err = writeBigEndianUint32(out, k.Version) 209 | if err != nil { 210 | return err 211 | } 212 | 213 | // AES key 214 | err = writeBigEndianUint32(out, keyFieldAesKey) 215 | if err != nil { 216 | return err 217 | } 218 | err = writeBigEndianUint32(out, aesKeyLen) 219 | if err != nil { 220 | return err 221 | } 222 | 223 | // HMAC key 224 | err = writeBigEndianUint32(out, keyFieldHmacKey) 225 | if err != nil { 226 | return err 227 | } 228 | err = writeBigEndianUint32(out, hmacKeyLen) 229 | if err != nil { 230 | return err 231 | } 232 | 233 | // End 234 | err = writeBigEndianUint32(out, keyFieldEnd) 235 | return err 236 | } 237 | 238 | // Generate generates a new key 239 | func (k *KeyEntry) Generate(version uint32) error { 240 | k.Version = version 241 | k.AesKey = randomBytes(aesKeyLen) 242 | k.HmacKey = randomBytes(hmacKeyLen) 243 | return nil 244 | } 245 | 246 | // Load loads an entry from a stream 247 | func (k *KeyEntry) Load(in io.Reader) error { 248 | for { 249 | fieldID, err := readBigEndianUint32(in) 250 | if err != nil { 251 | return errors.New("malformed") 252 | } 253 | if fieldID == keyFieldEnd { 254 | break 255 | } 256 | fieldLen, err := readBigEndianUint32(in) 257 | if err != nil { 258 | return errors.New("malformed") 259 | } 260 | switch fieldID { 261 | case keyFieldVersion: 262 | if fieldLen != 4 { 263 | return fmt.Errorf("malformed version") 264 | } 265 | k.Version, err = readBigEndianUint32(in) 266 | if err != nil { 267 | return err 268 | } 269 | case keyFieldAesKey: 270 | if fieldLen != aesKeyLen { 271 | return fmt.Errorf("malformed (bad AES key)") 272 | } 273 | raw, err := readXBytes(in, int(fieldLen)) 274 | if err != nil { 275 | return err 276 | } 277 | k.AesKey = raw 278 | case keyFieldHmacKey: 279 | if fieldLen != hmacKeyLen { 280 | return fmt.Errorf("malformed (bad HMAC key)") 281 | } 282 | raw, err := readXBytes(in, int(fieldLen)) 283 | if err != nil { 284 | return err 285 | } 286 | k.HmacKey = raw 287 | case fieldID & 1: 288 | return fmt.Errorf("malformed") 289 | default: 290 | if fieldLen > maxFieldLength { 291 | return fmt.Errorf("malformed (> maxFieldLength)") 292 | } 293 | _, err := readXBytes(in, int(fieldLen)) 294 | if err != nil { 295 | return err 296 | } 297 | } 298 | } 299 | return nil 300 | } 301 | 302 | func validateKeyName(keyName string) error { 303 | if keyName == "" { 304 | return errors.New("key name may not be empty") 305 | } 306 | 307 | if keyName == "default" { 308 | return errors.New("`default' is not a legal key name") 309 | } 310 | // Need to be restrictive with key names because they're used as part of a Git filter name 311 | for i := 0; i < len(keyName); i++ { 312 | ch := byte(keyName[i]) 313 | if ch >= 'a' && ch <= 'z' { 314 | continue 315 | } 316 | if ch >= 'A' && ch <= 'Z' { 317 | continue 318 | } 319 | if ch >= '0' && ch <= '9' { 320 | continue 321 | } 322 | if ch == '-' || ch == '_' { 323 | continue 324 | } 325 | return errors.New("Key names may contain only A-Z, a-z, 0-9, '-', and '_'") 326 | } 327 | 328 | if len(keyName) > keyNameMaxLength { 329 | return errors.New("key name is too long") 330 | } 331 | return nil 332 | } 333 | -------------------------------------------------------------------------------- /key_test.go: -------------------------------------------------------------------------------- 1 | package gitcrypt 2 | 3 | import ( 4 | "os" 5 | "testing" 6 | ) 7 | 8 | func Test_Key(t *testing.T) { 9 | fp, err := os.Open("testdata/default") 10 | if err != nil { 11 | t.Error(err) 12 | } 13 | defer fp.Close() 14 | k := Key{Debug: true} 15 | err = k.Load(fp) 16 | if err != nil { 17 | t.Error(err) 18 | } 19 | t.Logf("%#v", k) 20 | } 21 | -------------------------------------------------------------------------------- /util.go: -------------------------------------------------------------------------------- 1 | package gitcrypt 2 | 3 | import ( 4 | "errors" 5 | "fmt" 6 | "io" 7 | "math/rand" 8 | "os" 9 | ) 10 | 11 | func (g *GitCrypt) fileExists(name string) bool { 12 | if g.Vfs == nil { 13 | if _, err := os.Stat(name); err != nil { 14 | if os.IsNotExist(err) { 15 | return false 16 | } 17 | } 18 | return true 19 | } 20 | if _, err := g.Vfs.Stat(name); err != nil { 21 | if os.IsNotExist(err) { 22 | return false 23 | } 24 | } 25 | return true 26 | } 27 | 28 | func readBigEndianUint32(in io.Reader) (uint32, error) { 29 | data := make([]byte, 4) 30 | n, err := in.Read(data) 31 | if err != nil { 32 | return 0, err 33 | } 34 | if n != 4 { 35 | return 0, errors.New("unable to read 4 bytes") 36 | } 37 | //log.Printf("readBigEndianUint32 : %#v", data) 38 | return uint32(data[0])<<24 + uint32(data[1])<<16 + uint32(data[2])<<8 + uint32(data[3]), nil 39 | } 40 | 41 | //func storeBigEndian32(p []byte, i uint32) { 42 | // binary.BigEndian.PutUint32(p, i) 43 | //} 44 | 45 | func writeBigEndianUint32(out io.Writer, val uint32) error { 46 | data := make([]byte, 4) 47 | 48 | data[0] = byte(val >> 24) 49 | data[1] = byte(val >> 16) 50 | data[2] = byte(val >> 8) 51 | data[3] = byte(val % 256) 52 | //log.Printf("writeBigEndianUint32 : %#v", data) 53 | 54 | n, err := out.Write(data) 55 | if err != nil { 56 | return err 57 | } 58 | if n != 4 { 59 | return errors.New("unable to write 4 bytes") 60 | } 61 | return nil 62 | } 63 | 64 | func readXBytes(in io.Reader, l int) ([]byte, error) { 65 | b := make([]byte, l) 66 | n, err := in.Read(b) 67 | if err != nil { 68 | return []byte{}, err 69 | } 70 | if n != l { 71 | return b, fmt.Errorf("expected %d bytes, read %d bytes", n, l) 72 | } 73 | return b, nil 74 | } 75 | 76 | func stringToASCIIBytes(s string) []byte { 77 | out := make([]byte, 0) 78 | runes := []rune(s) 79 | for i := range runes { 80 | out = append(out, byte(runes[i])) 81 | } 82 | return out 83 | } 84 | 85 | func randomBytes(length uint32) []byte { 86 | out := make([]byte, length) 87 | for i := 0; i < int(length); i++ { 88 | out[i] = byte(rand.Intn(255)) 89 | } 90 | return out 91 | } 92 | 93 | func leaklessEquals(a []byte, b []byte, len int) bool { 94 | diff := 0 95 | l := len 96 | pos := 0 97 | for { 98 | if l <= 0 { 99 | break 100 | } 101 | diff |= int(a[pos] ^ b[pos]) 102 | l-- 103 | pos++ 104 | } 105 | 106 | return diff == 0 107 | } 108 | -------------------------------------------------------------------------------- /vars.go: -------------------------------------------------------------------------------- 1 | package gitcrypt 2 | 3 | const ( 4 | nonceLength = 12 5 | aesBlockLength = 16 6 | headerFieldEnd = 0 7 | headerFieldKeyName = 1 8 | keyFieldEnd = 0 9 | keyFieldVersion = 1 10 | keyFieldAesKey = 3 11 | keyFieldHmacKey = 5 12 | maxFieldLength = 1 << 20 13 | keyNameMaxLength = 128 14 | hmacKeyLen = 64 15 | aesKeyLen = 32 16 | formatVersion = 2 17 | aesEncryptorNonceLen = 12 18 | aesEncryptorKeyLen = aesKeyLen 19 | aesEncryptorBlockLen = 16 20 | aesEncryptorMaxCryptBytes = (1 << 32) * 16 // Don't encrypt more than this or the CTR value will repeat itself 21 | ) 22 | 23 | var ( 24 | // gitCryptHeader is the constant header which is present in all 25 | // git-crypted files 26 | gitCryptHeader = []byte{0, 'G', 'I', 'T', 'C', 'R', 'Y', 'P', 'T'} 27 | ) 28 | --------------------------------------------------------------------------------