mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-21 20:46:30 -05:00
644d55475d
Also move the non crypto hash funcs into this new package. This is much faster than e.g. MD5, especially for larger inputs: ``` BenchmarkXxHash/xxHash_43-10 9917955 112.2 ns/op 56 B/op 4 allocs/op BenchmarkXxHash/mdb5_43-10 6017239 204.1 ns/op 96 B/op 3 allocs/op BenchmarkXxHash/fnv32a_43-10 14407333 82.30 ns/op 16 B/op 1 allocs/op BenchmarkXxHash/xxHash_4300-10 2916892 409.7 ns/op 56 B/op 4 allocs/op BenchmarkXxHash/mdb5_4300-10 159748 7491 ns/op 4912 B/op 3 allocs/op BenchmarkXxHash/fnv32a_4300-10 218210 5510 ns/op 16 B/op 1 allocs/op ``` Fixes #12635
139 lines
3.2 KiB
Go
139 lines
3.2 KiB
Go
// Copyright 2017 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 crypto provides template functions for cryptographic operations.
|
|
package crypto
|
|
|
|
import (
|
|
"crypto/hmac"
|
|
"crypto/md5"
|
|
"crypto/sha1"
|
|
"crypto/sha256"
|
|
"crypto/sha512"
|
|
"encoding/hex"
|
|
"fmt"
|
|
"hash"
|
|
"hash/fnv"
|
|
|
|
"github.com/gohugoio/hugo/common/hugo"
|
|
"github.com/spf13/cast"
|
|
)
|
|
|
|
// New returns a new instance of the crypto-namespaced template functions.
|
|
func New() *Namespace {
|
|
return &Namespace{}
|
|
}
|
|
|
|
// Namespace provides template functions for the "crypto" namespace.
|
|
type Namespace struct{}
|
|
|
|
// MD5 hashes the v and returns its MD5 checksum.
|
|
func (ns *Namespace) MD5(v any) (string, error) {
|
|
conv, err := cast.ToStringE(v)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
|
|
hash := md5.Sum([]byte(conv))
|
|
return hex.EncodeToString(hash[:]), nil
|
|
}
|
|
|
|
// SHA1 hashes v and returns its SHA1 checksum.
|
|
func (ns *Namespace) SHA1(v any) (string, error) {
|
|
conv, err := cast.ToStringE(v)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
|
|
hash := sha1.Sum([]byte(conv))
|
|
return hex.EncodeToString(hash[:]), nil
|
|
}
|
|
|
|
// SHA256 hashes v and returns its SHA256 checksum.
|
|
func (ns *Namespace) SHA256(v any) (string, error) {
|
|
conv, err := cast.ToStringE(v)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
|
|
hash := sha256.Sum256([]byte(conv))
|
|
return hex.EncodeToString(hash[:]), nil
|
|
}
|
|
|
|
// FNV32a hashes v using fnv32a algorithm.
|
|
// <docsmeta>{"newIn": "0.98.0" }</docsmeta>
|
|
func (ns *Namespace) FNV32a(v any) (int, error) {
|
|
hugo.Deprecate("crypto.FNV32a", "Use hash.FNV32a.", "v0.129.0")
|
|
conv, err := cast.ToStringE(v)
|
|
if err != nil {
|
|
return 0, err
|
|
}
|
|
algorithm := fnv.New32a()
|
|
algorithm.Write([]byte(conv))
|
|
return int(algorithm.Sum32()), nil
|
|
}
|
|
|
|
// HMAC returns a cryptographic hash that uses a key to sign a message.
|
|
func (ns *Namespace) HMAC(h any, k any, m any, e ...any) (string, error) {
|
|
ha, err := cast.ToStringE(h)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
|
|
var hash func() hash.Hash
|
|
switch ha {
|
|
case "md5":
|
|
hash = md5.New
|
|
case "sha1":
|
|
hash = sha1.New
|
|
case "sha256":
|
|
hash = sha256.New
|
|
case "sha512":
|
|
hash = sha512.New
|
|
default:
|
|
return "", fmt.Errorf("hmac: %s is not a supported hash function", ha)
|
|
}
|
|
|
|
msg, err := cast.ToStringE(m)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
|
|
key, err := cast.ToStringE(k)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
|
|
mac := hmac.New(hash, []byte(key))
|
|
_, err = mac.Write([]byte(msg))
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
|
|
encoding := "hex"
|
|
if len(e) > 0 && e[0] != nil {
|
|
encoding, err = cast.ToStringE(e[0])
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
}
|
|
|
|
switch encoding {
|
|
case "binary":
|
|
return string(mac.Sum(nil)[:]), nil
|
|
case "hex":
|
|
return hex.EncodeToString(mac.Sum(nil)[:]), nil
|
|
default:
|
|
return "", fmt.Errorf("%q is not a supported encoding method", encoding)
|
|
}
|
|
}
|