mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
f9978ed164
This commit pulls most of the image related logic into its own package, to make it easier to reason about and extend.
This is also a rewrite of the transformation logic used in Hugo Pipes, mostly to allow constructs like the one below:
{{ ($myimg | fingerprint ).Width }}
Fixes #5903
Fixes #6234
Fixes #6266
122 lines
3.3 KiB
Go
122 lines
3.3 KiB
Go
// Copyright 2018 The Hugo Authors. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package integrity
|
|
|
|
import (
|
|
"crypto/md5"
|
|
"crypto/sha256"
|
|
"crypto/sha512"
|
|
"encoding/base64"
|
|
"encoding/hex"
|
|
"hash"
|
|
"html/template"
|
|
"io"
|
|
|
|
"github.com/gohugoio/hugo/resources/internal"
|
|
|
|
"github.com/pkg/errors"
|
|
|
|
"github.com/gohugoio/hugo/resources"
|
|
"github.com/gohugoio/hugo/resources/resource"
|
|
)
|
|
|
|
const defaultHashAlgo = "sha256"
|
|
|
|
// Client contains methods to fingerprint (cachebusting) and other integrity-related
|
|
// methods.
|
|
type Client struct {
|
|
rs *resources.Spec
|
|
}
|
|
|
|
// New creates a new Client with the given specification.
|
|
func New(rs *resources.Spec) *Client {
|
|
return &Client{rs: rs}
|
|
}
|
|
|
|
type fingerprintTransformation struct {
|
|
algo string
|
|
}
|
|
|
|
func (t *fingerprintTransformation) Key() internal.ResourceTransformationKey {
|
|
return internal.NewResourceTransformationKey("fingerprint", t.algo)
|
|
}
|
|
|
|
// Transform creates a MD5 hash of the Resource content and inserts that hash before
|
|
// the extension in the filename.
|
|
func (t *fingerprintTransformation) Transform(ctx *resources.ResourceTransformationCtx) error {
|
|
|
|
h, err := newHash(t.algo)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
var w io.Writer
|
|
if rc, ok := ctx.From.(io.ReadSeeker); ok {
|
|
// This transformation does not change the content, so try to
|
|
// avoid writing to To if we can.
|
|
defer rc.Seek(0, 0)
|
|
w = h
|
|
} else {
|
|
w = io.MultiWriter(h, ctx.To)
|
|
}
|
|
|
|
io.Copy(w, ctx.From)
|
|
d, err := digest(h)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
ctx.Data["Integrity"] = integrity(t.algo, d)
|
|
ctx.AddOutPathIdentifier("." + hex.EncodeToString(d[:]))
|
|
return nil
|
|
}
|
|
|
|
func newHash(algo string) (hash.Hash, error) {
|
|
switch algo {
|
|
case "md5":
|
|
return md5.New(), nil
|
|
case "sha256":
|
|
return sha256.New(), nil
|
|
case "sha384":
|
|
return sha512.New384(), nil
|
|
case "sha512":
|
|
return sha512.New(), nil
|
|
default:
|
|
return nil, errors.Errorf("unsupported crypto algo: %q, use either md5, sha256, sha384 or sha512", algo)
|
|
}
|
|
}
|
|
|
|
// Fingerprint applies fingerprinting of the given resource and hash algorithm.
|
|
// It defaults to sha256 if none given, and the options are md5, sha256 or sha512.
|
|
// The same algo is used for both the fingerprinting part (aka cache busting) and
|
|
// the base64-encoded Subresource Integrity hash, so you will have to stay away from
|
|
// md5 if you plan to use both.
|
|
// See https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity
|
|
func (c *Client) Fingerprint(res resources.ResourceTransformer, algo string) (resource.Resource, error) {
|
|
if algo == "" {
|
|
algo = defaultHashAlgo
|
|
}
|
|
|
|
return res.Transform(&fingerprintTransformation{algo: algo})
|
|
}
|
|
|
|
func integrity(algo string, sum []byte) template.HTMLAttr {
|
|
encoded := base64.StdEncoding.EncodeToString(sum)
|
|
return template.HTMLAttr(algo + "-" + encoded)
|
|
}
|
|
|
|
func digest(h hash.Hash) ([]byte, error) {
|
|
sum := h.Sum(nil)
|
|
return sum, nil
|
|
}
|