sequoia-keystore-gpg-agent-0.4.0/.cargo_vcs_info.json0000644000000001470000000000100162170ustar { "git": { "sha1": "f64d3a767c22cf7e7b774fd890f047dbe8417fff" }, "path_in_vcs": "gpg-agent" }sequoia-keystore-gpg-agent-0.4.0/Cargo.toml0000644000000044230000000000100142160ustar # THIS FILE IS AUTOMATICALLY GENERATED BY CARGO # # When uploading crates to the registry Cargo will automatically # "normalize" Cargo.toml files for maximal compatibility # with all versions of Cargo and also rewrite `path` dependencies # to registry (e.g., crates.io) dependencies. # # If you are reading this file be aware that the original Cargo.toml # will likely look very different (and much more reasonable). # See Cargo.toml.orig for the original contents. [package] edition = "2021" rust-version = "1.70" name = "sequoia-keystore-gpg-agent" version = "0.4.0" authors = ["Neal H. Walfield "] description = "A gpg-agent backend for Sequoia's private key store." homepage = "https://sequoia-pgp.org/" readme = "README.md" keywords = [ "cryptography", "openpgp", ] categories = ["cryptography"] license = "LGPL-2.0-or-later" repository = "https://gitlab.com/sequoia-pgp/sequoia-keystore" [package.metadata.docs.rs] features = ["sequoia-openpgp/default"] [dependencies.anyhow] version = "1.0.18" [dependencies.async-trait] version = "0.1" [dependencies.futures] version = "0.3" [dependencies.lazy_static] version = "1.4.0" [dependencies.log] version = "0.4.17" [dependencies.openpgp-cert-d] version = "0.3.1" [dependencies.sequoia-gpg-agent] version = "0.4.1" [dependencies.sequoia-ipc] version = "0.35" [dependencies.sequoia-keystore-backend] version = "0.6" [dependencies.sequoia-openpgp] version = "1.17" default-features = false [dependencies.tokio] version = "1.19" features = [ "rt-multi-thread", "io-util", "net", ] [dev-dependencies.env_logger] version = ">=0.10, <0.12" [dev-dependencies.sequoia-openpgp] version = "1" features = ["compression"] default-features = false [dev-dependencies.tracing] version = "0.1" default-features = false [dev-dependencies.tracing-subscriber] version = "0.3" features = ["env-filter"] default-features = false [target."cfg(not(windows))".dev-dependencies.sequoia-openpgp] version = "1" features = [ "crypto-nettle", "__implicit-crypto-backend-for-tests", ] default-features = false [target."cfg(windows)".dev-dependencies.sequoia-openpgp] version = "1" features = [ "crypto-cng", "__implicit-crypto-backend-for-tests", ] default-features = false [badges.maintenance] status = "actively-developed" sequoia-keystore-gpg-agent-0.4.0/Cargo.toml.orig000064400000000000000000000033131046102023000176740ustar 00000000000000[package] name = "sequoia-keystore-gpg-agent" description = "A gpg-agent backend for Sequoia's private key store." version = "0.4.0" authors = ["Neal H. Walfield "] homepage = "https://sequoia-pgp.org/" repository = "https://gitlab.com/sequoia-pgp/sequoia-keystore" readme = "README.md" keywords = ["cryptography", "openpgp"] categories = ["cryptography"] license = "LGPL-2.0-or-later" edition = "2021" rust-version = "1.70" [badges] maintenance = { status = "actively-developed" } [dependencies] anyhow = "1.0.18" async-trait = "0.1" futures = "0.3" lazy_static = "1.4.0" log = "0.4.17" openpgp-cert-d = "0.3.1" sequoia-gpg-agent = "0.4.1" sequoia-keystore-backend = { path = "../backend", version = "0.6" } sequoia-openpgp = { version = "1.17", default-features = false } sequoia-ipc = "0.35" tokio = { version = "1.19", features = [ "rt-multi-thread", "io-util", "net" ] } [dev-dependencies] env_logger = ">=0.10, <0.12" sequoia-openpgp = { version = "1", default-features = false, features = ["compression"] } tracing = {version = "0.1", default-features = false} tracing-subscriber = {version = "0.3", default-features = false, features = ["env-filter"]} # Enables a crypto backend for the tests: [target.'cfg(not(windows))'.dev-dependencies] sequoia-openpgp = { version = "1", default-features = false, features = ["crypto-nettle", "__implicit-crypto-backend-for-tests"] } # Enables a crypto backend for the tests: [target.'cfg(windows)'.dev-dependencies] sequoia-openpgp = { version = "1", default-features = false, features = ["crypto-cng", "__implicit-crypto-backend-for-tests"] } # Enables a crypto backend for the docs.rs generation: [package.metadata.docs.rs] features = ["sequoia-openpgp/default"] sequoia-keystore-gpg-agent-0.4.0/LICENSE.txt000064400000000000000000000627341046102023000166440ustar 00000000000000Sequoia PGP is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. Sequoia PGP 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, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. --- GNU LIBRARY GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1991 Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. [This is the first released version of the library GPL. It is numbered 2 because it goes with version 2 of the ordinary GPL.] Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public Licenses are intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This license, the Library General Public License, applies to some specially designated Free Software Foundation software, and to any other libraries whose authors decide to use it. You can use it for your libraries, 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 this service 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 make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library, or if you modify it. For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave you. You must make sure that they, too, receive or can get the source code. If you link a program with the library, you must provide complete object files to the recipients so that they can relink them with the library, after making changes to the library and recompiling it. And you must show them these terms so they know their rights. Our method of protecting your rights has two steps: (1) copyright the library, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the library. Also, for each distributor's protection, we want to make certain that everyone understands that there is no warranty for this free library. If the library is modified by someone else and passed on, we want its recipients to know that what they have is not the original version, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that companies distributing free software will individually obtain patent licenses, thus in effect transforming the program into proprietary software. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. Most GNU software, including some libraries, is covered by the ordinary GNU General Public License, which was designed for utility programs. This license, the GNU Library General Public License, applies to certain designated libraries. This license is quite different from the ordinary one; be sure to read it in full, and don't assume that anything in it is the same as in the ordinary license. The reason we have a separate public license for some libraries is that they blur the distinction we usually make between modifying or adding to a program and simply using it. Linking a program with a library, without changing the library, is in some sense simply using the library, and is analogous to running a utility program or application program. However, in a textual and legal sense, the linked executable is a combined work, a derivative of the original library, and the ordinary General Public License treats it as such. Because of this blurred distinction, using the ordinary General Public License for libraries did not effectively promote software sharing, because most developers did not use the libraries. We concluded that weaker conditions might promote sharing better. However, unrestricted linking of non-free programs would deprive the users of those programs of all benefit from the free status of the libraries themselves. This Library General Public License is intended to permit developers of non-free programs to use free libraries, while preserving your freedom as a user of such programs to change the free libraries that are incorporated in them. (We have not seen how to achieve this as regards changes in header files, but we have achieved it as regards changes in the actual functions of the Library.) The hope is that this will lead to faster development of free libraries. The precise terms and conditions for copying, distribution and modification follow. Pay close attention to the difference between a "work based on the library" and a "work that uses the library". The former contains code derived from the library, while the latter only works together with the library. Note that it is possible for a library to be covered by the ordinary General Public License rather than by this special one. GNU LIBRARY GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any software library which contains a notice placed by the copyright holder or other authorized party saying it may be distributed under the terms of this Library General Public License (also called "this License"). Each licensee is addressed as "you". A "library" means a collection of software functions and/or data prepared so as to be conveniently linked with application programs (which use some of those functions and data) to form executables. The "Library", below, refers to any such software library or work which has been distributed under these terms. A "work based on the Library" means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is included without limitation in the term "modification".) "Source code" for a work means the preferred form of the work for making modifications to it. For a library, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the library. Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running a program using the Library is not restricted, and output from such a program is covered only if its contents constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does. 1. You may copy and distribute verbatim copies of the Library's complete source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and distribute a copy of this License along with the Library. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Library or any portion of it, thus forming a work based on the Library, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) The modified work must itself be a software library. b) You must cause the files modified to carry prominent notices stating that you changed the files and the date of any change. c) You must cause the whole of the work to be licensed at no charge to all third parties under the terms of this License. d) If a facility in the modified Library refers to a function or a table of data to be supplied by an application program that uses the facility, other than as an argument passed when the facility is invoked, then you must make a good faith effort to ensure that, in the event an application does not supply such function or table, the facility still operates, and performs whatever part of its purpose remains meaningful. (For example, a function in a library to compute square roots has a purpose that is entirely well-defined independent of the application. Therefore, Subsection 2d requires that any application-supplied function or table used by this function must be optional: if the application does not supply it, the square root function must still compute square roots.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Library, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Library, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Library. In addition, mere aggregation of another work not based on the Library with the Library (or with a work based on the Library) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may opt to apply the terms of the ordinary GNU General Public License instead of this License to a given copy of the Library. To do this, you must alter all the notices that refer to this License, so that they refer to the ordinary GNU General Public License, version 2, instead of to this License. (If a newer version than version 2 of the ordinary GNU General Public License has appeared, then you can specify that version instead if you wish.) Do not make any other change in these notices. Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy. This option is useful when you wish to copy part of the code of the Library into a program that is not a library. 4. You may copy and distribute the Library (or a portion or derivative of it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange. If distribution of object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place satisfies the requirement to distribute the source code, even though third parties are not compelled to copy the source along with the object code. 5. A program that contains no derivative of any portion of the Library, but is designed to work with the Library by being compiled or linked with it, is called a "work that uses the Library". Such a work, in isolation, is not a derivative work of the Library, and therefore falls outside the scope of this License. However, linking a "work that uses the Library" with the Library creates an executable that is a derivative of the Library (because it contains portions of the Library), rather than a "work that uses the library". The executable is therefore covered by this License. Section 6 states terms for distribution of such executables. When a "work that uses the Library" uses material from a header file that is part of the Library, the object code for the work may be a derivative work of the Library even though the source code is not. Whether this is true is especially significant if the work can be linked without the Library, or if the work is itself a library. The threshold for this to be true is not precisely defined by law. If such an object file uses only numerical parameters, data structure layouts and accessors, and small macros and small inline functions (ten lines or less in length), then the use of the object file is unrestricted, regardless of whether it is legally a derivative work. (Executables containing this object code plus portions of the Library will still fall under Section 6.) Otherwise, if the work is a derivative of the Library, you may distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself. 6. As an exception to the Sections above, you may also compile or link a "work that uses the Library" with the Library to produce a work containing portions of the Library, and distribute that work under terms of your choice, provided that the terms permit modification of the work for the customer's own use and reverse engineering for debugging such modifications. You must give prominent notice with each copy of the work that the Library is used in it and that the Library and its use are covered by this License. You must supply a copy of this License. If the work during execution displays copyright notices, you must include the copyright notice for the Library among them, as well as a reference directing the user to the copy of this License. Also, you must do one of these things: a) Accompany the work with the complete corresponding machine-readable source code for the Library including whatever changes were used in the work (which must be distributed under Sections 1 and 2 above); and, if the work is an executable linked with the Library, with the complete machine-readable "work that uses the Library", as object code and/or source code, so that the user can modify the Library and then relink to produce a modified executable containing the modified Library. (It is understood that the user who changes the contents of definitions files in the Library will not necessarily be able to recompile the application to use the modified definitions.) b) Accompany the work with a written offer, valid for at least three years, to give the same user the materials specified in Subsection 6a, above, for a charge no more than the cost of performing this distribution. c) If distribution of the work is made by offering access to copy from a designated place, offer equivalent access to copy the above specified materials from the same place. d) Verify that the user has already received a copy of these materials or that you have already sent this user a copy. For an executable, the required form of the "work that uses the Library" must include any data and utility programs needed for reproducing the executable from it. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. It may happen that this requirement contradicts the license restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute. 7. You may place library facilities that are a work based on the Library side-by-side in a single library together with other library facilities not covered by this License, and distribute such a combined library, provided that the separate distribution of the work based on the Library and of the other library facilities is otherwise permitted, and provided that you do these two things: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities. This must be distributed under the terms of the Sections above. b) Give prominent notice with the combined library of the fact that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 8. You may not copy, modify, sublicense, link with, or distribute the Library except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, link with, or distribute the Library is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 9. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Library or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Library (or any work based on the Library), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Library or works based on it. 10. Each time you redistribute the Library (or any work based on the Library), the recipient automatically receives a license from the original licensor to copy, distribute, link with or modify the Library subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 11. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), 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 distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Library at all. For example, if a patent license would not permit royalty-free redistribution of the Library by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Library. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply, and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 12. If the distribution and/or use of the Library is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Library under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 13. The Free Software Foundation may publish revised and/or new versions of the Library 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 Library specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Library does not specify a license version number, you may choose any version ever published by the Free Software Foundation. 14. If you wish to incorporate parts of the Library into other free programs whose distribution conditions are incompatible with these, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY "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 LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE LIBRARY 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 LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Libraries If you develop a new library, and you want it to be of the greatest possible use to the public, we recommend making it free software that everyone can redistribute and change. You can do so by permitting redistribution under these terms (or, alternatively, under the terms of the ordinary General Public License). To apply these terms, attach the following notices to the library. It is safest to attach them to the start of each source file to most effectively convey 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 library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This library 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 Library General Public License for more details. You should have received a copy of the GNU Library General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Also add information on how to contact you by electronic and paper mail. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the library, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the library `Frob' (a library for tweaking knobs) written by James Random Hacker. , 1 April 1990 Ty Coon, President of Vice That's all there is to it! sequoia-keystore-gpg-agent-0.4.0/README.md000064400000000000000000000032431046102023000162660ustar 00000000000000A `gpg-agent` backend for Sequoia's private key store. The `sequoia-keystore` crate implements a server that manages secret keys. Secret key material can be stored in files, on hardware devices like smartcards, or accessed via the network. `sequoia-keystore` doesn't implement these access methods. This is taken care of by various backends. This crate includes a backend that exposes the secret keys managed by a `gpg-agent` process. By default, this backend uses the default `gpg-agent`, i.e., the one for `$HOME/.gnupg`. Whereas the keystore and consequently this backend make use of OpenPGP data structures, `gpg-agent` uses a lower-level representation, which is independent of the encoding. As a first approximation, `gpg-agent` works with the low-level public and private keys, and does not know about OpenPGP metadata. A consequence of this is that it can also work with X.509 keys. `gpg-agent` addresses keys using their so-called keygrip, which is basically a hash of the public key material. This can usually be derived from the OpenPGP key material (although the function is not total). This backend finds the OpenPGP keys corresponding to the low-level keys managed by the `gpg-agent` by iterating over all OpenPGP certificates stored in the user's default [certificate store]. If the backend doesn't find a key with the corresponding keygrip, it does not expose that key; it is unusable. If the certificate is known, the key can be exposed by simply importing the certificate in the usual way: ```sh $ sq cert import cert.pgp ``` The backend doesn't need to be restarted, it will pick it up on its own. [certificate store]: https://gitlab.com/sequoia-pgp/pgp-cert-d sequoia-keystore-gpg-agent-0.4.0/src/certd.rs000064400000000000000000000104171046102023000172460ustar 00000000000000use std::collections::HashMap; use std::collections::HashSet; use std::path::Path; use futures::lock::Mutex; use futures::lock::MutexGuard; use sequoia_openpgp as openpgp; use openpgp::cert::raw::RawCert; use openpgp::packet::Key; use openpgp::packet::key::PublicParts; use openpgp::packet::key::UnspecifiedRole; use openpgp::parse::Parse; use openpgp_cert_d as cert_d; use crate::Keygrip; use crate::Result; struct CertDCache { certd_tag: Option, // A cache of the keygrip to keys. keys: HashMap>, } pub struct CertD { certd: cert_d::CertD, cache: Mutex, } impl CertD { /// Opens the default cert-d. pub fn new() -> Result { Ok(CertD { certd: cert_d::CertD::new()?, cache: Mutex::new(CertDCache { certd_tag: None, keys: HashMap::default(), }), }) } /// Opens the specified cert-d. pub fn open

(path: P) -> Result where P: AsRef { Ok(CertD { certd: cert_d::CertD::with_base_dir(path.as_ref())?, cache: Mutex::new(CertDCache { certd_tag: None, keys: HashMap::default(), }), }) } /// Returns a reference to the underlying cert-d. pub fn certd(&self) -> &cert_d::CertD { &self.certd } // Check that the in-memory cache is up to date, and rebuild it if // necessary. fn rescan<'a>(&self, mut cache: MutexGuard<'a, CertDCache>) -> MutexGuard<'a, CertDCache> { let certd_tag = self.certd.tag(); if let Some(tag) = cache.certd_tag.as_ref() { if tag == &certd_tag { // Up to date. return cache; } } // Rebuild the cache. // // We should probably parallelize this, but we are only // dealing with raw certificates, so even for 1000s of // certificates this is pretty fast. let mut items = Vec::with_capacity(128); for item in self.certd.iter_files() { let (fingerprint, f) = match item { Ok(r) => r, Err(err) => { log::debug!("Reading certd: {}", err); continue; } }; let cert = match RawCert::from_reader(f) { Ok(cert) => cert, Err(err) => { log::debug!("Parsing certificate for {}: {}", fingerprint, err); continue; } }; for key in cert.keys() { let Ok(keygrip) = Keygrip::of(key.mpis()) else { continue; }; items.push((keygrip.clone(), key.clone())); } } cache.certd_tag = Some(certd_tag); cache.keys = HashMap::from_iter(items.into_iter()); cache } /// Look up certificates by their keygrips. pub async fn find(&self, keygrips: HashSet<&Keygrip>) -> Result>> { let cache = self.cache.lock().await; // To avoid blocking the current thread, we run the rescan // function on a separate thread. It signals that it is done // by sending the result via a one-shot channel, which we can // asynchronously wait on. This avoids blocking the main // thread. let (sender, receiver) = futures::channel::oneshot::channel::<_>(); std::thread::scope(|s| { s.spawn(move || { sender.send(self.rescan(cache)) }); }); let cache = receiver.await?; let mut items = HashMap::default(); for keygrip in keygrips { if let Some(key) = cache.keys.get(keygrip) { log::trace!("{} maps to {}", keygrip, key.fingerprint()); items.insert(keygrip.clone(), key.clone()); } else { log::debug!("{} unusable: can't find the public key \ (try running: gpg --export | sq cert import)", keygrip); } } Ok(items) } } sequoia-keystore-gpg-agent-0.4.0/src/lib.rs000064400000000000000000000635641046102023000167260ustar 00000000000000use std::collections::HashMap; use std::collections::HashSet; use std::ops::Deref; use std::path::Path; use std::sync::Arc; use std::sync::Weak; use futures::lock::Mutex; use anyhow::Context; use sequoia_openpgp as openpgp; use openpgp::Cert; use openpgp::Fingerprint; use openpgp::Result; use openpgp::crypto::Password; use openpgp::crypto::SessionKey; use openpgp::crypto::mpi; use openpgp::packet; use openpgp::types::HashAlgorithm; use openpgp::types::PublicKeyAlgorithm; use sequoia_gpg_agent as gpg_agent; use gpg_agent::sequoia_ipc as ipc; use ipc::Keygrip; use sequoia_keystore_backend as backend; use backend::DeviceHandle; use backend::Error; use backend::ImportStatus; use backend::PasswordSource; use backend::Protection; use backend::utils::Directory; mod certd; #[derive(Clone)] pub struct Backend { inner: Arc>, } struct BackendInternal { home: Directory, // gpg-agent doesn't store the OpenPGP key data structures nor // does it have all the information required to reconstruct them // (in particular, it's missing the key's creation time). // Instead, we the so-called keygrip which is more or less a hash // over the public key material. But, to use a key, we need the // OpenPGP public key. We look for it opportunistically in the // user's default cert-d. (For ephemeral backends, we use a // cert-d in the ephemeral directory.) Since looking up a key by // keygrip means doing a full scan, we cache the results. certd: Arc, // One device per agent. devices: Vec, } /// A Device exposes the (usable) keys managed by a particular /// gpg-agent. /// /// A key is usable if we have the OpenPGP data structure. If we /// don't have the OpenPGP key, we ignore the key. #[derive(Clone)] pub struct Device { // $GNUPGHOME (escaped). id: String, inner: Arc> } impl Device { /// Creates a new `WeakDevice` from this `Device`. fn downgrade(&self) -> WeakDevice { WeakDevice { id: self.id.clone(), inner: Arc::downgrade(&self.inner), } } } /// A `Device`, but with a weak reference to the data. /// /// Before you use this, you need to upgrade this to a `Device`. #[derive(Clone)] pub struct WeakDevice { id: String, inner: Weak>, } impl WeakDevice { /// Upgrades the `WeakDevice` to a `Device`, if possible. fn upgrade(&self) -> Option { Some(Device { id: self.id.clone(), inner: self.inner.upgrade()?, }) } } struct DeviceInternal { // $GNUPGHOME (escaped). id: String, agent: Arc>, // See the documentation for BackendInternal.certd. certd: Arc, // A map from id (fingerprint) to key. keys: HashMap, } #[derive(Clone)] pub struct Key { // The fingerprint is also the id. fpr: Fingerprint, inner: Arc>, } /// A secret key. struct KeyInternal { device: WeakDevice, keygrip: Keygrip, fingerprint: Fingerprint, public_key: packet::Key, agent: Arc>, /// The cached password. password: Option, } impl Backend { /// Initializes a gpg-agent backend. /// /// `home` is the directory where the backend will look for its /// configuration, e.g., `$HOME/.sq/keystore/gpg-agent`. /// /// If `default` is true, this backend uses the default GnuPG home /// directory, i.e., `$HOME/.gnupg`, by default. pub async fn init>(home: P, default: bool) -> Result { log::trace!("Backend::init"); let home = Directory::from(home.as_ref()); let certd = Arc::new(certd::CertD::new()?); let agents: &[(&str, Option<&Path>)] = if default { &[ ("default", None), ][..] } else { &[][..] }; Ok(Self::init_internal(home, &agents[..], certd).await?) } /// Initializes an ephemeral gpg-agent backend. /// /// This is primarily useful for testing. pub async fn init_ephemeral() -> Result { log::trace!("Backend::init_ephemeral"); let home = Directory::ephemeral()?; let agents: &[(String, Option<&Path>)] = &[ (home.display().to_string(), Some(home.deref())), ][..]; let certd_directory = home.to_path_buf().join("pgp.cert.d"); std::fs::create_dir_all(&certd_directory) .with_context(|| { format!("Creating {}", certd_directory.display()) })?; let certd = Arc::new(certd::CertD::open(certd_directory)?); Ok(Self::init_internal(home.clone(), &agents[..], certd).await?) } async fn init_internal(home: Directory, agents: &[ (S, Option<&Path>) ], certd: Arc) -> Result where S: AsRef { log::trace!("Backend::init_internal"); log::info!("sequoia-keystore-gpg-agent's home directory is: {}", home.display()); let mut devices = Vec::with_capacity(agents.len()); for (id, path) in agents { let id = id.as_ref(); let agent = if let Some(path) = path { gpg_agent::Agent::connect_to(path).await? } else { gpg_agent::Agent::connect_to_default().await? }; let mut device = Device { id: id.to_string(), inner: Arc::new(Mutex::new(DeviceInternal { id: id.to_string(), agent: Arc::new(Mutex::new(agent)), certd: Arc::clone(&certd), keys: HashMap::new(), })) }; if let Err(err) = device.scan().await { log::info!("Failed to connect to gpg-agent for {}: {}", id.to_string(), err); } devices.push(device); } Ok(Backend { inner: Arc::new(Mutex::new(BackendInternal { home, certd, devices, })) }) } } #[async_trait::async_trait] impl backend::Backend for Backend { fn id(&self) -> String { "gpg-agent".into() } async fn scan(&mut self) -> Result<()> { log::trace!("Backend::scan"); let mut backend = self.inner.lock().await; for device in backend.devices.iter_mut() { if let Err(err) = device.scan().await { log::info!("While scanning {}: {}", device.id(), err); } } Ok(()) } async fn list<'a>(&'a self) -> Box> + Send + Sync + 'a> { log::trace!("Backend::list"); let backend = self.inner.lock().await; Box::new( backend.devices.iter() .map(|device| { Box::new(device.clone()) as Box }) .collect::>() .into_iter()) } async fn find_device<'a>(&self, id: &str) -> Result> { log::trace!("Backend::find_device"); let backend = self.inner.lock().await; for device in backend.devices.iter() { if device.id == id { return Ok(Box::new(device.clone()) as Box); } } Err(Error::NotFound(id.into()).into()) } async fn find_key<'a>(&self, id: &str) -> Result> { log::trace!("Backend::find_key"); let backend = self.inner.lock().await; // The first time through we look for the key without // scanning. If we don't find it, then we rescan. for scan in [false, true] { for device in backend.devices.iter() { let device_ref = device; let mut device = device.inner.lock().await; if scan { log::trace!("Rescanning {}", device.id); if let Err(err) = device.scan(device_ref).await { log::info!("Failed to connect to gpg-agent for {}: {}", device.id, err); } } for (key_id, key) in device.keys.iter() { if &key_id.to_string() == id { return Ok(Box::new(key.clone()) as Box); } } } } Err(Error::NotFound(id.into()).into()) } async fn import<'a>(&self, _cert: Cert) -> Result)>> { log::trace!("Backend::import"); Err(Error::ExternalImportRequired(Some( "To import a key into a gpg-agent, use something like: \ gpg --import key.pgp".into())).into()) } } impl Device { async fn scan(&mut self) -> Result<()> { let mut device = self.inner.lock().await; device.scan(&self).await } } impl DeviceInternal { /// Scans. /// /// This interface is a bit awkward so that it can be called while /// the device lock is held. async fn scan(&mut self, device_ref: &Device) -> Result<()> { log::trace!("DeviceInternal::scan"); let mut agent = self.agent.lock().await; // List the keys available on the agent. let keyinfos = match agent.list_keys().await { Ok(keyinfos) => keyinfos, Err(err) => { log::debug!("Listing keys on the agent for {}: {}", self.id, err); return Ok(()); } }; log::trace!("Agent has {} keys: {}", keyinfos.len(), keyinfos .iter() .map(|keyinfo| { keyinfo.keygrip().to_string() }) .collect::>() .join(", ")); let agent_keygrips: HashSet<&Keygrip> = keyinfos.iter().map(|i| i.keygrip()).collect(); // List our keys. let mut our_keys: Vec<(Keygrip, Fingerprint)> = Vec::with_capacity(self.keys.len()); for key in self.keys.values() { let key = key.inner.lock().await; our_keys.push((key.keygrip.clone(), key.fingerprint.clone())); } let our_keygrips: HashSet<&Keygrip> = HashSet::from_iter(our_keys.iter().map(|(keygrip, _)| keygrip)); // Add any new keys. let new_keygrips = agent_keygrips.difference(&our_keygrips); match self.certd.find(HashSet::from_iter(new_keygrips.cloned())).await { Ok(certs) => { for (keygrip, public_key) in certs.into_iter() { let fingerprint = public_key.fingerprint(); self.keys.insert( fingerprint.clone(), Key { fpr: fingerprint.clone(), inner: Arc::new(Mutex::new(KeyInternal { device: device_ref.downgrade(), keygrip, fingerprint, public_key, agent: Arc::clone(&self.agent), password: None, })), }); } } Err(err) => { log::debug!("Listing cert-d: {}", err); } } // If some keys were removed on the agent, then remove them // locally. let removed_keygrips = our_keygrips.difference(&agent_keygrips); let mut our_keys_map: Option> = None; for removed_keygrip in removed_keygrips { let our_keys_map = our_keys_map.get_or_insert_with(|| { HashMap::from_iter( our_keys.iter().map(|(keygrip, fpr)| (keygrip, fpr))) }); let fpr = &our_keys_map.get(removed_keygrip).expect("have it"); self.keys.remove(&fpr); } Ok(()) } } #[async_trait::async_trait] impl backend::DeviceHandle for Device { fn id(&self) -> String { log::trace!("Device::id"); self.id.clone() } async fn available(&self) -> bool { log::trace!("Device::available"); true } async fn configured(&self) -> bool { log::trace!("Device::configured"); true } async fn registered(&self) -> bool { log::trace!("Device::registered"); true } async fn lock(&mut self) -> Result<()> { log::trace!("Device::lock"); // This is a noop: an agent can't be locked. Ok(()) } async fn list<'a>(&'a self) -> Box> + Send + Sync + 'a> { log::trace!("Device::list"); let device_ref = self; let mut device = self.inner.lock().await; if let Err(err) = device.scan(device_ref).await { log::info!("Failed to connect to gpg-agent for {}: {}", device.id, err); } let keys = device.keys.values() .map(|key| { Box::new(key.clone()) as Box }) .collect::>(); Box::new(keys.into_iter()) } } #[async_trait::async_trait] impl backend::KeyHandle for Key { fn id(&self) -> String { log::trace!("Key::id"); self.fpr.to_string() } fn fingerprint(&self) -> Fingerprint { log::trace!("Key::fingerprint"); self.fpr.clone() } async fn device<'a>(&self) -> Box { let key = self.inner.lock().await; let device = key.device.upgrade().expect("device lives longer than key"); drop(key); Box::new(device) } /// Returns whether the key is available. /// /// A key managed by gpg-agent is considered to *not* be available /// if: /// /// - It is disabled /// - It is missing /// - It is on a smartcard, and the smartcard is not inserted. async fn available(&self) -> bool { log::trace!("Key::available"); let key = self.inner.lock().await; let mut agent = key.agent.lock().await; let Ok(keyinfo) = agent.key_info(&key.keygrip).await else { // If this fails, the key was deleted. In that case, // return false as we clearly can't address the key. return false; }; // Keys that are disabled or missing are not available. if keyinfo.key_disabled() || keyinfo.keytype() == gpg_agent::keyinfo::KeyType::Missing { return false; } if keyinfo.keytype() == gpg_agent::keyinfo::KeyType::Smartcard { // On a smart card. See if the smart card is inserted. match agent.card_info().await { Ok(cardinfo) => { return cardinfo.keys().any(|fpr| fpr == key.fingerprint); } Err(err) => { log::debug!("Getting smartcard info from gpg-agent: {}", err); } } false } else { // Soft key. true } } async fn locked(&self) -> Protection { log::trace!("Key::locked"); let key = self.inner.lock().await; let mut agent = key.agent.lock().await; let Ok(keyinfo) = agent.key_info(&key.keygrip).await else { // If this fails, the key was deleted. In that case, just // return Unlocked: it doesn't matter; we can't address // the key. return Protection::Unlocked; }; drop(agent); drop(key); // As a first approximation, a key is locked if it has // protection, and the passphrase is not cached. // // A signing key may be locked and the passphrase may be // cached, but if `ignore-cache-for-signing` is set, then // `gpg` will prompt for a passphrase anyways. Unfortunately, // AFAICS there is no way to determine if // `ignore-cache-for-signing` is set using gpg-agent's IPC // interface. if keyinfo.protection() == &gpg_agent::keyinfo::KeyProtection::NotProtected { Protection::Unlocked } else { // It's protected... probably. It could be the key is on // a smartcard, and the slot is unlocked. Unfortunately, // we have no reliably way to find out. if keyinfo.passphrase_cached() { Protection::Unlocked } else { Protection::ExternalPassword(Some("\ This key is protected by GnuPG's agent. To continue, \ you may need to provide your password to GnuPG's \ pinentry".to_string())) } } } async fn password_source(&self) -> PasswordSource { PasswordSource::ExternalSideEffect } async fn decryption_capable(&self) -> bool { log::trace!("Key::decryption_capable"); let key = self.inner.lock().await; key.public_key.pk_algo().for_encryption() } async fn signing_capable(&self) -> bool { log::trace!("Key::signing_capable"); let key = self.inner.lock().await; key.public_key.pk_algo().for_signing() } async fn unlock(&mut self, password: Option<&Password>) -> Result<()> { log::trace!("Key::unlock"); let password = if let Some(password) = password { // We can use the password, but only if loopback mode is // enabled. password } else { // We can only prompt as a side effect. return Err(Error::NoExternalPassword( Some("Cannot prompt user for password".into())).into()); }; let mut key = self.inner.lock().await; key.password = Some(password.clone()); Ok(()) } async fn lock(&mut self) -> Result<()> { log::trace!("Key::lock"); let mut key = self.inner.lock().await; // Clear our local cache. key.password = None; // Clear the password on the agent. let mut agent = key.agent.lock().await; agent.forget_passphrase(&key.keygrip.to_string(), |_| ()).await?; Ok(()) } async fn public_key(&self) -> packet::Key { log::trace!("Key::public_key"); let key = self.inner.lock().await; key.public_key.clone() } async fn decrypt_ciphertext(&mut self, ciphertext: &mpi::Ciphertext, plaintext_len: Option) -> Result { log::trace!("Key::decrypt_ciphertext"); let key = self.inner.lock().await; let agent = key.agent.lock().await; let public_key = key.public_key.clone(); let mut keypair = agent.keypair(&public_key)?; // Drop the lock while we do the actual operation. drop(agent); if let Some(password) = key.password.as_ref() { keypair = keypair.with_password(password.clone()); } drop(key); keypair.decrypt_async(ciphertext, plaintext_len).await } async fn sign(&mut self, hash_algo: HashAlgorithm, digest: &[u8]) -> Result<(PublicKeyAlgorithm, mpi::Signature)> { log::trace!("Key::sign"); let key = self.inner.lock().await; let agent = key.agent.lock().await; let public_key = key.public_key.clone(); let mut keypair = agent.keypair(&public_key)?; // Drop the lock while we do the actual operation. drop(agent); if let Some(password) = key.password.as_ref() { keypair = keypair.with_password(password.clone()); } drop(key); keypair.sign_async(hash_algo, digest).await .map(|mpis| { (public_key.pk_algo(), mpis) }) } async fn export(&mut self) -> Result> { let key = self.inner.lock().await; let mut agent = key.agent.lock().await; Ok(agent.export(key.public_key.clone()).await?) } async fn change_password(&mut self, password: Option<&Password>) -> Result<()> { log::trace!("KeyHandle::change_password({}, {})", self.fingerprint(), if let Some(password) = password { if password.map(|p| p.is_empty()) { "clear password" } else { "set password" } } else { "ask for password" }); if password.is_some() { return Err(Error::NoInlinePassword(None).into()); }; let key = self.inner.lock().await; let agent = key.agent.lock().await; let mut keypair = agent.keypair(&key.public_key)?; Ok(keypair.password(true).await?) } async fn delete_secret_key_material(&mut self) -> Result<()> { log::trace!("KeyHandle::delete_secret_key_material"); let key = self.inner.lock().await; let agent = key.agent.lock().await; let mut keypair = agent.keypair(&key.public_key)?; Ok(keypair.delete_key(false).await?) } } #[cfg(test)] mod tests { use super::*; use std::fs::File; use std::io::Write; use anyhow::Context; use openpgp::parse::Parse; use openpgp::policy::StandardPolicy; use openpgp::serialize::Serialize; const P: &StandardPolicy = &StandardPolicy::new(); use backend::test_framework; use backend::Backend as _; fn preinit() -> bool { // XXX: Return false if gpg-agent is not installed. true } async fn init_backend() -> Backend { gpg_agent::trace(true); let backend = Backend::init_ephemeral().await .expect("creating an ephemeral backend"); // Enable loopback mode. { let mut backend = backend.inner.lock().await; let home = backend.home.to_path_buf(); let gpg_agent_conf = home.join("gpg-agent.conf"); let mut f = File::options() .create(true).append(true) .open(&gpg_agent_conf) .with_context(|| { format!("Opening {}", gpg_agent_conf.display()) }).expect("can open gpg-agent.conf"); writeln!(&mut f, "allow-loopback-pinentry").expect("can write"); drop(f); let device = backend.devices.get_mut(0).unwrap(); let device = device.inner.lock().await; let mut agent = device.agent.lock().await; agent.reload().await.expect("can reload"); } // If we didn't supply a password, suppress pinentry. { let mut backend = backend.inner.lock().await; let device = backend.devices.get_mut(0).unwrap(); let device = device.inner.lock().await; let mut agent = device.agent.lock().await; agent.set_pinentry_mode(gpg_agent::PinentryMode::Cancel); } backend } async fn import_cert(backend: &mut Backend, cert: &Cert) { let mut backend = backend.inner.lock().await; // Import the keys into the agent. { let device = backend.devices.get_mut(0).unwrap(); let device = device.inner.lock().await; let mut agent = device.agent.lock().await; for k in cert.keys().secret() { agent.import(P, &cert, k.parts_as_secret().expect("have secret"), true, true).await.expect("can import"); } } // And insert the certificate into our local certd so that we // can find the OpenPGP keys. backend.certd.certd().insert( &cert.fingerprint().to_string(), (), false, |(), disk| { let cert_; let cert = if let Some(disk) = disk { // Merge. let disk = Cert::from_bytes(disk).expect("valid cert"); cert_ = cert.clone().merge_public(disk).expect("can merge"); &cert_ } else { // New. cert }; let mut bytes = Vec::new(); cert.serialize(&mut bytes).expect("can serialize to a vec"); Ok(bytes.into()) }) .expect("inserted"); } sequoia_keystore_backend::generate_tests!( preinit, false, // Tests don't need to be serialized. Backend, init_backend, import_cert, true, // Can import encrypted secret key material. None, // unlimited key sets None, // No default password true, // Can export. true, // Can change password. true // Can delete secret key material. ); }