python bindings: howto examples
[gpgme.git] / lang / python / examples / howto / temp-homedir-config.py
1 #!/usr/bin/env python3
2 # -*- coding: utf-8 -*-
3
4 from __future__ import absolute_import, division, unicode_literals
5
6 import os
7 import os.path
8 import sys
9
10 # Copyright (C) 2018 Ben McGinnes <ben@gnupg.org>
11 #
12 # This program is free software; you can redistribute it and/or modify it under
13 # the terms of the GNU General Public License as published by the Free Software
14 # Foundation; either version 2 of the License, or (at your option) any later
15 # version.
16 #
17 # This program is free software; you can redistribute it and/or modify it under
18 # the terms of the GNU Lesser General Public License as published by the Free
19 # Software Foundation; either version 2.1 of the License, or (at your option)
20 # any later version.
21 #
22 # This program is distributed in the hope that it will be useful, but WITHOUT
23 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
24 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
25 # Lesser General Public Licensefor more details.
26 #
27 # You should have received a copy of the GNU General Public License and the GNU
28 # Lesser General Public along with this program; if not, see
29 # <http://www.gnu.org/licenses/>.
30
31 intro = """
32 This script creates a temporary directory to use as a homedir for
33 testing key generation tasks with the correct permissions, along
34 with a gpg.conf file containing the same configuration options
35 listed in the HOWTO.
36
37 You may wish to change the order of the cipher preferences or
38 remove those not relevant to your installation.  These
39 configuration parameters assume that all ciphers and digests are
40 installed and available rather than limiting to the default
41 ciphers and digests.
42
43 The script prompts for a directory name to be installed as a hidden
44 directory in the user's home directory on POSIX systems.  So if you
45 enter "gnupg-temp" on a Linux, BSD or OS X system, it will create
46 "~/.gnupg-temp" (you do not need to enter the leading dot).
47
48 This script has not been tested on Windows systems and may have
49 unpredictable results.  That said, it will not delete or copy over
50 existing data.
51
52 If the directory already exists, the script will terminate with a
53 message telling you to specify a new directory name.  There is no
54 default directory name.
55 """
56
57 ciphers256 = "TWOFISH CAMELLIA256 AES256"
58 ciphers192 = "CAMELLIA192 AES192"
59 ciphers128 = "CAMELLIA128 AES"
60 ciphersBad = "BLOWFISH IDEA CAST5 3DES"
61 digests = "SHA512 SHA384 SHA256 SHA224 RIPEMD160 SHA1"
62 compress = "ZLIB BZIP2 ZIP Uncompressed"
63
64 gpgconf = """# gpg.conf settings for key generation:
65 expert
66 allow-freeform-uid
67 allow-secret-key-import
68 trust-model tofu+pgp
69 tofu-default-policy unknown
70 enable-large-rsa
71 enable-dsa2
72 cert-digest-algo SHA512
73 default-preference-list {0} {1} {2} {3} {4} {5}
74 personal-cipher-preferences {0} {1} {2} {3}
75 personal-digest-preferences {4}
76 personal-compress-preferences {5}
77 """.format(ciphers256, ciphers192, ciphers128, ciphersBad, digests, compress)
78
79 agentconf = """# gpg-agent.conf settings for key generation:
80 default-cache-ttl 300
81 """
82
83 if len(sys.argv) == 1:
84     print(intro)
85     new_homedir = input("Enter the temporary gnupg homedir name: ")
86 elif len(sys.argv) == 2:
87     new_homedir = sys.argv[1]
88 else:
89     new_homedir = " ".join(sys.argv[1:])
90
91 userdir = os.path.expanduser("~")
92
93 if new_homedir.startswith("~"):
94     new_homdir.replace("~", "")
95 else:
96     pass
97
98 if new_homedir.startswith("/"):
99     new_homdir.replace("/", "")
100 else:
101     pass
102
103 if new_homedir.startswith("."):
104     new_homdir.replace(".", "_")
105 else:
106     pass
107
108 if new_homedir.count(" ") > 0:
109     new_homedir.replace(" ", "_")
110 else:
111     pass
112
113 nh = "{0}/.{1}".format(userdir, new_homedir)
114
115 if os.path.exists(nh) is True:
116     print("The {0} directory already exists.".format(nh))
117 else:
118     print("Creating the {0} directory.".format(nh))
119     os.mkdir(nh)
120     os.chmod(nh, 0o700)
121     with open("{0}/{1}".format(nh, "gpg.conf"), "w") as f1:
122         f1.write(gpgconf)
123     os.chmod("{0}/{1}".format(nh, "gpg.conf"), 0o600)
124     with open("{0}/{1}".format(nh, "gpg-agent.conf"), "w") as f2:
125         f2.write(gpgconf)
126     os.chmod("{0}/{1}".format(nh, "gpg-agent.conf"), 0o600)
127     print("""You may now use the {0} directory as an alternative GPG homedir:
128
129 gpg --homedir {0}
130 gpg --homedir --full-gen-key
131
132 Or with GPGME scripts, including the GPGME Python bindings.
133 """)