script: temporary homedir creation
[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 # Copyright (C) 2018 Ben McGinnes <ben@gnupg.org>
7 #
8 # This program is free software; you can redistribute it and/or modify it under
9 # the terms of the GNU General Public License as published by the Free Software
10 # Foundation; either version 2 of the License, or (at your option) any later
11 # version.
12 #
13 # This program is free software; you can redistribute it and/or modify it under
14 # the terms of the GNU Lesser General Public License as published by the Free
15 # Software Foundation; either version 2.1 of the License, or (at your option)
16 # any later version.
17 #
18 # This program is distributed in the hope that it will be useful, but WITHOUT
19 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
20 # FOR A PARTICULAR PURPOSE.  See the GNU General Public License and the GNU
21 # Lesser General Public Licensefor more details.
22 #
23 # You should have received a copy of the GNU General Public License and the GNU
24 # Lesser General Public along with this program; if not, see
25 # <http://www.gnu.org/licenses/>.
26
27 import os
28 import os.path
29 import sys
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 gpgconf = """# gpg.conf settings for key generation:
58 expert
59 allow-freeform-uid
60 allow-secret-key-import
61 trust-model tofu+pgp
62 tofu-default-policy unknown
63 enable-large-rsa
64 enable-dsa2
65 cert-digest-algo SHA512
66 default-preference-list TWOFISH CAMELLIA256 AES256 CAMELLIA192 AES192 CAMELLIA128 AES BLOWFISH IDEA CAST5 3DES SHA512 SHA384 SHA256 SHA224 RIPEMD160 SHA1 ZLIB BZIP2 ZIP Uncompressed
67 personal-cipher-preferences TWOFISH CAMELLIA256 AES256 CAMELLIA192 AES192 CAMELLIA128 AES BLOWFISH IDEA CAST5 3DES
68 personal-digest-preferences SHA512 SHA384 SHA256 SHA224 RIPEMD160 SHA1
69 personal-compress-preferences ZLIB BZIP2 ZIP Uncompressed
70 """
71
72 if len(sys.argv) == 1:
73     print(intro)
74     new_homedir = input("Enter the temporary gnupg homedir name: ")
75 elif len(sys.argv) == 2:
76     new_homedir = sys.argv[1]
77 else:
78     new_homedir = " ".join(sys.argv[1:])
79
80 userdir = os.path.expanduser("~")
81
82 if new_homedir.startswith("~"):
83     new_homdir.replace("~", "")
84 else:
85     pass
86
87 if new_homedir.startswith("/"):
88     new_homdir.replace("/", "")
89 else:
90     pass
91
92 if new_homedir.startswith("."):
93     new_homdir.replace(".", "_")
94 else:
95     pass
96
97 if new_homedir.count(" ") > 0:
98     new_homedir.replace(" ", "_")
99 else:
100     pass
101
102 nh = "{0}/.{1}".format(userdir, new_homedir)
103
104 if os.path.exists(nh) is True:
105     print("The {0} directory already exists.".format(nh))
106 else:
107     print("Creating the {0} directory.".format(nh))
108     os.mkdir(nh)
109     os.chmod(nh, 0o700)
110     with open("{0}/{1}".format(nh, "gpg.conf"), "w") as f:
111         f.write(gpgconf)
112     os.chmod("{0}/{1}".format(nh, "gpg.conf"), 0o600)
113     print("""You may now use the {0} directory as an alternative GPG homedir:
114
115 gpg --homedir {0}
116 gpg --homedir --full-gen-key
117
118 Or with GPGME scripts, including the GPGME Python bindings.
119 """)