pkg/utils/utils.go

// Copyright 2016 CNI authors
//
// 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 utils

import (
	"crypto/sha512"
	"fmt"
)

const (
	maxChainLength = 28
	chainPrefix    = "CNI-"
)

// FormatChainName generates a chain name to be used
// with iptables. Ensures that the generated chain
// name is exactly maxChainLength chars in length.
func FormatChainName(name string, id string) string {
	return MustFormatChainNameWithPrefix(name, id, "")
}

// MustFormatChainNameWithPrefix generates a chain name similar
// to FormatChainName, but adds a custom prefix between
// chainPrefix and unique identifier. Ensures that the
// generated chain name is exactly maxChainLength chars in length.
// Panics if the given prefix is too long.
func MustFormatChainNameWithPrefix(name string, id string, prefix string) string {
	return MustFormatHashWithPrefix(maxChainLength, chainPrefix+prefix, name+id)
}

// FormatComment returns a comment used for easier
// rule identification within iptables.
func FormatComment(name string, id string) string {
	return fmt.Sprintf("name: %q id: %q", name, id)
}

const MaxHashLen = sha512.Size * 2

// MustFormatHashWithPrefix returns a string of given length that begins with the
// given prefix. It is filled with entropy based on the given string toHash.
func MustFormatHashWithPrefix(length int, prefix string, toHash string) string {
	if len(prefix) >= length || length > MaxHashLen {
		panic("invalid length")
	}

	output := sha512.Sum512([]byte(toHash))
	return fmt.Sprintf("%s%x", prefix, output)[:length]
}