Compare commits

...

3 Commits

Author SHA1 Message Date
Ben McGinnes
fd4226429d examples: exporting keys
* Fixed the descriptions and explanation of what happens if no
  search/user ID/key ID data is included (it exports the lot).
2018-05-30 09:11:28 +10:00
Ben McGinnes
93bdf4b50a examples: python bindings
* 2 more scripts for planned expansion of the HOWTO.
* export-key.py - is very similar to both the import-key.py script and
  an earlier example.
* export-secret-key.py - the holiest of holies, a script to be very
  careful with (though on posix systems it is saved in a chmodded 600
  file).
2018-05-30 08:55:12 +10:00
Ben McGinnes
095093df20 examples: python bindings howto
* Added a script for planned HOWTO expansion demonstrating key import
  from a file with optional alternative homedir setting.
2018-05-25 22:59:17 +10:00
3 changed files with 228 additions and 0 deletions

View File

@ -0,0 +1,74 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
from __future__ import absolute_import, division, unicode_literals
# Copyright (C) 2018 Ben McGinnes <ben@gnupg.org>
#
# 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 2 of the License, or (at your option) any later
# version.
#
# This program is free software; you can redistribute it and/or modify it under
# the terms of the GNU Lesser General Public License as published by the Free
# Software Foundation; either version 2.1 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 and the GNU
# Lesser General Public Licensefor more details.
#
# You should have received a copy of the GNU General Public License and the GNU
# Lesser General Public along with this program; if not, see
# <http://www.gnu.org/licenses/>.
import gpg
import os
import os.path
import sys
c = gpg.Context(armor=True)
k = gpg.Data()
print("""
This script exports one or more public keys to a file.
If the uer or key IDs are not included then all available public keys will be
exported to a file (ASCII aroured).
""")
if len(sys.argv) > 3:
filepth = sys.argv[1]
homedir = sys.argv[2]
keytext = sys.argv[3]
elif len(sys.argv) == 3:
filepth = sys.argv[1]
homedir = sys.argv[2]
keytext = input("Enter the user or key ID for export: ")
elif len(sys.argv) == 2:
filepth = sys.argv[1]
homedir = input("Enter the GPG configuration directory path (optional): ")
keytext = input("Enter the user or key ID for export: ")
else:
filepth = input("Enter the filename and path of the key file: ")
homedir = input("Enter the GPG configuration directory path (optional): ")
keytext = input("Enter the user or key ID for export (optional): ")
if homedir.startswith("~"):
if os.path.exists(os.path.expanduser(homedir)) is True:
c.home_dir = os.path.expanduser(homedir)
else:
pass
elif os.path.exists(homedir) is True:
c.home_dir = homedir
else:
pass
c.op_export(keytext, 0, k)
k.seek(0, os.SEEK_SET)
expkey = k.read()
with open(filepth, "wb") as f:
f.write(expkey)

View File

@ -0,0 +1,79 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
from __future__ import absolute_import, division, unicode_literals
# Copyright (C) 2018 Ben McGinnes <ben@gnupg.org>
#
# 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 2 of the License, or (at your option) any later
# version.
#
# This program is free software; you can redistribute it and/or modify it under
# the terms of the GNU Lesser General Public License as published by the Free
# Software Foundation; either version 2.1 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 and the GNU
# Lesser General Public Licensefor more details.
#
# You should have received a copy of the GNU General Public License and the GNU
# Lesser General Public along with this program; if not, see
# <http://www.gnu.org/licenses/>.
import gpg
import os
import os.path
import sys
c = gpg.Context(armor=True)
k = gpg.Data()
print("""
This script exports one or more secret keys to a file.
Will prompt for passphrase using gpg-agent and pinentry for each key to be
exported.
If the user or key ID(s) are not entered then it will attempt to export all
available keys and will prompt for the passphrase of each one.
""")
if len(sys.argv) > 3:
filepth = sys.argv[1]
homedir = sys.argv[2]
keytext = sys.argv[3]
elif len(sys.argv) == 3:
filepth = sys.argv[1]
homedir = sys.argv[2]
keytext = input("Enter the user or key ID for export: ")
elif len(sys.argv) == 2:
filepth = sys.argv[1]
homedir = input("Enter the GPG configuration directory path (optional): ")
keytext = input("Enter the user or key ID for export: ")
else:
filepth = input("Enter the filename and path of the key file: ")
homedir = input("Enter the GPG configuration directory path (optional): ")
keytext = input("Enter the user or key ID for export (optional): ")
if homedir.startswith("~"):
if os.path.exists(os.path.expanduser(homedir)) is True:
c.home_dir = os.path.expanduser(homedir)
else:
pass
elif os.path.exists(homedir) is True:
c.home_dir = homedir
else:
pass
c.op_export(keytext, gpg.core.gpgme.GPGME_EXPORT_MODE_SECRET, k)
k.seek(0, os.SEEK_SET)
seckey = k.read()
with open(filepth, "wb") as f:
f.write(seckey)
os.chmod(filepth, 0o600)

View File

@ -0,0 +1,75 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
from __future__ import absolute_import, division, unicode_literals
# Copyright (C) 2018 Ben McGinnes <ben@gnupg.org>
#
# 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 2 of the License, or (at your option) any later
# version.
#
# This program is free software; you can redistribute it and/or modify it under
# the terms of the GNU Lesser General Public License as published by the Free
# Software Foundation; either version 2.1 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 and the GNU
# Lesser General Public Licensefor more details.
#
# You should have received a copy of the GNU General Public License and the GNU
# Lesser General Public along with this program; if not, see
# <http://www.gnu.org/licenses/>.
import gpg
import os.path
import sys
c = gpg.Context(armor=True)
print("""
This script imports a public key into the public keybox/keyring from a file.
""")
if len(sys.argv) >= 3:
filepth = sys.argv[1]
homedir = sys.argv[2]
elif len(sys.argv) == 2:
filepth = sys.argv[1]
homedir = input("Enter the GPG configuration directory path (optional): ")
else:
filepth = input("Enter the filename and path of the key file: ")
homedir = input("Enter the GPG configuration directory path (optional): ")
if homedir.startswith("~"):
if os.path.exists(os.path.expanduser(homedir)) is True:
c.home_dir = os.path.expanduser(homedir)
else:
pass
elif os.path.exists(homedir) is True:
c.home_dir = homedir
else:
pass
with open(filepth, "rb") as f:
incoming = f.read()
c.op_import(incoming)
res = c.op_import_result()
result = """
Imported {0} of {1} keys with:
{2} new revocations
{3} new signatures
{4} new sub keys
{5} new user IDs
{6} new secret keys
{7} unchanged keys
""".format(res.imported, res.considered, res.new_revocations,
res.new_signatures, res.new_sub_keys, res.new_user_ids,
res.secret_imported, res.unchanged)
print(res)