forked from juju/charmstore
/
resources.go
395 lines (376 loc) · 13.5 KB
/
resources.go
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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
// Copyright 2016 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.
package v5 // import "gopkg.in/juju/charmstore.v5/internal/v5"
import (
"crypto/sha512"
"encoding/base64"
"encoding/hex"
"encoding/json"
"fmt"
"io/ioutil"
"net/http"
"net/url"
"path"
"strconv"
"strings"
"gopkg.in/errgo.v1"
"gopkg.in/httprequest.v1"
"gopkg.in/juju/charm.v6/resource"
"gopkg.in/juju/charmrepo.v3/csclient/params"
"gopkg.in/macaroon-bakery.v2-unstable/bakery/checkers"
macaroon "gopkg.in/macaroon.v2-unstable"
"gopkg.in/juju/charmstore.v5/internal/charmstore"
"gopkg.in/juju/charmstore.v5/internal/mongodoc"
"gopkg.in/juju/charmstore.v5/internal/router"
)
// POST id/resource/name
// https://github.com/juju/charmstore/blob/v5/docs/API.md#post-idresourcesname
//
// GET id/resource/name[/revision]
// https://github.com/juju/charmstore/blob/v5/docs/API.md#get-idresourcesnamerevision
func (h *ReqHandler) serveResources(id *router.ResolvedURL, w http.ResponseWriter, req *http.Request) error {
// Resources are "published" using "POST id/publish" so we don't
// support PUT here.
// TODO(ericsnow) Support DELETE to remove a resource (like serveArchive)?
switch req.Method {
case "GET":
return h.serveDownloadResource(id, w, req)
case "POST", "PUT":
return h.serveUploadResource(id, w, req)
default:
return errgo.WithCausef(nil, params.ErrMethodNotAllowed, "%s not allowed", req.Method)
}
}
func (h *ReqHandler) serveDockerResourceUploadInfo(id *router.ResolvedURL, w http.ResponseWriter, req *http.Request) error {
if err := h.AuthorizeEntityForOp(id, req, OpWrite); err != nil {
return errgo.Mask(err, errgo.Any)
}
resourceName := req.Form.Get("resource-name")
if resourceName == "" {
return badRequestf(nil, "must specify resource-name parameter")
}
e, err := h.Cache.Entity(&id.URL, charmstore.FieldSelector("charmmeta"))
if err != nil {
// Should never happen, as the entity will have been cached
// when the charm URL was resolved.
return errgo.Mask(err, errgo.Is(params.ErrNotFound))
}
if !charmstore.IsKubernetesCharm(e.CharmMeta) {
return errgo.WithCausef(nil, params.ErrForbidden, "%q does not support docker resource upload", id.URL.String())
}
r, ok := e.CharmMeta.Resources[resourceName]
if !ok {
return errgo.WithCausef(nil, params.ErrForbidden, "%q has no resource named %q", id.URL.String(), resourceName)
}
if r.Type != resource.TypeContainerImage {
return errgo.WithCausef(nil, params.ErrForbidden, "resource %q is not a docker resource", resourceName)
}
resp := params.DockerInfoResponse{
ImageName: h.Handler.config.DockerRegistryAddress + "/" + id.URL.User + "/" + id.URL.Name + "/" + resourceName,
Username: "docker-uploader",
}
password, err := h.dockerAuthPassword(id, resourceName, "push", "pull")
if err != nil {
return errgo.Mask(err)
}
resp.Password = password
return httprequest.WriteJSON(w, http.StatusOK, resp)
}
func (h *ReqHandler) serveDownloadResource(id *router.ResolvedURL, w http.ResponseWriter, req *http.Request) error {
rid, err := parseResourceId(strings.TrimPrefix(req.URL.Path, "/"))
if err != nil {
return errgo.WithCausef(err, params.ErrNotFound, "")
}
ch, err := h.entityChannel(id)
if err != nil {
return errgo.Mask(err, errgo.Is(params.ErrNotFound))
}
r, err := h.Store.ResolveResource(id, rid.Name, rid.Revision, ch)
if err != nil {
return errgo.Mask(err, errgo.Is(params.ErrNotFound))
}
if r.DockerImageDigest != "" {
return errgo.Mask(h.serveDownloadResourceDocker(id, r, w, req))
}
return errgo.Mask(h.serveDownloadResourceFile(id, r, w, req))
}
func (h *ReqHandler) serveDownloadResourceFile(id *router.ResolvedURL, r *mongodoc.Resource, w http.ResponseWriter, req *http.Request) error {
blob, err := h.Store.OpenResourceBlob(r)
if err != nil {
return errgo.Notef(err, "cannot open resource blob")
}
defer blob.Close()
header := w.Header()
setArchiveCacheControl(w.Header(), h.isPublic(id))
header.Set(params.ContentHashHeader, blob.Hash)
// TODO(rog) should we set connection=close here?
// See https://codereview.appspot.com/5958045
serveContent(w, req, blob.Size, blob)
return nil
}
func (h *ReqHandler) serveDownloadResourceDocker(id *router.ResolvedURL, r *mongodoc.Resource, w http.ResponseWriter, req *http.Request) error {
var resp params.DockerInfoResponse
if r.DockerImageName != "" {
resp.ImageName = r.DockerImageName + "@" + r.DockerImageDigest
} else {
resp.ImageName = h.Handler.config.DockerRegistryAddress + "/" + id.URL.User + "/" + id.URL.Name + "/" + r.Name + "@" + r.DockerImageDigest
// Tecnically we don't need an authorization token when the charm is public,
// and the user hasn't authenticated, but it's easier if we always use one,
// as then the docker auth endpoint does not need to check any ACLs.
resp.Username = "docker-registry"
password, err := h.dockerAuthPassword(id, r.Name, "pull")
if err != nil {
return errgo.Mask(err)
}
resp.Password = password
}
buf, err := json.Marshal(resp)
if err != nil {
return errgo.Mask(err)
}
w.Header().Set("Content-Type", "application/json")
w.Header().Set(params.ContentHashHeader, fmt.Sprintf("%x", sha512.Sum384(buf)))
if _, err := w.Write(buf); err != nil {
logger.Errorf("error writing response: %s", err)
}
return nil
}
// dockerAuthPassword returns a password (actually an encoded macaroon) suitable for
// a docker instance to authenticate to the charm store and perform the given resource
// operations.
func (h *ReqHandler) dockerAuthPassword(id *router.ResolvedURL, resourceName string, ops ...string) (string, error) {
m, err := h.Store.Bakery.NewMacaroon([]checkers.Caveat{
{Condition: "is-docker-repo " + id.URL.User + "/" + id.URL.Name + "/" + resourceName},
checkers.AllowCaveat(ops...),
})
if err != nil {
return "", errgo.Mask(err)
}
b, err := macaroon.Slice{m}.MarshalBinary()
if err != nil {
return "", errgo.Mask(err)
}
return base64.RawStdEncoding.EncodeToString(b), nil
}
func (h *ReqHandler) serveUploadResource(id *router.ResolvedURL, w http.ResponseWriter, req *http.Request) error {
if id.URL.Series == "bundle" {
return errgo.WithCausef(nil, params.ErrForbidden, "cannot upload a resource to a bundle")
}
rid, err := parseResourceId(strings.TrimPrefix(req.URL.Path, "/"))
if err != nil {
return errgo.WithCausef(err, params.ErrNotFound, "")
}
if !validResourceName(rid.Name) {
return badRequestf(nil, "invalid resource name")
}
if req.Method == "PUT" {
if rid.Revision == -1 {
return badRequestf(nil, "revision not specified")
}
} else {
if rid.Revision != -1 {
return errgo.WithCausef(nil, params.ErrMethodNotAllowed, "cannot POST to specific resource revision")
}
}
e, err := h.Cache.Entity(&id.URL, charmstore.FieldSelector("charmmeta"))
if err != nil {
// Should never happen, as the entity will have been cached
// when the charm URL was resolved.
return errgo.Mask(err, errgo.Is(params.ErrNotFound))
}
if charmstore.IsKubernetesCharm(e.CharmMeta) {
return h.serveUploadDockerResource(id, rid, w, req)
}
hash := req.Form.Get("hash")
uploadId := req.Form.Get("upload-id")
if hash == "" && uploadId == "" {
return badRequestf(nil, "hash parameter not specified")
}
if uploadId == "" && req.ContentLength == -1 {
return badRequestf(nil, "Content-Length not specified")
}
r, ok := e.CharmMeta.Resources[rid.Name]
if !ok {
return errgo.WithCausef(nil, params.ErrForbidden, "resource %q not found in charm metadata", rid.Name)
}
if r.Type != resource.TypeFile {
return errgo.WithCausef(nil, params.ErrForbidden, "non-file resource types not supported")
}
if filename := req.Form.Get("filename"); filename != "" {
if charmExt := path.Ext(r.Path); charmExt != "" {
// The resource has a filename extension. Check that it matches.
if charmExt != path.Ext(filename) {
return errgo.WithCausef(nil, params.ErrForbidden, "filename extension mismatch (got %q want %q)", path.Ext(filename), charmExt)
}
}
}
var rdoc *mongodoc.Resource
if uploadId != "" {
rdoc, err = h.Store.AddResourceWithUploadId(id, rid.Name, rid.Revision, uploadId)
} else {
rdoc, err = h.Store.UploadResource(id, rid.Name, rid.Revision, req.Body, hash, req.ContentLength)
}
if err != nil {
return errgo.Mask(err)
}
return httprequest.WriteJSON(w, http.StatusOK, ¶ms.ResourceUploadResponse{
Revision: rdoc.Revision,
})
}
func (h *ReqHandler) serveUploadDockerResource(id *router.ResolvedURL, rid mongodoc.ResourceRevision, w http.ResponseWriter, req *http.Request) error {
if req.Form.Get("hash") != "" {
return badRequestf(nil, "cannot specify hash parameter on docker image resources")
}
if req.Form.Get("upload-id") != "" {
return badRequestf(nil, "cannot specify upload-id parameter on docker image resources")
}
// TODO limit the size of the body here.
data, err := ioutil.ReadAll(req.Body)
if err != nil {
return errgo.Notef(err, "cannot read body")
}
var p params.DockerResourceUploadRequest
if err := json.Unmarshal(data, &p); err != nil {
return badRequestf(err, "bad JSON body")
}
if p.Digest == "" {
return badRequestf(nil, "digest not provided")
}
// TODO check that ImageName parses as a valid docker resource
rdoc, err := h.Store.AddDockerResource(id, rid.Name, rid.Revision, p.ImageName, p.Digest)
if err != nil {
return errgo.Mask(err)
}
return httprequest.WriteJSON(w, http.StatusOK, ¶ms.ResourceUploadResponse{
Revision: rdoc.Revision,
})
return nil
}
// GET id/meta/resource
// https://github.com/juju/charmstore/blob/v5/docs/API.md#get-idmetaresources
func (h *ReqHandler) metaResources(entity *mongodoc.Entity, id *router.ResolvedURL, path string, flags url.Values, req *http.Request) (interface{}, error) {
if entity.URL.Series == "bundle" {
return nil, nil
}
ch, err := h.entityChannel(id)
if err != nil {
return nil, errgo.Mask(err)
}
resources, err := h.Store.ListResources(id, ch)
if err != nil {
return nil, errgo.Mask(err)
}
results := make([]params.Resource, len(resources))
for i, res := range resources {
result, err := fromResourceDoc(res, entity.CharmMeta.Resources)
if err != nil {
return nil, err
}
results[i] = *result
}
return results, nil
}
// GET id/meta/resource/*name*[/*revision]
// https://github.com/juju/charmstore/blob/v5/docs/API.md#get-idmetaresourcesnamerevision
func (h *ReqHandler) metaResourcesSingle(entity *mongodoc.Entity, id *router.ResolvedURL, path string, flags url.Values, req *http.Request) (interface{}, error) {
data, err := h.metaResourcesSingle0(entity, id, path, flags, req)
if err != nil {
if errgo.Cause(err) == params.ErrNotFound {
logger.Infof("replacing not-found error on %s/meta/resources%s: %v (%#v)", id.URL.Path(), path, err, err)
// It's a not-found error; return nothing
// so that it's OK to use this in a bulk meta request.
return nil, nil
}
return nil, errgo.Mask(err)
}
return data, nil
}
func (h *ReqHandler) metaResourcesSingle0(entity *mongodoc.Entity, id *router.ResolvedURL, path string, flags url.Values, req *http.Request) (interface{}, error) {
if id.URL.Series == "bundle" {
return nil, nil
}
rid, err := parseResourceId(strings.TrimPrefix(path, "/"))
if err != nil {
return nil, errgo.WithCausef(err, params.ErrNotFound, "")
}
ch, err := h.entityChannel(id)
if err != nil {
return nil, errgo.Mask(err)
}
doc, err := h.Store.ResolveResource(id, rid.Name, rid.Revision, ch)
if err != nil {
if errgo.Cause(err) != params.ErrNotFound || rid.Revision != -1 {
return nil, errgo.Mask(err, errgo.Is(params.ErrNotFound))
}
// The resource wasn't found and we're not asking for a specific
// revision. If the resource actually exists in the charm metadata,
// return a placeholder document as would be returned by
// the /meta/resources (ListResources) endpoint.
if _, ok := entity.CharmMeta.Resources[rid.Name]; !ok {
return nil, errgo.Mask(err, errgo.Is(params.ErrNotFound))
}
doc = &mongodoc.Resource{
Name: rid.Name,
Revision: -1,
}
}
result, err := fromResourceDoc(doc, entity.CharmMeta.Resources)
if err != nil {
return nil, errgo.Mask(err, errgo.Is(params.ErrNotFound))
}
return result, nil
}
func fromResourceDoc(doc *mongodoc.Resource, resources map[string]resource.Meta) (*params.Resource, error) {
meta, ok := resources[doc.Name]
if !ok {
return nil, errgo.WithCausef(nil, params.ErrNotFound, "resource %q not found in charm", doc.Name)
}
r := ¶ms.Resource{
Name: doc.Name,
Revision: -1,
Type: meta.Type.String(),
Path: meta.Path,
Description: meta.Description,
}
if meta.Type == resource.TypeFile && doc.BlobHash == "" {
// No hash implies that there is no file (the entry
// is just a placeholder), so we don't fill in
// blob details.
return r, nil
}
r.Revision = doc.Revision
if meta.Type == resource.TypeContainerImage {
return r, nil
}
rawHash, err := hex.DecodeString(doc.BlobHash)
if err != nil {
return nil, errgo.Notef(err, "cannot decode blob hash %q", doc.BlobHash)
}
r.Size = doc.Size
r.Fingerprint = rawHash
return r, nil
}
func parseResourceId(path string) (mongodoc.ResourceRevision, error) {
i := strings.Index(path, "/")
if i == -1 {
return mongodoc.ResourceRevision{
Name: path,
Revision: -1,
}, nil
}
revno, err := strconv.Atoi(path[i+1:])
if err != nil {
return mongodoc.ResourceRevision{}, errgo.Newf("malformed revision number")
}
if revno < 0 {
return mongodoc.ResourceRevision{}, errgo.Newf("negative revision number")
}
return mongodoc.ResourceRevision{
Name: path[0:i],
Revision: revno,
}, nil
}
func validResourceName(name string) bool {
// TODO we should probably be more restrictive than this.
return !strings.Contains(name, "/")
}