Affected by GO-2023-2098 and 2 other vulnerabilities

GO-2023-2098: Unsoundness in variable comparison / non-unique binary decomposition in github.com/consensys/gnark

GO-2024-3122: Groth16 commitment extension unsound for more than one commitment in github.com/consensys/gnark

GO-2025-3929: Denial of service when computing scalar multiplication using fake-GLV algorithm in github.com/consensys/gnark

bits

package

v0.9.0-alpha Latest Latest Go to latest Published: Aug 18, 2023 License: Apache-2.0 Imports: 5 Imported by: 86

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/consensys/gnark

Links

Open Source Insights

Documentation ¶

Index ¶

func AssertIsTrit(api frontend.API, v frontend.Variable)
func FromBase(api frontend.API, base Base, digits []frontend.Variable, ...) frontend.Variable
func FromBinary(api frontend.API, digits []frontend.Variable, opts ...BaseConversionOption) frontend.Variable
func FromTernary(api frontend.API, digits []frontend.Variable, opts ...BaseConversionOption) frontend.Variable
func GetHints() []solver.Hint
func ToBase(api frontend.API, base Base, v frontend.Variable, opts ...BaseConversionOption) []frontend.Variable
func ToBinary(api frontend.API, v frontend.Variable, opts ...BaseConversionOption) []frontend.Variable
func ToNAF(api frontend.API, v frontend.Variable, opts ...BaseConversionOption) []frontend.Variable
func ToTernary(api frontend.API, v frontend.Variable, opts ...BaseConversionOption) []frontend.Variable
type Base
type BaseConversionOption

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AssertIsTrit ¶

func AssertIsTrit(api frontend.API, v frontend.Variable)

AssertIsTrit constrains digit to be 0, 1 or 2.

func FromBase ¶

func FromBase(api frontend.API, base Base, digits []frontend.Variable, opts ...BaseConversionOption) frontend.Variable

FromBase compute from a set of digits its canonical representation in little-endian order. For example for base 2, it returns Σbi = Σ (2**i * digits[i])

func FromBinary ¶

func FromBinary(api frontend.API, digits []frontend.Variable, opts ...BaseConversionOption) frontend.Variable

FromBinary is an alias of FromBase(api, Binary, digits)

func FromTernary ¶

func FromTernary(api frontend.API, digits []frontend.Variable, opts ...BaseConversionOption) frontend.Variable

FromTernary is an alias of FromBase(api, Ternary, digits)

func GetHints ¶ added in v0.9.0

func GetHints() []solver.Hint

func ToBase ¶

func ToBase(api frontend.API, base Base, v frontend.Variable, opts ...BaseConversionOption) []frontend.Variable

ToBase decomposes scalar v into digits in given base using options opts. The decomposition is in little-endian order.

func ToBinary ¶

func ToBinary(api frontend.API, v frontend.Variable, opts ...BaseConversionOption) []frontend.Variable

ToBinary is an alias of ToBase(api, Binary, v, opts)

func ToNAF ¶

func ToNAF(api frontend.API, v frontend.Variable, opts ...BaseConversionOption) []frontend.Variable

ToNAF returns the NAF decomposition of given input. The non-adjacent form (NAF) of a number is a unique signed-digit representation, in which non-zero values cannot be adjacent. For example, NAF(13) = [1, 0, -1, 0, 1].

func ToTernary ¶

func ToTernary(api frontend.API, v frontend.Variable, opts ...BaseConversionOption) []frontend.Variable

ToTernary is an alias of ToBase(api, Ternary, v, opts...)

Types ¶

type Base ¶

type Base uint8

Base defines the base for decomposing the scalar into digits.

const (
	// Binary base decomposes scalar into bits (0-1)
	Binary Base = 2

	// Ternary base decomposes scalar into trits (0-1-2)
	Ternary Base = 3
)

type BaseConversionOption ¶

type BaseConversionOption func(opt *baseConversionConfig) error

BaseConversionOption configures the behaviour of scalar decomposition.

func WithNbDigits ¶

func WithNbDigits(nbDigits int) BaseConversionOption

WithNbDigits sets the resulting number of digits (nbDigits) to be used in the base conversion. nbDigits must be > 0. If nbDigits is lower than the length of full decomposition and WithUnconstrainedOutputs option is not used, then this function generates an unsatisfiable constraint. If WithNbDigits option is not set, then the full decomposition is returned.

func WithUnconstrainedInputs ¶

func WithUnconstrainedInputs() BaseConversionOption

WithUnconstrainedInputs indicates to the FromBase apis to constrain its inputs (digits) to ensure they are valid digits in base b. For example, FromBinary without this option will add 1 constraint per bit to ensure it is either 0 or 1.

func WithUnconstrainedOutputs ¶

func WithUnconstrainedOutputs() BaseConversionOption

WithUnconstrainedOutputs sets the bit conversion API to NOT constrain the output bits. This is UNSAFE but is useful when the outputs are already constrained by other circuit constraints. The sum of the digits will is constrained like so Σbi = Σ (base**i * digits[i]) But the individual digits are not constrained to be valid digits in base b.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL