diff --git a/crypt/EXTENSIONS.md b/crypt/EXTENSIONS.md new file mode 100644 index 0000000..0e50b9e --- /dev/null +++ b/crypt/EXTENSIONS.md @@ -0,0 +1,192 @@ +# Extensions Guide + +This document describes how to implement new encryption backends for acme-crypt. + +## Architecture Overview + +The acme-crypt tools use a pluggable architecture based on Go interfaces. New encryption backends can be added by implementing the `Crypter` interface defined in `internal/crypt/crypt.go`. + +## Interface Definition + +```go +type Crypter interface { + Decrypt(encryptedData []byte) ([]byte, error) + Encrypt(plainData []byte) ([]byte, error) +} +``` + +## Implementing a New Backend + +### 1. Create the Backend + +Create a new type that implements the `Crypter` interface: + +```go +type MyEncryptionBackend struct { + // Configuration fields + keyPath string + config *MyConfig +} + +func NewMyEncryptionBackend() *MyEncryptionBackend { + return &MyEncryptionBackend{ + // Initialize from environment variables or config + } +} + +func (m *MyEncryptionBackend) Decrypt(encryptedData []byte) ([]byte, error) { + // Implement decryption logic + return decryptedData, nil +} + +func (m *MyEncryptionBackend) Encrypt(plainData []byte) ([]byte, error) { + // Implement encryption logic + return encryptedData, nil +} +``` + +### 2. Add Backend Selection + +Modify the main functions in `cmd/CryptGet/main.go` and `cmd/CryptPut/main.go` to support backend selection: + +```go +func createCrypter() crypt.Crypter { + backend := os.Getenv("ACME_CRYPT_BACKEND") + switch backend { + case "gpg", "": + return crypt.NewGPGCrypter() + case "age": + return crypt.NewAgeCrypter() + case "openssl": + return crypt.NewOpenSSLCrypter() + default: + fmt.Fprintf(os.Stderr, "Unknown backend: %s\n", backend) + os.Exit(1) + } +} +``` + +### 3. Handle File Extensions + +Update the extension handling in `GetOutputFilename()` to recognize your backend's file extensions: + +```go +func GetOutputFilename(filename string) string { + extensions := []string{".gpg", ".asc", ".pgp", ".age", ".enc"} + for _, ext := range extensions { + if strings.HasSuffix(filename, ext) { + return strings.TrimSuffix(filename, ext) + } + } + return filename +} +``` + +## Configuration + +### Environment Variables + +Backends should use environment variables for configuration: + +- `ACME_CRYPT_BACKEND` - Backend selection (e.g., "gpg", "age", "openssl") +- Backend-specific variables (e.g., `ACME_CRYPT_RCPT` for GPG recipient) + +### Example Backend Configurations + +#### GPG Backend (Current) +```bash +export ACME_CRYPT_BACKEND="gpg" +export ACME_CRYPT_RCPT="user@example.com" +``` + +#### Hypothetical Age Backend +```bash +export ACME_CRYPT_BACKEND="age" +export ACME_CRYPT_AGE_RECIPIENTS_FILE="$HOME/.config/age/recipients" +``` + +#### Hypothetical OpenSSL Backend +```bash +export ACME_CRYPT_BACKEND="openssl" +export ACME_CRYPT_CERT_FILE="$HOME/.config/crypt/cert.pem" +export ACME_CRYPT_KEY_FILE="$HOME/.config/crypt/key.pem" +``` + +## Error Handling + +Backends should: +- Return descriptive errors for common failure cases +- Preserve environment variables needed for GUI operations (like `DISPLAY`) +- Handle missing configuration gracefully +- Use stderr for error output (goes to Acme's +Errors buffer) + +## Testing Your Backend + +1. **Build the tools**: `mk install` +2. **Set environment variables** for your backend +3. **Test decryption**: Create an encrypted file, highlight it in Acme, run `CryptGet` +4. **Test encryption**: Edit decrypted content, run `CryptPut` +5. **Verify roundtrip**: Ensure the encrypted file can be decrypted again + +## Example: Age Backend Implementation + +```go +package crypt + +import ( + "bytes" + "os" + "os/exec" +) + +type AgeCrypter struct { + recipientsFile string +} + +func NewAgeCrypter() *AgeCrypter { + recipientsFile := os.Getenv("ACME_CRYPT_AGE_RECIPIENTS_FILE") + if recipientsFile == "" { + recipientsFile = os.Getenv("HOME") + "/.config/age/recipients" + } + return &AgeCrypter{recipientsFile: recipientsFile} +} + +func (a *AgeCrypter) Decrypt(encryptedData []byte) ([]byte, error) { + cmd := exec.Command("age", "--decrypt") + cmd.Stdin = bytes.NewReader(encryptedData) + + var stdout, stderr bytes.Buffer + cmd.Stdout = &stdout + cmd.Stderr = &stderr + + if err := cmd.Run(); err != nil { + return nil, fmt.Errorf("age decrypt failed: %v\nstderr: %s", err, stderr.String()) + } + + return stdout.Bytes(), nil +} + +func (a *AgeCrypter) Encrypt(plainData []byte) ([]byte, error) { + cmd := exec.Command("age", "--recipients-file", a.recipientsFile) + cmd.Stdin = bytes.NewReader(plainData) + + var stdout, stderr bytes.Buffer + cmd.Stdout = &stdout + cmd.Stderr = &stderr + + if err := cmd.Run(); err != nil { + return nil, fmt.Errorf("age encrypt failed: %v\nstderr: %s", err, stderr.String()) + } + + return stdout.Bytes(), nil +} +``` + +## Contributing + +When adding new backends: +1. Follow the existing code style and patterns +2. Add appropriate error handling and logging +3. Update documentation and examples +4. Test thoroughly with Acme integration +5. Consider security implications of your implementation \ No newline at end of file diff --git a/crypt/LICENSE b/crypt/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/crypt/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/crypt/README.md b/crypt/README.md new file mode 100644 index 0000000..5461c06 --- /dev/null +++ b/crypt/README.md @@ -0,0 +1,86 @@ +# acme-crypt + +Go wrapper programs for Acme that interface with encryption/decryption tools to automatically handle encrypted files. **Currently only supports GPG**, though designed with a pluggable interface for future encryption backends. + +## Overview + +This package provides two commands: +- `CryptGet` - Decrypts an encrypted file and opens it in a new Acme window +- `CryptPut` - Encrypts the contents of an Acme window and saves to disk + +## Installation + +1. Clone the repository: + ```bash + git clone git@github.com:lneely/acme-crypt.git + cd acme-crypt + ``` + +2. Install the binaries: + ```bash + mk install + ``` + +This installs `CryptGet` and `CryptPut` to `$HOME/bin/`. + +## Configuration + +Set your GPG recipient in the environment: +```bash +export ACME_CRYPT_RCPT="your@email.com" +``` + +Ensure your GPG agent is configured with a GUI pinentry program (e.g., pinentry-qt, pinentry-gtk3) since Acme runs in a non-interactive environment. + +## Usage + +### Decrypting Files (CryptGet) + +1. In Acme, highlight an encrypted file (`.gpg`, `.asc`, or `.pgp`) +2. Add `CryptGet` to the window tag +3. Highlight the encrypted filename, hold the middle button then left click on CryptGet to decrypt and open the file. +4. A new window opens with the decrypted content, named after the original file without the encryption extension +5. The new window automatically has `CryptPut` added to its tag. + +### Encrypting Files (CryptPut) + +1. Edit the decrypted file content in the Acme window created by CryptGet +2. Middle-click on `CryptPut` in the window tag +3. The content is encrypted and saved back to the original encrypted file path + +## Workflow Example + +``` +1. File: sensitive-data.txt.gpg +2. Highlight "sensitive-data.txt.gpg" in Acme +3. Middle-click CryptGet → Opens window "sensitive-data.txt" with decrypted content +4. Edit the content as needed +5. Middle-click CryptPut → Saves encrypted content back to sensitive-data.txt.gpg +``` + +## Supported File Extensions + +CryptGet automatically strips these extensions when creating the editing window: +- `.gpg` +- `.asc` +- `.pgp` + +## Architecture + +The program uses a pluggable interface design in `internal/crypt/`: +- `Crypter` interface for encryption/decryption operations +- `GPGCrypter` implementation for GPG backend +- Acme integration utilities for window management + +This design allows for easy addition of other encryption tools (OpenSSL, age, etc.) in the future, though currently only GPG is implemented. + +## Requirements + +- Go 1.19+ +- Acme text editor +- GPG with configured keys +- GUI pinentry program (pinentry-qt, pinentry-gtk3, etc.) + +## License + +GNU General Public License v3 \ No newline at end of file diff --git a/crypt/cmd/CryptGet/main.go b/crypt/cmd/CryptGet/main.go new file mode 100644 index 0000000..4a1e0f8 --- /dev/null +++ b/crypt/cmd/CryptGet/main.go @@ -0,0 +1,49 @@ +package main + +import ( + "os" + "path/filepath" + + "github.com/lkn/acme-crypt/internal/crypt" +) + +func main() { + if len(os.Args) != 2 { + crypt.WriteToStderr("Usage: CryptGet \n") + os.Exit(1) + } + + encryptedFile := os.Args[1] + if !filepath.IsAbs(encryptedFile) { + wd, err := os.Getwd() + if err != nil { + crypt.WriteToStderr("Failed to get working directory: %v\n", err) + os.Exit(1) + } + encryptedFile = filepath.Join(wd, encryptedFile) + } + + if _, err := os.Stat(encryptedFile); os.IsNotExist(err) { + crypt.WriteToStderr("File does not exist: %s\n", encryptedFile) + os.Exit(1) + } + + crypter, err := crypt.GetCrypter() + if err != nil { + crypt.WriteToStderr("Failed to initialize crypter: %v\n", err) + os.Exit(1) + } + + decryptedContent, err := crypter.Decrypt(encryptedFile) + if err != nil { + crypt.WriteToStderr("Failed to decrypt file: %v\n", err) + os.Exit(1) + } + + windowName := crypt.StripCryptExtension(encryptedFile) + + if err := crypt.CreateAcmeWindow(windowName, decryptedContent); err != nil { + crypt.WriteToStderr("Failed to create acme window: %v\n", err) + os.Exit(1) + } +} \ No newline at end of file diff --git a/crypt/cmd/CryptPut/main.go b/crypt/cmd/CryptPut/main.go new file mode 100644 index 0000000..ff89af3 --- /dev/null +++ b/crypt/cmd/CryptPut/main.go @@ -0,0 +1,36 @@ +package main + +import ( + "os" + + "github.com/lkn/acme-crypt/internal/crypt" +) + +func main() { + content, err := crypt.GetCurrentAcmeWindowContent() + if err != nil { + crypt.WriteToStderr("Failed to get acme window content: %v\n", err) + os.Exit(1) + } + + windowName, err := crypt.GetCurrentAcmeWindowName() + if err != nil { + crypt.WriteToStderr("Failed to get acme window name: %v\n", err) + os.Exit(1) + } + + crypter, err := crypt.GetCrypter() + if err != nil { + crypt.WriteToStderr("Failed to initialize crypter: %v\n", err) + os.Exit(1) + } + + outputPath := crypt.AddGPGExtension(windowName) + + if err := crypter.Encrypt(content, outputPath); err != nil { + crypt.WriteToStderr("Failed to encrypt and save file: %v\n", err) + os.Exit(1) + } + + crypt.WriteToStderr("Encrypted and saved to: %s\n", outputPath) +} \ No newline at end of file diff --git a/crypt/go.mod b/crypt/go.mod new file mode 100644 index 0000000..716075f --- /dev/null +++ b/crypt/go.mod @@ -0,0 +1,5 @@ +module github.com/lkn/acme-crypt + +go 1.21 + +require 9fans.net/go v0.0.7 // indirect diff --git a/crypt/go.sum b/crypt/go.sum new file mode 100644 index 0000000..d81a876 --- /dev/null +++ b/crypt/go.sum @@ -0,0 +1,34 @@ +9fans.net/go v0.0.7 h1:H5CsYJTf99C8EYAQr+uSoEJnLP/iZU8RmDuhyk30iSM= +9fans.net/go v0.0.7/go.mod h1:Rxvbbc1e+1TyGMjAvLthGTyO97t+6JMQ6ly+Lcs9Uf0= +dmitri.shuralyov.com/gpu/mtl v0.0.0-20201218220906-28db891af037/go.mod h1:H6x//7gZCb22OMCxBHrMx7a5I7Hp++hsVxbQ4BYO7hU= +github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo= +github.com/go-gl/glfw/v3.3/glfw v0.0.0-20200222043503-6f7a984d4dc4/go.mod h1:tQ2UAYgL5IevRw8kRxooKSPJfGvJ9fJQFa0TUsXzTg8= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20190510104115-cbcb75029529/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= +golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= +golang.org/x/exp v0.0.0-20190731235908-ec7cb31e5a56/go.mod h1:JhuoJpWY28nO4Vef9tZUw9qufEGTyX1+7lmHxV5q5G4= +golang.org/x/exp v0.0.0-20210405174845-4513512abef3/go.mod h1:I6l2HNBLBZEcrOoCpyKLdY2lHoRZ8lI4x60KMCQDft4= +golang.org/x/image v0.0.0-20190227222117-0694c2d4d067/go.mod h1:kZ7UVZpmo3dzQBMxlp+ypCbDeSB+sBbTgSJuh5dn5js= +golang.org/x/image v0.0.0-20190802002840-cff245a6509b/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0= +golang.org/x/mobile v0.0.0-20190312151609-d3739f865fa6/go.mod h1:z+o9i4GpDbdi3rU15maQ/Ox0txvL9dWGYEHz965HBQE= +golang.org/x/mobile v0.0.0-20201217150744-e6ae53a27f4f/go.mod h1:skQtrUTUwhdJvXM/2KKJzY8pDgNr9I/FOMqDVRPBUS4= +golang.org/x/mobile v0.0.0-20210220033013-bdb1ca9a1e08/go.mod h1:skQtrUTUwhdJvXM/2KKJzY8pDgNr9I/FOMqDVRPBUS4= +golang.org/x/mod v0.1.0/go.mod h1:0QHyrYULN0/3qlju5TqG8bIK38QM8yzMo5ekMj3DlcY= +golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg= +golang.org/x/mod v0.1.1-0.20191209134235-331c550502dd/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= +golang.org/x/mod v0.3.1-0.20200828183125-ce943fd02449/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= +golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20191001151750-bb3f8db39f24/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210415045647-66c3f260301c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/tools v0.0.0-20190312151545-0bb0c0a6e846/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= +golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.0.0-20200117012304-6edc0a871e69/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= +golang.org/x/tools v0.0.0-20200207183749-b753a1ba74fa/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= +golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= diff --git a/crypt/internal/crypt/acme.go b/crypt/internal/crypt/acme.go new file mode 100644 index 0000000..9237945 --- /dev/null +++ b/crypt/internal/crypt/acme.go @@ -0,0 +1,111 @@ +package crypt + +import ( + "fmt" + "os" + "path/filepath" + "strconv" + "strings" + + "9fans.net/go/acme" +) + +func CreateAcmeWindow(name string, content []byte) error { + // Create new acme window + w, err := acme.New() + if err != nil { + return fmt.Errorf("failed to create acme window: %w", err) + } + + // Set window name + if err := w.Name("%s", name); err != nil { + w.Del(true) // Clean up on error + return fmt.Errorf("failed to set window name: %w", err) + } + + // Append CryptPut to the window tag + if _, err := w.Write("tag", []byte(" CryptPut")); err != nil { + w.Del(true) // Clean up on error + return fmt.Errorf("failed to append CryptPut to tag: %w", err) + } + + // Write content to window body + if _, err := w.Write("body", content); err != nil { + w.Del(true) // Clean up on error + return fmt.Errorf("failed to write to acme window body: %w", err) + } + + return nil +} + +func GetCurrentAcmeWindowContent() ([]byte, error) { + winIDStr := os.Getenv("winid") + if winIDStr == "" { + return nil, fmt.Errorf("not running in acme window (winid not set)") + } + + winID, err := strconv.Atoi(winIDStr) + if err != nil { + return nil, fmt.Errorf("invalid winid: %w", err) + } + + // Open the current window by ID + w, err := acme.Open(winID, nil) + if err != nil { + return nil, fmt.Errorf("failed to open acme window: %w", err) + } + defer w.CloseFiles() + + // Read content from window body + content, err := w.ReadAll("body") + if err != nil { + return nil, fmt.Errorf("failed to read acme window body: %w", err) + } + + return content, nil +} + +func GetCurrentAcmeWindowName() (string, error) { + winIDStr := os.Getenv("winid") + if winIDStr == "" { + return "", fmt.Errorf("not running in acme window (winid not set)") + } + + winID, err := strconv.Atoi(winIDStr) + if err != nil { + return "", fmt.Errorf("invalid winid: %w", err) + } + + // Open the current window by ID + w, err := acme.Open(winID, nil) + if err != nil { + return "", fmt.Errorf("failed to open acme window: %w", err) + } + defer w.CloseFiles() + + // Read the window tag + tag, err := w.ReadAll("tag") + if err != nil { + return "", fmt.Errorf("failed to read acme window tag: %w", err) + } + + tagFields := strings.Fields(string(tag)) + if len(tagFields) == 0 { + return "", fmt.Errorf("empty tag") + } + + windowName := tagFields[0] + if !filepath.IsAbs(windowName) { + wd, err := os.Getwd() + if err != nil { + return "", fmt.Errorf("failed to get working directory: %w", err) + } + windowName = filepath.Join(wd, windowName) + } + + return windowName, nil +} + +func WriteToStderr(format string, args ...interface{}) { + fmt.Fprintf(os.Stderr, format, args...) +} \ No newline at end of file diff --git a/crypt/internal/crypt/crypt.go b/crypt/internal/crypt/crypt.go new file mode 100644 index 0000000..6fe2c2e --- /dev/null +++ b/crypt/internal/crypt/crypt.go @@ -0,0 +1,107 @@ +package crypt + +import ( + "bytes" + "fmt" + "os" + "os/exec" + "path/filepath" + "strings" +) + +type Crypter interface { + Decrypt(filePath string) ([]byte, error) + Encrypt(data []byte, outputPath string) error +} + +// Backend registry +var backends = map[string]func() (Crypter, error){ + "gpg": func() (Crypter, error) { return NewGPGCrypter() }, +} + +// GetCrypter returns a Crypter instance based on ACME_CRYPT_BACKEND environment variable +// Defaults to GPG if not set +func GetCrypter() (Crypter, error) { + backend := os.Getenv("ACME_CRYPT_BACKEND") + if backend == "" { + backend = "gpg" // Default to GPG + } + + constructor, exists := backends[backend] + if !exists { + return nil, fmt.Errorf("unsupported backend: %s", backend) + } + + return constructor() +} + +// RegisterBackend allows registration of new backend types +func RegisterBackend(name string, constructor func() (Crypter, error)) { + backends[name] = constructor +} + +type GPGCrypter struct { + recipient string +} + +func NewGPGCrypter() (*GPGCrypter, error) { + recipient := os.Getenv("ACME_CRYPT_RCPT") + if recipient == "" { + return nil, fmt.Errorf("ACME_CRYPT_RCPT environment variable not set") + } + return &GPGCrypter{recipient: recipient}, nil +} + +func (g *GPGCrypter) Decrypt(filePath string) ([]byte, error) { + cmd := exec.Command("gpg", "--decrypt", "--quiet", "--batch", "--no-tty", filePath) + var stdout, stderr bytes.Buffer + cmd.Stdout = &stdout + cmd.Stderr = &stderr + + // Preserve DISPLAY for GUI pinentry + cmd.Env = append(os.Environ(), "DISPLAY="+os.Getenv("DISPLAY")) + + if err := cmd.Run(); err != nil { + return nil, fmt.Errorf("gpg decrypt failed: %w\nstderr: %s", err, stderr.String()) + } + + return stdout.Bytes(), nil +} + +func (g *GPGCrypter) Encrypt(data []byte, outputPath string) error { + // Remove existing file if it exists + if _, err := os.Stat(outputPath); err == nil { + if err := os.Remove(outputPath); err != nil { + return fmt.Errorf("failed to remove existing file %s: %w", outputPath, err) + } + } + + cmd := exec.Command("gpg", "--encrypt", "--armor", "--recipient", g.recipient, "--batch", "--no-tty", "--output", outputPath) + cmd.Stdin = bytes.NewReader(data) + var stderr bytes.Buffer + cmd.Stderr = &stderr + + // Preserve DISPLAY for GUI pinentry + cmd.Env = append(os.Environ(), "DISPLAY="+os.Getenv("DISPLAY")) + + if err := cmd.Run(); err != nil { + return fmt.Errorf("gpg encrypt failed: %w\nstderr: %s", err, stderr.String()) + } + + return nil +} + +func StripCryptExtension(filePath string) string { + ext := strings.ToLower(filepath.Ext(filePath)) + if ext == ".gpg" || ext == ".asc" || ext == ".pgp" { + return strings.TrimSuffix(filePath, ext) + } + return filePath +} + +func AddGPGExtension(filePath string) string { + if !strings.HasSuffix(strings.ToLower(filePath), ".gpg") { + return filePath + ".gpg" + } + return filePath +} \ No newline at end of file diff --git a/crypt/mkfile b/crypt/mkfile new file mode 100644 index 0000000..13cb94c --- /dev/null +++ b/crypt/mkfile @@ -0,0 +1,6 @@ +install:V: + go build -o $HOME/bin/CryptGet ./cmd/CryptGet + go build -o $HOME/bin/CryptPut ./cmd/CryptPut + +clean:V: + rm -f $HOME/bin/CryptGet $HOME/bin/CryptPut \ No newline at end of file diff --git a/putplus/README.md b/putplus/README.md new file mode 100644 index 0000000..ddeb506 --- /dev/null +++ b/putplus/README.md @@ -0,0 +1,29 @@ +# acme-put+ + +Save files with elevated privileges from the Acme editor using PolicyKit. + +## Usage + +1. Open a file with restricted privileges (e.g., `/etc/hosts`) in Acme +2. Make your edits in the Acme window +3. Add `Put+` to the window's tag line +4. Middle-click `Put+` to save with elevated privileges +5. You'll be prompted for your password via PolicyKit + +## Requirements + +- PolicyKit (`pkexec` command) +- A graphical PolicyKit authentication agent +- Acme text editor from Plan 9 from User Space + +## Installation + +``` +mk install +``` + +This installs the `Put+` binary to `$HOME/bin/`. + +## How it works + +When executed, `Put+` reads the current Acme window content and filename, then uses `pkexec tee` to write the file with elevated privileges. PolicyKit handles the authentication prompt through your desktop environment's authentication agent. \ No newline at end of file diff --git a/putplus/cmd/Put+/main.go b/putplus/cmd/Put+/main.go new file mode 100644 index 0000000..479d65b --- /dev/null +++ b/putplus/cmd/Put+/main.go @@ -0,0 +1,60 @@ +package main + +import ( + "os" + "os/exec" + "path/filepath" + + "github.com/lkn/acme-put+/internal/acme" +) + +func main() { + content, err := acme.GetCurrentAcmeWindowContent() + if err != nil { + acme.WriteToStderr("Failed to get acme window content: %v\n", err) + os.Exit(1) + } + + windowName, err := acme.GetCurrentAcmeWindowName() + if err != nil { + acme.WriteToStderr("Failed to get acme window name: %v\n", err) + os.Exit(1) + } + + if err := writeWithPrivileges(content, windowName); err != nil { + acme.WriteToStderr("Failed to write file with privileges: %v\n", err) + os.Exit(1) + } + + acme.WriteToStderr("Successfully wrote to: %s\n", windowName) +} + +func writeWithPrivileges(content []byte, filePath string) error { + filePath = filepath.Clean(filePath) + + cmd := exec.Command("pkexec", "tee", filePath) + cmd.Stdout = os.Stdout + cmd.Stderr = os.Stderr + + stdin, err := cmd.StdinPipe() + if err != nil { + return err + } + + if err := cmd.Start(); err != nil { + return err + } + + if _, err := stdin.Write(content); err != nil { + stdin.Close() + cmd.Wait() + return err + } + + if err := stdin.Close(); err != nil { + cmd.Wait() + return err + } + + return cmd.Wait() +} \ No newline at end of file diff --git a/putplus/go.mod b/putplus/go.mod new file mode 100644 index 0000000..24b296e --- /dev/null +++ b/putplus/go.mod @@ -0,0 +1,5 @@ +module github.com/lkn/acme-put+ + +go 1.21 + +require 9fans.net/go v0.0.7 diff --git a/putplus/go.sum b/putplus/go.sum new file mode 100644 index 0000000..d81a876 --- /dev/null +++ b/putplus/go.sum @@ -0,0 +1,34 @@ +9fans.net/go v0.0.7 h1:H5CsYJTf99C8EYAQr+uSoEJnLP/iZU8RmDuhyk30iSM= +9fans.net/go v0.0.7/go.mod h1:Rxvbbc1e+1TyGMjAvLthGTyO97t+6JMQ6ly+Lcs9Uf0= +dmitri.shuralyov.com/gpu/mtl v0.0.0-20201218220906-28db891af037/go.mod h1:H6x//7gZCb22OMCxBHrMx7a5I7Hp++hsVxbQ4BYO7hU= +github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo= +github.com/go-gl/glfw/v3.3/glfw v0.0.0-20200222043503-6f7a984d4dc4/go.mod h1:tQ2UAYgL5IevRw8kRxooKSPJfGvJ9fJQFa0TUsXzTg8= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20190510104115-cbcb75029529/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= +golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= +golang.org/x/exp v0.0.0-20190731235908-ec7cb31e5a56/go.mod h1:JhuoJpWY28nO4Vef9tZUw9qufEGTyX1+7lmHxV5q5G4= +golang.org/x/exp v0.0.0-20210405174845-4513512abef3/go.mod h1:I6l2HNBLBZEcrOoCpyKLdY2lHoRZ8lI4x60KMCQDft4= +golang.org/x/image v0.0.0-20190227222117-0694c2d4d067/go.mod h1:kZ7UVZpmo3dzQBMxlp+ypCbDeSB+sBbTgSJuh5dn5js= +golang.org/x/image v0.0.0-20190802002840-cff245a6509b/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0= +golang.org/x/mobile v0.0.0-20190312151609-d3739f865fa6/go.mod h1:z+o9i4GpDbdi3rU15maQ/Ox0txvL9dWGYEHz965HBQE= +golang.org/x/mobile v0.0.0-20201217150744-e6ae53a27f4f/go.mod h1:skQtrUTUwhdJvXM/2KKJzY8pDgNr9I/FOMqDVRPBUS4= +golang.org/x/mobile v0.0.0-20210220033013-bdb1ca9a1e08/go.mod h1:skQtrUTUwhdJvXM/2KKJzY8pDgNr9I/FOMqDVRPBUS4= +golang.org/x/mod v0.1.0/go.mod h1:0QHyrYULN0/3qlju5TqG8bIK38QM8yzMo5ekMj3DlcY= +golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg= +golang.org/x/mod v0.1.1-0.20191209134235-331c550502dd/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= +golang.org/x/mod v0.3.1-0.20200828183125-ce943fd02449/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= +golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20191001151750-bb3f8db39f24/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210415045647-66c3f260301c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/tools v0.0.0-20190312151545-0bb0c0a6e846/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= +golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.0.0-20200117012304-6edc0a871e69/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= +golang.org/x/tools v0.0.0-20200207183749-b753a1ba74fa/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= +golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= diff --git a/putplus/internal/acme/acme.go b/putplus/internal/acme/acme.go new file mode 100644 index 0000000..e2b2d6a --- /dev/null +++ b/putplus/internal/acme/acme.go @@ -0,0 +1,79 @@ +package acme + +import ( + "fmt" + "os" + "path/filepath" + "strconv" + "strings" + + "9fans.net/go/acme" +) + +func GetCurrentAcmeWindowContent() ([]byte, error) { + winIDStr := os.Getenv("winid") + if winIDStr == "" { + return nil, fmt.Errorf("not running in acme window (winid not set)") + } + + winID, err := strconv.Atoi(winIDStr) + if err != nil { + return nil, fmt.Errorf("invalid winid: %w", err) + } + + w, err := acme.Open(winID, nil) + if err != nil { + return nil, fmt.Errorf("failed to open acme window: %w", err) + } + defer w.CloseFiles() + + content, err := w.ReadAll("body") + if err != nil { + return nil, fmt.Errorf("failed to read acme window body: %w", err) + } + + return content, nil +} + +func GetCurrentAcmeWindowName() (string, error) { + winIDStr := os.Getenv("winid") + if winIDStr == "" { + return "", fmt.Errorf("not running in acme window (winid not set)") + } + + winID, err := strconv.Atoi(winIDStr) + if err != nil { + return "", fmt.Errorf("invalid winid: %w", err) + } + + w, err := acme.Open(winID, nil) + if err != nil { + return "", fmt.Errorf("failed to open acme window: %w", err) + } + defer w.CloseFiles() + + tag, err := w.ReadAll("tag") + if err != nil { + return "", fmt.Errorf("failed to read acme window tag: %w", err) + } + + tagFields := strings.Fields(string(tag)) + if len(tagFields) == 0 { + return "", fmt.Errorf("empty tag") + } + + windowName := tagFields[0] + if !filepath.IsAbs(windowName) { + wd, err := os.Getwd() + if err != nil { + return "", fmt.Errorf("failed to get working directory: %w", err) + } + windowName = filepath.Join(wd, windowName) + } + + return windowName, nil +} + +func WriteToStderr(format string, args ...interface{}) { + fmt.Fprintf(os.Stderr, format, args...) +} \ No newline at end of file diff --git a/putplus/mkfile b/putplus/mkfile new file mode 100644 index 0000000..782be4e --- /dev/null +++ b/putplus/mkfile @@ -0,0 +1,5 @@ +install:V: + go build -o $HOME/bin/Put+ ./cmd/Put+ + +clean:V: + rm -f $HOME/bin/Put+ \ No newline at end of file