path: root/crypto/ecies/params.go

// Copyright (c) 2013 Kyle Isom <kyle@tyrfingr.is>
// Copyright (c) 2012 The Go Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package ecies

// This file contains parameters for ECIES encryption, specifying the
// symmetric encryption and HMAC parameters.

import (
    "crypto"
    "crypto/aes"
    "crypto/cipher"
    "crypto/elliptic"
    "crypto/sha256"
    "crypto/sha512"
    "fmt"
    "hash"

    "github.com/ethereum/go-ethereum/crypto/secp256k1"
)

var (
    DefaultCurve                  = secp256k1.S256()
    ErrUnsupportedECDHAlgorithm   = fmt.Errorf("ecies: unsupported ECDH algorithm")
    ErrUnsupportedECIESParameters = fmt.Errorf("ecies: unsupported ECIES parameters")
)

type ECIESParams struct {
    Hash      func() hash.Hash // hash function
    hashAlgo  crypto.Hash
    Cipher    func([]byte) (cipher.Block, error) // symmetric cipher
    BlockSize int                                // block size of symmetric cipher
    KeyLen    int                                // length of symmetric key
}

// Standard ECIES parameters:
// * ECIES using AES128 and HMAC-SHA-256-16
// * ECIES using AES256 and HMAC-SHA-256-32
// * ECIES using AES256 and HMAC-SHA-384-48
// * ECIES using AES256 and HMAC-SHA-512-64

var (
    ECIES_AES128_SHA256 = &ECIESParams{
        Hash:      sha256.New,
        hashAlgo:  crypto.SHA256,
        Cipher:    aes.NewCipher,
        BlockSize: aes.BlockSize,
        KeyLen:    16,
    }

    ECIES_AES256_SHA256 = &ECIESParams{
        Hash:      sha256.New,
        hashAlgo:  crypto.SHA256,
        Cipher:    aes.NewCipher,
        BlockSize: aes.BlockSize,
        KeyLen:    32,
    }

    ECIES_AES256_SHA384 = &ECIESParams{
        Hash:      sha512.New384,
        hashAlgo:  crypto.SHA384,
        Cipher:    aes.NewCipher,
        BlockSize: aes.BlockSize,
        KeyLen:    32,
    }

    ECIES_AES256_SHA512 = &ECIESParams{
        Hash:      sha512.New,
        hashAlgo:  crypto.SHA512,
        Cipher:    aes.NewCipher,
        BlockSize: aes.BlockSize,
        KeyLen:    32,
    }
)

var paramsFromCurve = map[elliptic.Curve]*ECIESParams{
    secp256k1.S256(): ECIES_AES128_SHA256,
    elliptic.P256():  ECIES_AES128_SHA256,
    elliptic.P384():  ECIES_AES256_SHA384,
    elliptic.P521():  ECIES_AES256_SHA512,
}

func AddParamsForCurve(curve elliptic.Curve, params *ECIESParams) {
    paramsFromCurve[curve] = params
}

// ParamsFromCurve selects parameters optimal for the selected elliptic curve.
// Only the curves P256, P384, and P512 are supported.
func ParamsFromCurve(curve elliptic.Curve) (params *ECIESParams) {
    return paramsFromCurve[curve]

    /*
        switch curve {
        case elliptic.P256():
            return ECIES_AES128_SHA256
        case elliptic.P384():
            return ECIES_AES256_SHA384
        case elliptic.P521():
            return ECIES_AES256_SHA512
        default:
            return nil
        }
    */
}

// ASN.1 encode the ECIES parameters relevant to the encryption operations.
func paramsToASNECIES(params *ECIESParams) (asnParams asnECIESParameters) {
    if nil == params {
        return
    }
    asnParams.KDF = asnNISTConcatenationKDF
    asnParams.MAC = hmacFull
    switch params.KeyLen {
    case 16:
        asnParams.Sym = aes128CTRinECIES
    case 24:
        asnParams.Sym = aes192CTRinECIES
    case 32:
        asnParams.Sym = aes256CTRinECIES
    }
    return
}

// ASN.1 encode the ECIES parameters relevant to ECDH.
func paramsToASNECDH(params *ECIESParams) (algo asnECDHAlgorithm) {
    switch params.hashAlgo {
    case crypto.SHA224:
        algo = dhSinglePass_stdDH_sha224kdf
    case crypto.SHA256:
        algo = dhSinglePass_stdDH_sha256kdf
    case crypto.SHA384:
        algo = dhSinglePass_stdDH_sha384kdf
    case crypto.SHA512:
        algo = dhSinglePass_stdDH_sha512kdf
    }
    return
}

// ASN.1 decode the ECIES parameters relevant to the encryption stage.
func asnECIEStoParams(asnParams asnECIESParameters, params *ECIESParams) {
    if !asnParams.KDF.Cmp(asnNISTConcatenationKDF) {
        params = nil
        return
    } else if !asnParams.MAC.Cmp(hmacFull) {
        params = nil
        return
    }

    switch {
    case asnParams.Sym.Cmp(aes128CTRinECIES):
        params.KeyLen = 16
        params.BlockSize = 16
        params.Cipher = aes.NewCipher
    case asnParams.Sym.Cmp(aes192CTRinECIES):
        params.KeyLen = 24
        params.BlockSize = 16
        params.Cipher = aes.NewCipher
    case asnParams.Sym.Cmp(aes256CTRinECIES):
        params.KeyLen = 32
        params.BlockSize = 16
        params.Cipher = aes.NewCipher
    default:
        params = nil
    }
}

// ASN.1 decode the ECIES parameters relevant to ECDH.
func asnECDHtoParams(asnParams asnECDHAlgorithm, params *ECIESParams) {
    if asnParams.Cmp(dhSinglePass_stdDH_sha224kdf) {
        params.hashAlgo = crypto.SHA224
        params.Hash = sha256.New224
    } else if asnParams.Cmp(dhSinglePass_stdDH_sha256kdf) {
        params.hashAlgo = crypto.SHA256
        params.Hash = sha256.New
    } else if asnParams.Cmp(dhSinglePass_stdDH_sha384kdf) {
        params.hashAlgo = crypto.SHA384
        params.Hash = sha512.New384
    } else if asnParams.Cmp(dhSinglePass_stdDH_sha512kdf) {
        params.hashAlgo = crypto.SHA512
        params.Hash = sha512.New
    } else {
        params = nil
    }
}