rc/marginaltool
2
0
Fork 1
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Rename project

Browse source
This commit is contained in:
Timotej Lazar 2024-01-26 16:45:46 +01:00
parent 7c1c763927
commit 6fdcb01012
3 changed files with 12 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -1,34 +1,34 @@
# margfools # marginaltool
Python script to replace [MargTools](https://businessconnect.margis.si/output/#orodja). Can be used to sign documents with [GovernmentConnect](https://margis.si/produkti/government-connect/). Python script to replace [MargTools](https://businessconnect.margis.si/output/#orodja). Can be used to sign documents with [GovernmentConnect](https://margis.si/produkti/government-connect/).
## Usage ## Usage
Run `margfools -h` for a synopsis of command‐line arguments. Allowed arguments are Run `marginaltool -h` for a synopsis of command‐line arguments. Allowed arguments are
margfools [-h] [-e {file,pkcs11}] [-k KEYFILE] [-c CERTFILE] [-i <KEY ID>] URL marginaltool [-h] [-e {file,pkcs11}] [-k KEYFILE] [-c CERTFILE] [-i <KEY ID>] URL
To use a signing key and certificate stored in PEM files, install `openssl` and run To use a signing key and certificate stored in PEM files, install `openssl` and run
margfools -e file -k KEYFILE -c CERTFILE bc-digsign://sign?… marginaltool -e file -k KEYFILE -c CERTFILE bc-digsign://sign?…
To sign using a PIV-II smartcard such as the Yubikey, install `pkcs11-tool` from [OpenSC](https://github.com/OpenSC/OpenSC) and run To sign using a PIV-II smartcard such as the Yubikey, install `pkcs11-tool` from [OpenSC](https://github.com/OpenSC/OpenSC) and run
margfools -e pkcs11 -i <KEY ID> bc-digsign://sign?… marginaltool -e pkcs11 -i <KEY ID> bc-digsign://sign?…
The script will prompt for the PIN to unlock the smartcard. To find the key ID, run The script will prompt for the PIN to unlock the smartcard. To find the key ID, run
pkcs11-tool -O pkcs11-tool -O
To use `margfools` from the web app, set it as the default program for `x-scheme-handler/bc-digsign` URLs, or copy the `margfools.desktop` file to `~/.local/share/applications/` and run To use `marginaltool` from the web app, set it as the default program for `x-scheme-handler/bc-digsign` URLs, or copy the `marginaltool.desktop` file to `~/.local/share/applications/` and run
xdg-mime default margfools.desktop x-scheme-handler/bc-digsign xdg-mime default marginaltool.desktop x-scheme-handler/bc-digsign
For this to work, the script must be configured as described below. For this to work, the script must be configured as described below.
## Configuration ## Configuration
Settings can be saved on a per‐site basis in `~/.margfools` using the [configparser](https://docs.python.org/3/library/configparser.html) format. Settings can be saved on a per‐site basis in `~/.marginaltool` using the [configparser](https://docs.python.org/3/library/configparser.html) format.
[DEFAULT] [DEFAULT]
engine = pkcs11 engine = pkcs11

4
margfools → marginaltool
View file

@ -20,9 +20,9 @@ def init(args):
args.start_token = args.params["startSigningToken"][0] args.start_token = args.params["startSigningToken"][0]
args.url = args.params['baseUrl'][0] args.url = args.params['baseUrl'][0]
# if missing, get options from section [url] in ~/.margfools # if missing, get options from section [url] in config
config = configparser.ConfigParser() config = configparser.ConfigParser()
config.read(os.path.expanduser('~') + '/.margfools') config.read(os.path.expanduser('~') + '/.marginaltool')
if not args.engine: if not args.engine:
args.engine = config.get(args.url, 'engine', fallback='file') args.engine = config.get(args.url, 'engine', fallback='file')

4
margfools.desktop → marginaltool.desktop
View file

@ -1,6 +1,6 @@
[Desktop Entry] [Desktop Entry]
Name=margfools Name=marginaltool
Exec=margfools %u Exec=marginaltool %u
Type=Application Type=Application
Terminal=true Terminal=true
MimeType=x-scheme-handler/bc-digsign; MimeType=x-scheme-handler/bc-digsign;