fiat

README

The code in this package was autogenerated by the fiat-crypto project
at commit c076f3550 from a formally verified model.

    docker build -t fiat-crypto:c076f3550 .
    docker run fiat-crypto:c076f3550 --lang Go --no-wide-int --cmovznz-by-mul \
        --internal-static --public-function-case camelCase --public-type-case camelCase \
        --private-function-case camelCase --private-type-case camelCase \
        --no-prefix-fiat --package-name fiat --doc-text-before-function-name '' \
        --doc-prepend-header 'Code generated by Fiat Cryptography. DO NOT EDIT.' \
        --doc-newline-before-package-declaration p521 64 9 '2^521 - 1' \
        carry_mul carry_square carry add sub to_bytes from_bytes selectznz \
        > p521_fiat64.go

It comes under the following license.

    Copyright (c) 2015-2020 The fiat-crypto 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:

        1. Redistributions of source code must retain the above copyright
        notice, this list of conditions and the following disclaimer.

    THIS SOFTWARE IS PROVIDED BY the fiat-crypto authors "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 Berkeley Software Design,
    Inc. 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.

The authors are listed at

    https://github.com/mit-plv/fiat-crypto/blob/master/AUTHORS

Documentation

Overview

Package fiat implements prime order fields using formally verified algorithms from the Fiat Cryptography project.

Index

• type P521Element
  • func (e *P521Element) Add(t1, t2 *P521Element) *P521Element
  • func (e *P521Element) Bytes() []byte
  • func (e *P521Element) Equal(t *P521Element) int
  • func (e *P521Element) Invert(t *P521Element) *P521Element
  • func (e *P521Element) IsZero() int
  • func (e *P521Element) Mul(t1, t2 *P521Element) *P521Element
  • func (e *P521Element) One() *P521Element
  • func (v *P521Element) Select(a, b *P521Element, cond int) *P521Element
  • func (e *P521Element) Set(t *P521Element) *P521Element
  • func (e *P521Element) SetBytes(v []byte) (*P521Element, error)
  • func (e *P521Element) Square(t *P521Element) *P521Element
  • func (e *P521Element) Sub(t1, t2 *P521Element) *P521Element

Types

type P521Element

type P521Element struct {
	// contains filtered or unexported fields
}

P521Element is an integer modulo 2^521 - 1.

The zero value is a valid zero element.

func (*P521Element) Add

func (e *P521Element) Add(t1, t2 *P521Element) *P521Element

Add sets e = t1 + t2, and returns e.

func (*P521Element) Bytes

func (e *P521Element) Bytes() []byte

Bytes returns the 66-byte little-endian encoding of e.

func (*P521Element) Equal

func (e *P521Element) Equal(t *P521Element) int

Equal returns 1 if e == t, and zero otherwise.

func (*P521Element) Invert

func (e *P521Element) Invert(t *P521Element) *P521Element

Invert sets e = 1/t, and returns e.

If t == 0, Invert returns e = 0.

func (*P521Element) IsZero

func (e *P521Element) IsZero() int

IsZero returns 1 if e == 0, and zero otherwise.

func (*P521Element) Mul

func (e *P521Element) Mul(t1, t2 *P521Element) *P521Element

Mul sets e = t1 * t2, and returns e.

func (*P521Element) One

func (e *P521Element) One() *P521Element

One sets e = 1, and returns e.

func (*P521Element) Select

func (v *P521Element) Select(a, b *P521Element, cond int) *P521Element

Select sets e to a if cond == 1, and to b if cond == 0.

func (*P521Element) Set

func (e *P521Element) Set(t *P521Element) *P521Element

Set sets e = t, and returns e.

func (*P521Element) SetBytes

func (e *P521Element) SetBytes(v []byte) (*P521Element, error)

SetBytes sets e = v, where v is a little-endian 66-byte encoding, and returns e. If v is not 66 bytes or it encodes a value higher than 2^521 - 1, SetBytes returns nil and an error, and e is unchanged.

func (*P521Element) Square

func (e *P521Element) Square(t *P521Element) *P521Element

Square sets e = t * t, and returns e.

func (*P521Element) Sub

func (e *P521Element) Sub(t1, t2 *P521Element) *P521Element

Sub sets e = t1 - t2, and returns e.