Metadata-Version: 2.3
Name: gpg-sop-wrapper
Version: 0.1.0
Summary: Wrap a SOP tool, e.g. sqop, and simulate a GnuPG interface
Project-URL: Homepage, https://devel.ringlet.net/misc/gpg-sop-wrapper/
Project-URL: Changes, https://devel.ringlet.net/misc/gpg-sop-wrapper/changes/
Project-URL: Issue Tracker, https://gitlab.com/ppentchev/gpg-sop-wrapper/-/issues
Project-URL: Source Code, https://gitlab.com/ppentchev/gpg-sop-wrapper
Author-email: Peter Pentchev <roam@ringlet.net>
License: BSD-2-Clause
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: DFSG approved
Classifier: License :: Freely Distributable
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Security :: Cryptography
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: >=3.11
Requires-Dist: click<9,>=8
Description-Content-Type: text/markdown

<!--
SPDX-FileCopyrightText: Peter Pentchev <roam@ringlet.net>
SPDX-License-Identifier: BSD-2-Clause
-->

# gpg-sop-wrapper - wrap a SOP implementation, simulate a GnuPG interface

\[[Home][ringlet-home] | [Download][ringlet-download] | [GitLab][gitlab] | [ReadTheDocs][readthedocs]\]

## Overview

The `gpg-sop-wrapper` tool was created for the specific purpose of using
`debsign` to sign a Debian package's changes file, but with a SOP tool
(e.g. Sequoia's `sqop` implementation) instead of GnuPG.
As such, it only supports a very limited number of GnuPG's options - basically
the ones that `debsign` uses to invoke `gpg` - and translates `--clearsign` to
an `sqop inline-sign` invocation.

The `gpg-sop-wrapper` tool will invoke a program named `sop` by default;
this may be overridden using the `WRAPPED_SOP` environment variable.

## Examples

Sign a Debian source package's changes file using `sqop` instead of `gpg`:

``` sh
env WRAPPED_SOP=sqop debsign -k /path/to/secret/keyfile -p gpg-sop-wrapper pkgver_source.changes
```

## Contact

The `gpg-sop-wrapper` library was written by [Peter Pentchev][roam].
It is developed in [a GitLab repository][gitlab].
This documentation is hosted at [Ringlet][ringlet-home] with a copy at [ReadTheDocs][readthedocs].

[roam]: mailto:roam@ringlet.net "Peter Pentchev"
[gitlab]: https://gitlab.com/ppentchev/gpg-sop-wrapper "The gpg-sop-wrapper GitLab repository"
[readthedocs]: https://gpg-sop-wrapper.readthedocs.io/ "The gpg-sop-wrapper ReadTheDocs page"
[ringlet-home]: https://devel.ringlet.net/misc/gpg-sop-wrapper/ "The Ringlet gpg-sop-wrapper homepage"
[ringlet-download]: https://devel.ringlet.net/misc/gpg-sop-wrapper/download/ "The Ringlet gpg-sop-wrapper download page"
