verification.go

// Copyright 2016 CoreOS, Inc.
//
// 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 types

import (
	"crypto"
	"encoding/hex"
	"errors"
	"strings"

	"github.com/coreos/ignition/config/validate/report"
)

var (
	ErrHashMalformed    = errors.New("malformed hash specifier")
	ErrHashWrongSize    = errors.New("incorrect size for hash sum")
	ErrHashUnrecognized = errors.New("unrecognized hash function")
)

// HashParts will return the sum and function (in that order) of the hash stored
// in this Verification, or an error if there is an issue during parsing.
func (v Verification) HashParts() (string, string, error) {
	if v.Hash == nil {
		// The hash can be nil
		return "", "", nil
	}
	parts := strings.SplitN(*v.Hash, "-", 2)
	if len(parts) != 2 {
		return "", "", ErrHashMalformed
	}

	return parts[0], parts[1], nil
}

func (v Verification) Validate() report.Report {
	r := report.Report{}

	if v.Hash == nil {
		// The hash can be nil
		return r
	}

	function, sum, err := v.HashParts()
	if err != nil {
		r.Add(report.Entry{
			Message: err.Error(),
			Kind:    report.EntryError,
		})
		return r
	}
	var hash crypto.Hash
	switch function {
	case "sha512":
		hash = crypto.SHA512
	default:
		r.Add(report.Entry{
			Message: ErrHashUnrecognized.Error(),
			Kind:    report.EntryError,
		})
		return r
	}

	if len(sum) != hex.EncodedLen(hash.Size()) {
		r.Add(report.Entry{
			Message: ErrHashWrongSize.Error(),
			Kind:    report.EntryError,
		})
	}

	return r
}