fiat

package
v0.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 29, 2023 License: BSD-3-Clause Imports: 3 Imported by: 0

README 

The code in this package was autogenerated by the fiat-crypto project
at version v0.0.9 from a formally verified model, and by the addchain
project at a recent tip version.

    docker build -t fiat-crypto:v0.0.9 .
    go install github.com/mmcloughlin/addchain/cmd/addchain@v0.3.1-0.20211027081849-6a7d3decbe08
    go run generate.go

fiat-crypto code 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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type P224Element 

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

P224Element is an integer modulo 2^224 - 2^96 + 1.

The zero value is a valid zero element.

func (*P224Element) Add 

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

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

func (*P224Element) Bytes 

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

Bytes returns the 28-byte big-endian encoding of e.

func (*P224Element) Equal 

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

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

func (*P224Element) Invert 

func (e *P224Element) Invert(x *P224Element) *P224Element

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

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

func (*P224Element) IsZero 

func (e *P224Element) IsZero() int

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

func (*P224Element) Mul 

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

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

func (*P224Element) One 

func (e *P224Element) One() *P224Element

One sets e = 1, and returns e.

func (*P224Element) Select 

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

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

func (*P224Element) Set 

func (e *P224Element) Set(t *P224Element) *P224Element

Set sets e = t, and returns e.

func (*P224Element) SetBytes 

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

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

func (*P224Element) Square 

func (e *P224Element) Square(t *P224Element) *P224Element

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

func (*P224Element) Sub 

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

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

type P256Element 

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

P256Element is an integer modulo 2^256 - 2^224 + 2^192 + 2^96 - 1.

The zero value is a valid zero element.

func (*P256Element) Add 

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

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

func (*P256Element) Bits added in v0.0.3 

func (e *P256Element) Bits() *[4]uint64

Bits returns a reference to the underlying little-endian fully-reduced Montgomery representation of e. Handle with care.

func (*P256Element) Bytes 

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

Bytes returns the 32-byte big-endian encoding of e.

func (*P256Element) Equal 

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

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

func (*P256Element) Invert 

func (e *P256Element) Invert(x *P256Element) *P256Element

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

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

func (*P256Element) IsZero 

func (e *P256Element) IsZero() int

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

func (*P256Element) Mul 

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

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

func (*P256Element) One 

func (e *P256Element) One() *P256Element

One sets e = 1, and returns e.

func (*P256Element) Select 

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

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

func (*P256Element) Set 

func (e *P256Element) Set(t *P256Element) *P256Element

Set sets e = t, and returns e.

func (*P256Element) SetBytes 

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

SetBytes sets e = v, where v is a big-endian 32-byte encoding, and returns e. If v is not 32 bytes or it encodes a value higher than 2^256 - 2^224 + 2^192 + 2^96 - 1, SetBytes returns nil and an error, and e is unchanged.

func (*P256Element) Square 

func (e *P256Element) Square(t *P256Element) *P256Element

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

func (*P256Element) Sub 

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

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

type P384Element 

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

P384Element is an integer modulo 2^384 - 2^128 - 2^96 + 2^32 - 1.

The zero value is a valid zero element.

func (*P384Element) Add 

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

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

func (*P384Element) Bytes 

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

Bytes returns the 48-byte big-endian encoding of e.

func (*P384Element) Equal 

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

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

func (*P384Element) Invert 

func (e *P384Element) Invert(x *P384Element) *P384Element

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

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

func (*P384Element) IsZero 

func (e *P384Element) IsZero() int

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

func (*P384Element) Mul 

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

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

func (*P384Element) One 

func (e *P384Element) One() *P384Element

One sets e = 1, and returns e.

func (*P384Element) Select 

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

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

func (*P384Element) Set 

func (e *P384Element) Set(t *P384Element) *P384Element

Set sets e = t, and returns e.

func (*P384Element) SetBytes 

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

SetBytes sets e = v, where v is a big-endian 48-byte encoding, and returns e. If v is not 48 bytes or it encodes a value higher than 2^384 - 2^128 - 2^96 + 2^32 - 1, SetBytes returns nil and an error, and e is unchanged.

func (*P384Element) Square 

func (e *P384Element) Square(t *P384Element) *P384Element

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

func (*P384Element) Sub 

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

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

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 big-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(x *P521Element) *P521Element

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

If x == 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 v 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 big-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.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.