p224.go

     1  // Copyright 2021 The Go Authors. All rights reserved.
     2  // Use of this source code is governed by a BSD-style
     3  // license that can be found in the LICENSE file.
     4  
     5  // Code generated by generate.go. DO NOT EDIT.
     6  
     7  package fiat
     8  
     9  import (
    10  	"crypto/subtle"
    11  	"errors"
    12  )
    13  
    14  // P224Element is an integer modulo 2^224 - 2^96 + 1.
    15  //
    16  // The zero value is a valid zero element.
    17  type P224Element struct {
    18  	// Values are represented internally always in the Montgomery domain, and
    19  	// converted in Bytes and SetBytes.
    20  	x p224MontgomeryDomainFieldElement
    21  }
    22  
    23  const p224ElementLen = 28
    24  
    25  type p224UntypedFieldElement = [4]uint64
    26  
    27  // One sets e = 1, and returns e.
    28  func (e *P224Element) One() *P224Element {
    29  	p224SetOne(&e.x)
    30  	return e
    31  }
    32  
    33  // Equal returns 1 if e == t, and zero otherwise.
    34  func (e *P224Element) Equal(t *P224Element) int {
    35  	eBytes := e.Bytes()
    36  	tBytes := t.Bytes()
    37  	return subtle.ConstantTimeCompare(eBytes, tBytes)
    38  }
    39  
    40  var p224ZeroEncoding = new(P224Element).Bytes()
    41  
    42  // IsZero returns 1 if e == 0, and zero otherwise.
    43  func (e *P224Element) IsZero() int {
    44  	eBytes := e.Bytes()
    45  	return subtle.ConstantTimeCompare(eBytes, p224ZeroEncoding)
    46  }
    47  
    48  // Set sets e = t, and returns e.
    49  func (e *P224Element) Set(t *P224Element) *P224Element {
    50  	e.x = t.x
    51  	return e
    52  }
    53  
    54  // Bytes returns the 28-byte big-endian encoding of e.
    55  func (e *P224Element) Bytes() []byte {
    56  	// This function is outlined to make the allocations inline in the caller
    57  	// rather than happen on the heap.
    58  	var out [p224ElementLen]byte
    59  	return e.bytes(&out)
    60  }
    61  
    62  func (e *P224Element) bytes(out *[p224ElementLen]byte) []byte {
    63  	var tmp p224NonMontgomeryDomainFieldElement
    64  	p224FromMontgomery(&tmp, &e.x)
    65  	p224ToBytes(out, (*p224UntypedFieldElement)(&tmp))
    66  	p224InvertEndianness(out[:])
    67  	return out[:]
    68  }
    69  
    70  // p224MinusOneEncoding is the encoding of -1 mod p, so p - 1, the
    71  // highest canonical encoding. It is used by SetBytes to check for non-canonical
    72  // encodings such as p + k, 2p + k, etc.
    73  var p224MinusOneEncoding = new(P224Element).Sub(
    74  	new(P224Element), new(P224Element).One()).Bytes()
    75  
    76  // SetBytes sets e = v, where v is a big-endian 28-byte encoding, and returns e.
    77  // If v is not 28 bytes or it encodes a value higher than 2^224 - 2^96 + 1,
    78  // SetBytes returns nil and an error, and e is unchanged.
    79  func (e *P224Element) SetBytes(v []byte) (*P224Element, error) {
    80  	if len(v) != p224ElementLen {
    81  		return nil, errors.New("invalid P224Element encoding")
    82  	}
    83  	for i := range v {
    84  		if v[i] < p224MinusOneEncoding[i] {
    85  			break
    86  		}
    87  		if v[i] > p224MinusOneEncoding[i] {
    88  			return nil, errors.New("invalid P224Element encoding")
    89  		}
    90  	}
    91  	var in [p224ElementLen]byte
    92  	copy(in[:], v)
    93  	p224InvertEndianness(in[:])
    94  	var tmp p224NonMontgomeryDomainFieldElement
    95  	p224FromBytes((*p224UntypedFieldElement)(&tmp), &in)
    96  	p224ToMontgomery(&e.x, &tmp)
    97  	return e, nil
    98  }
    99  
   100  // Add sets e = t1 + t2, and returns e.
   101  func (e *P224Element) Add(t1, t2 *P224Element) *P224Element {
   102  	p224Add(&e.x, &t1.x, &t2.x)
   103  	return e
   104  }
   105  
   106  // Sub sets e = t1 - t2, and returns e.
   107  func (e *P224Element) Sub(t1, t2 *P224Element) *P224Element {
   108  	p224Sub(&e.x, &t1.x, &t2.x)
   109  	return e
   110  }
   111  
   112  // Mul sets e = t1 * t2, and returns e.
   113  func (e *P224Element) Mul(t1, t2 *P224Element) *P224Element {
   114  	p224Mul(&e.x, &t1.x, &t2.x)
   115  	return e
   116  }
   117  
   118  // Square sets e = t * t, and returns e.
   119  func (e *P224Element) Square(t *P224Element) *P224Element {
   120  	p224Square(&e.x, &t.x)
   121  	return e
   122  }
   123  
   124  // Select sets v to a if cond == 1, and to b if cond == 0.
   125  func (v *P224Element) Select(a, b *P224Element, cond int) *P224Element {
   126  	p224Selectznz((*p224UntypedFieldElement)(&v.x), p224Uint1(cond),
   127  		(*p224UntypedFieldElement)(&b.x), (*p224UntypedFieldElement)(&a.x))
   128  	return v
   129  }
   130  
   131  func p224InvertEndianness(v []byte) {
   132  	for i := 0; i < len(v)/2; i++ {
   133  		v[i], v[len(v)-1-i] = v[len(v)-1-i], v[i]
   134  	}
   135  }
   136
View as plain text