Its more useful and standard to actually output the 'help' output when
[monkeysphere.git] / src / monkeysphere-authentication
1 #!/usr/bin/env bash
2
3 # monkeysphere-authentication: Monkeysphere authentication admin tool
4 #
5 # The monkeysphere scripts are written by:
6 # Jameson Rollins <jrollins@finestructure.net>
7 # Jamie McClelland <jm@mayfirst.org>
8 # Daniel Kahn Gillmor <dkg@fifthhorseman.net>
9 # Micah Anderson <micah@riseup.net>
10 #
11 # They are Copyright 2008-2009, and are all released under the GPL,
12 # version 3 or later.
13
14 ########################################################################
15 set -e
16
17 # set the pipefail option so pipelines fail on first command failure
18 set -o pipefail
19
20 PGRM=$(basename $0)
21
22 SYSSHAREDIR=${MONKEYSPHERE_SYSSHAREDIR:-"/usr/share/monkeysphere"}
23 export SYSSHAREDIR
24 . "${SYSSHAREDIR}/defaultenv"
25 . "${SYSSHAREDIR}/common"
26
27 SYSDATADIR=${MONKEYSPHERE_SYSDATADIR:-"/var/lib/monkeysphere"}
28 export SYSDATADIR
29
30 # sharedir for authentication functions
31 MASHAREDIR="${SYSSHAREDIR}/ma"
32
33 # datadir for authentication functions
34 MADATADIR="${SYSDATADIR}/authentication"
35
36 # temp directory to enable atomic moves of authorized_keys files
37 MATMPDIR="${MADATADIR}/tmp"
38 export MATMPDIR
39
40 # UTC date in ISO 8601 format if needed
41 DATE=$(date -u '+%FT%T')
42
43 # unset some environment variables that could screw things up
44 unset GREP_OPTIONS
45
46 ########################################################################
47 # FUNCTIONS
48 ########################################################################
49
50 usage() {
51     cat <<EOF >&2
52 usage: $PGRM <subcommand> [options] [args]
53 Monkeysphere authentication admin tool.
54
55 subcommands:
56  update-users (u) [USER]...        update user authorized_keys files
57  refresh-keys (r)                  refresh keys in keyring
58
59  add-id-certifier (c+) KEYID|FILE  import and tsign a certification key
60    [--domain (-n) DOMAIN]            limit ID certifications to DOMAIN
61    [--trust (-t) TRUST]              trust level of certifier (default: full)
62    [--depth (-d) DEPTH]              trust depth for certifier (default: 1)
63  remove-id-certifier (c-) KEYID    remove a certification key
64  list-id-certifiers (c)            list certification keys
65
66  version (v)                       show version number
67  help (h,?)                        this help
68
69 See ${PGRM}(8) for more info.
70 EOF
71 }
72
73 # function to interact with the gpg core keyring
74 gpg_core() {
75     GNUPGHOME="$GNUPGHOME_CORE"
76     export GNUPGHOME
77
78     gpg --no-greeting --quiet --no-tty "$@"
79 }
80
81 # function to interact with the gpg sphere keyring
82 # FIXME: this function requires only a single argument because of
83 # problems with quote expansion.  this needs to be fixed/improved.
84 gpg_sphere() {
85     GNUPGHOME="$GNUPGHOME_SPHERE"
86     export GNUPGHOME
87  
88     su_monkeysphere_user "gpg --no-greeting --quiet --no-tty $@"
89 }
90
91 # output to stdout the core fingerprint from the gpg core secret
92 # keyring
93 core_fingerprint() {
94     log debug "determining core key fingerprint..."
95     gpg_core --list-secret-key --with-colons \
96         --fixed-list-mode --with-fingerprint \
97         | grep ^fpr: | cut -d: -f10
98 }
99
100 # export signatures from core to sphere
101 gpg_core_sphere_sig_transfer() {
102     log debug "exporting core local sigs to sphere..."
103     gpg_core --export-options export-local-sigs --export | \
104         gpg_sphere "--import-options import-local-sigs --import" 2>&1 | log debug
105 }
106
107 ########################################################################
108 # MAIN
109 ########################################################################
110
111 # set unset default variables
112 AUTHORIZED_USER_IDS="%h/.monkeysphere/authorized_user_ids"
113 RAW_AUTHORIZED_KEYS="%h/.ssh/authorized_keys"
114
115 # load configuration file
116 [ -e ${MONKEYSPHERE_AUTHENTICATION_CONFIG:="${SYSCONFIGDIR}/monkeysphere-authentication.conf"} ] \
117     && . "$MONKEYSPHERE_AUTHENTICATION_CONFIG"
118
119 # set empty config variable with ones from the environment
120 LOG_LEVEL=${MONKEYSPHERE_LOG_LEVEL:=$LOG_LEVEL}
121 KEYSERVER=${MONKEYSPHERE_KEYSERVER:=$KEYSERVER}
122 CHECK_KEYSERVER=${MONKEYSPHERE_CHECK_KEYSERVER:=$CHECK_KEYSERVER}
123 MONKEYSPHERE_USER=${MONKEYSPHERE_MONKEYSPHERE_USER:=$MONKEYSPHERE_USER}
124 MONKEYSPHERE_GROUP=$(get_primary_group "$MONKEYSPHERE_USER")
125 PROMPT=${MONKEYSPHERE_PROMPT:=$PROMPT}
126 AUTHORIZED_USER_IDS=${MONKEYSPHERE_AUTHORIZED_USER_IDS:=$AUTHORIZED_USER_IDS}
127 RAW_AUTHORIZED_KEYS=${MONKEYSPHERE_RAW_AUTHORIZED_KEYS:=$RAW_AUTHORIZED_KEYS}
128 STRICT_MODES=${MONKEYSPHERE_STRICT_MODES:=$STRICT_MODES}
129
130 # other variables
131 REQUIRED_USER_KEY_CAPABILITY=${MONKEYSPHERE_REQUIRED_USER_KEY_CAPABILITY:="a"}
132 GNUPGHOME_CORE=${MONKEYSPHERE_GNUPGHOME_CORE:="${MADATADIR}/core"}
133 GNUPGHOME_SPHERE=${MONKEYSPHERE_GNUPGHOME_SPHERE:="${MADATADIR}/sphere"}
134 CORE_KEYLENGTH=${MONKEYSPHERE_CORE_KEYLENGTH:="2048"}
135 LOG_PREFIX=${MONKEYSPHERE_LOG_PREFIX:='ms: '}
136
137 # export variables needed in su invocation
138 export DATE
139 export MODE
140 export LOG_LEVEL
141 export KEYSERVER
142 export MONKEYSPHERE_USER
143 export MONKEYSPHERE_GROUP
144 export PROMPT
145 export CHECK_KEYSERVER
146 export REQUIRED_USER_KEY_CAPABILITY
147 export GNUPGHOME_CORE
148 export GNUPGHOME_SPHERE
149 export GNUPGHOME
150 export CORE_KEYLENGTH
151 export LOG_PREFIX
152
153 # get subcommand
154 COMMAND="$1"
155 [ "$COMMAND" ] || $PGRM help
156 shift
157
158 case $COMMAND in
159     'setup'|'setup'|'s')
160         source "${MASHAREDIR}/setup"
161         setup
162         ;;
163
164     'update-users'|'update-user'|'u')
165         source "${MASHAREDIR}/setup"
166         setup
167         source "${MASHAREDIR}/update_users"
168         update_users "$@"
169         ;;
170
171     'refresh-keys'|'r')
172         source "${MASHAREDIR}/setup"
173         setup
174         gpg_sphere "--keyserver $KEYSERVER --refresh-keys"
175         ;;
176
177     'add-identity-certifier'|'add-id-certifier'|'add-certifier'|'c+')
178         source "${MASHAREDIR}/setup"
179         setup
180         source "${MASHAREDIR}/add_certifier"
181         add_certifier "$@"
182         ;;
183
184     'remove-identity-certifier'|'remove-id-certifier'|'remove-certifier'|'c-')
185         source "${MASHAREDIR}/setup"
186         setup
187         source "${MASHAREDIR}/remove_certifier"
188         remove_certifier "$@"
189         ;;
190
191     'list-identity-certifiers'|'list-id-certifiers'|'list-certifiers'|'list-certifier'|'c')
192         source "${MASHAREDIR}/setup"
193         setup
194         source "${MASHAREDIR}/list_certifiers"
195         list_certifiers
196         ;;
197
198     'diagnostics'|'d')
199         source "${MASHAREDIR}/setup"
200         setup
201         source "${MASHAREDIR}/diagnostics"
202         diagnostics
203         ;;
204
205     'gpg-cmd')
206         source "${MASHAREDIR}/setup"
207         setup
208         gpg_sphere "$@"
209         ;;
210
211     'version'|'v')
212         version
213         ;;
214
215     '--help'|'help'|'-h'|'h'|'?')
216         usage
217         ;;
218
219     *)
220         failure "Unknown command: '$COMMAND'
221 Type '$PGRM help' for usage."
222         ;;
223 esac