Cross Reference: /pkg/src/sign.py
sign.py revision 2245
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
2026N/A#!/usr/bin/python2.6
2026N/A#
2026N/A# CDDL HEADER START
2026N/A#
2026N/A# The contents of this file are subject to the terms of the
2026N/A# Common Development and Distribution License (the "License").
2026N/A# You may not use this file except in compliance with the License.
2026N/A#
2026N/A# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
2026N/A# or http://www.opensolaris.org/os/licensing.
2026N/A# See the License for the specific language governing permissions
2026N/A# and limitations under the License.
2026N/A#
2026N/A# When distributing Covered Code, include this CDDL HEADER in each
2026N/A# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
2026N/A# If applicable, add the following below this CDDL HEADER, with the
2026N/A# fields enclosed by brackets "[]" replaced with your own identifying
2026N/A# information: Portions Copyright [yyyy] [name of copyright owner]
2026N/A#
2026N/A# CDDL HEADER END
2026N/A#
2026N/A
2026N/A#
2245N/A# Copyright (c) 2010, 2011, Oracle and/or its affiliates. All rights reserved.
2026N/A#
2026N/A
2026N/Aimport getopt
2026N/Aimport gettext
2026N/Aimport locale
2026N/Aimport os
2026N/Aimport shutil
2026N/Aimport sys
2026N/Aimport tempfile
2026N/Aimport traceback
2026N/Aimport urllib
2026N/Aimport urlparse
2026N/A
2026N/Aimport pkg
2026N/Aimport pkg.actions as actions
2026N/Aimport pkg.client.api_errors as api_errors
2026N/Aimport pkg.client.transport.transport as transport
2026N/Aimport pkg.config as cfg
2026N/Aimport pkg.fmri as fmri
2026N/Aimport pkg.manifest as manifest
2026N/Aimport pkg.misc as misc
2026N/Aimport pkg.publish.transaction as trans
2026N/Afrom pkg.client import global_settings
2026N/Afrom pkg.misc import emsg, msg, PipeError
2026N/A
2026N/APKG_CLIENT_NAME = "pkgsign"
2026N/A
2026N/A# pkg exit codes
2026N/AEXIT_OK = 0
2026N/AEXIT_OOPS = 1
2026N/AEXIT_BADOPT = 2
2026N/AEXIT_PARTIAL = 3
2026N/A
2026N/Arepo_cache = {}
2026N/A
2026N/Adef error(text, cmd=None):
2026N/A """Emit an error message prefixed by the command name """
2026N/A
2026N/A if cmd:
2026N/A text = "%s: %s" % (cmd, text)
2026N/A
2026N/A else:
2026N/A text = "%s: %s" % (PKG_CLIENT_NAME, text)
2026N/A
2026N/A
2026N/A # If the message starts with whitespace, assume that it should come
2026N/A # *before* the command-name prefix.
2026N/A text_nows = text.lstrip()
2026N/A ws = text[:len(text) - len(text_nows)]
2026N/A
2026N/A # This has to be a constant value as we can't reliably get our actual
2026N/A # program name on all platforms.
2026N/A emsg(ws + text_nows)
2026N/A
2026N/Adef usage(usage_error=None, cmd=None, retcode=EXIT_BADOPT):
2026N/A """Emit a usage message and optionally prefix it with a more specific
2026N/A error message. Causes program to exit."""
2026N/A
2026N/A if usage_error:
2026N/A error(usage_error, cmd=cmd)
2026N/A emsg (_("""\
2026N/AUsage:
2026N/A pkgsign [-aciks] [--no-index] [--no-catalog]
2026N/A [--sign-all | fmri-to-sign ...]
2026N/A"""))
2026N/A
2026N/A sys.exit(retcode)
2026N/A
2026N/Adef fetch_catalog(src_pub, xport, temp_root, list_packages=False):
2026N/A """Fetch the catalog from src_uri."""
2026N/A global complete_catalog
2026N/A
2026N/A src_uri = src_pub.selected_repository.origins[0].uri
2026N/A # tracker.catalog_start(src_uri)
2026N/A
2026N/A if not src_pub.meta_root:
2026N/A # Create a temporary directory for catalog.
2026N/A cat_dir = tempfile.mkdtemp(dir=temp_root)
2026N/A src_pub.meta_root = cat_dir
2026N/A
2026N/A src_pub.transport = xport
2026N/A src_pub.refresh(True, True)
2026N/A
2026N/A if not list_packages:
2026N/A return
2026N/A
2026N/A cat = src_pub.catalog
2026N/A
2026N/A d = {}
2026N/A fmri_list = []
2026N/A for f in cat.fmris():
2026N/A fmri_list.append(f)
2026N/A d.setdefault(f.pkg_name, [f]).append(f)
2026N/A for k in d.keys():
2026N/A d[k].sort(reverse=True)
2026N/A
2026N/A complete_catalog = d
2026N/A return fmri_list
2026N/A
2026N/Adef main_func():
2026N/A misc.setlocale(locale.LC_ALL, "", error)
2026N/A gettext.install("pkg", "/usr/share/locale")
2026N/A global_settings.client_name = "pkgsign"
2026N/A
2026N/A try:
2026N/A opts, pargs = getopt.getopt(sys.argv[1:], "a:c:i:k:s:",
2026N/A ["help", "no-index", "no-catalog", "sign-all"])
2026N/A except getopt.GetoptError, e:
2026N/A usage(_("illegal global option -- %s") % e.opt)
2026N/A
2026N/A show_usage = False
2026N/A sig_alg = "rsa-sha256"
2026N/A cert_path = None
2026N/A key_path = None
2026N/A chain_certs = []
2026N/A add_to_catalog = True
2026N/A set_alg = False
2026N/A sign_all = False
2026N/A
2026N/A try:
2026N/A repo_uri = os.environ["PKG_REPO"]
2026N/A except KeyError:
2026N/A repo_uri = "http://localhost:10000"
2026N/A
2026N/A for opt, arg in opts:
2026N/A if opt == "-a":
2026N/A sig_alg = arg
2026N/A set_alg = True
2026N/A elif opt == "-c":
2026N/A cert_path = os.path.abspath(arg)
2026N/A if not os.path.isfile(cert_path):
2026N/A usage(_("%s was expected to be a certificate "
2026N/A "but isn't a file.") % cert_path)
2026N/A elif opt == "-i":
2026N/A p = os.path.abspath(arg)
2026N/A if not os.path.isfile(p):
2026N/A usage(_("%s was expected to be a certificate "
2026N/A "but isn't a file.") % p)
2026N/A chain_certs.append(p)
2026N/A elif opt == "-k":
2026N/A key_path = os.path.abspath(arg)
2026N/A if not os.path.isfile(key_path):
2026N/A usage(_("%s was expected to be a key file "
2026N/A "but isn't a file.") % key_path)
2026N/A elif opt == "-s":
2026N/A repo_uri = arg
2026N/A elif opt == "--help":
2026N/A show_usage = True
2026N/A elif opt == "--no-catalog":
2026N/A add_to_catalog = False
2026N/A elif opt == "--sign-all":
2026N/A sign_all = True
2026N/A
2026N/A if show_usage:
2026N/A usage(retcode=EXIT_OK)
2026N/A
2026N/A if key_path and not cert_path:
2026N/A usage(_("If a key is given to sign with, its associated "
2026N/A "certificate must be given."))
2026N/A
2026N/A if cert_path and not key_path:
2026N/A usage(_("If a certificate is given, its associated key must be "
2026N/A "given."))
2026N/A
2026N/A if chain_certs and not cert_path:
2026N/A usage(_("Intermediate certificates are only valid if a key "
2026N/A "and certificate are also provided."))
2026N/A
2026N/A if not pargs and not sign_all:
2026N/A usage(_("At least one fmri must be provided for signing."))
2026N/A
2026N/A if pargs and sign_all:
2026N/A usage(_("No fmris may be provided if the sign-all option is "
2026N/A "set."))
2026N/A
2026N/A if not set_alg and not key_path:
2026N/A sig_alg = "sha256"
2026N/A
2026N/A s, h = actions.signature.SignatureAction.decompose_sig_alg(sig_alg)
2026N/A if h is None:
2026N/A usage(_("%s is not a recognized signature algorithm.") %
2026N/A sig_alg)
2026N/A if s and not key_path:
2026N/A usage(_("Using %s as the signature algorithm requires that a "
2026N/A "key and certificate pair be presented using the -k and -c "
2026N/A "options.") % sig_alg)
2026N/A if not s and key_path:
2026N/A usage(_("The %s hash algorithm does not use a key or "
2026N/A "certificate. Do not use the -k or -c options with this "
2026N/A "algorithm.") % sig_alg)
2026N/A
2026N/A errors = []
2026N/A
2026N/A t = misc.config_temp_root()
2026N/A temp_root = tempfile.mkdtemp(dir=t)
2026N/A del t
2026N/A
2026N/A cache_dir = tempfile.mkdtemp(dir=temp_root)
2026N/A incoming_dir = tempfile.mkdtemp(dir=temp_root)
2026N/A
2026N/A try:
2026N/A xport, xport_cfg = transport.setup_transport()
2073N/A xport_cfg.add_cache(cache_dir, readonly=False)
2073N/A xport_cfg.incoming_root = incoming_dir
2026N/A
2026N/A # Configure src publisher
2026N/A src_pub = transport.setup_publisher(repo_uri, "source", xport,
2026N/A xport_cfg, remote_prefix=True)
2026N/A fmris = fetch_catalog(src_pub, xport, temp_root,
2026N/A list_packages=sign_all)
2026N/A if not sign_all:
2026N/A fmris = pargs
2028N/A successful_publish = False
2026N/A
2026N/A for pfmri in fmris:
2026N/A try:
2026N/A if isinstance(pfmri, basestring):
2026N/A pfmri = fmri.PkgFmri(pfmri)
2026N/A
2026N/A # Get the existing manifest for the package to
2026N/A # be sign.
2026N/A m_str = xport.get_manifest(pfmri,
2026N/A content_only=True, pub=src_pub)
2026N/A m = manifest.Manifest()
2073N/A m.set_content(content=m_str)
2026N/A
2026N/A # Construct the base signature action.
2026N/A attrs = { "algorithm": sig_alg }
2026N/A a = actions.signature.SignatureAction(cert_path,
2026N/A **attrs)
2026N/A a.hash = cert_path
2026N/A
2026N/A # Add the action to the manifest to be signed
2026N/A # since the action signs itself.
2026N/A m.add_action(a, misc.EmptyI)
2026N/A
2026N/A # Set the signature value and certificate
2026N/A # information for the signature action.
2026N/A a.set_signature(m.gen_actions(),
2026N/A key_path=key_path, chain_paths=chain_certs)
2026N/A
2026N/A # Append the finished signature action to the
2026N/A # published manifest.
2026N/A t = trans.Transaction(repo_uri,
2026N/A pkg_name=str(pfmri), xport=xport,
2028N/A pub=src_pub)
2026N/A t.append()
2026N/A try:
2026N/A t.add(a)
2026N/A for c in chain_certs:
2026N/A t.add_file(c)
2028N/A t.close(add_to_catalog=add_to_catalog)
2026N/A except:
2026N/A t.close(abandon=True)
2026N/A raise
2026N/A msg(_("Signed %s") % pfmri)
2028N/A successful_publish = True
2026N/A except (api_errors.ApiException, fmri.FmriError,
2026N/A trans.TransactionError), e:
2026N/A errors.append(e)
2026N/A if errors:
2026N/A error("\n".join([str(e) for e in errors]))
2028N/A if successful_publish:
2026N/A return EXIT_PARTIAL
2026N/A else:
2026N/A return EXIT_OOPS
2026N/A return EXIT_OK
2032N/A except api_errors.ApiException, e:
2026N/A error(e)
2026N/A return EXIT_OOPS
2026N/A finally:
2245N/A shutil.rmtree(temp_root)
2026N/A
2026N/A#
2026N/A# Establish a specific exit status which means: "python barfed an exception"
2026N/A# so that we can more easily detect these in testing of the CLI commands.
2026N/A#
2026N/Aif __name__ == "__main__":
2026N/A try:
2026N/A __ret = main_func()
2026N/A except (PipeError, KeyboardInterrupt):
2026N/A # We don't want to display any messages here to prevent
2026N/A # possible further broken pipe (EPIPE) errors.
2026N/A __ret = EXIT_OOPS
2026N/A except SystemExit, _e:
2026N/A raise _e
2026N/A except:
2026N/A traceback.print_exc()
2126N/A error(_("""\n
2126N/AThis is an internal error in pkg(5) version %(version)s. Please let the
2126N/Adevelopers know about this problem by including the information above (and
2126N/Athis message) when filing a bug at:
2126N/A
2126N/A%(bug_uri)s""") % { "version": pkg.VERSION, "bug_uri": misc.BUG_URI_CLI })
2026N/A __ret = 99
2026N/A sys.exit(__ret)