fido

README

go-fido

This library implements structure related to FIDO and WebAuthn.

Any contribution is welcome.

Documentation

Index

• Variables
• type AttestedCredentialData
• type AuthenticatorData
  • func (d *AuthenticatorData) UnmarshalBinary(data []byte) error
• type AuthenticatorDataFlag
• type PackedAttestationStatement
• type PublicKeyCredentialDescriptor
• type PublicKeyCredentialParameters
• type PublicKeyCredentialRpEntity
• type PublicKeyCredentialUserEntity

Variables

var ErrMalformedData = errors.New("data malformed")

Types

type AttestedCredentialData

type AttestedCredentialData struct {
	AAGUID              []byte
	CredentialIdLength  uint16
	CredentialId        []byte
	CredentialPublicKey *cose.Key
}

type AuthenticatorData

type AuthenticatorData struct {
	RPIDHash               []byte
	Flags                  AuthenticatorDataFlag
	SignCount              uint32
	AttestedCredentialData *AttestedCredentialData
	Extensions             map[string]any
}

> The authenticator data structure encodes contextual bindings made by the authenticator. https://www.w3.org/TR/webauthn-2/#authenticator-data UnmarshalBinary can be used to parse data

func (*AuthenticatorData) UnmarshalBinary

func (d *AuthenticatorData) UnmarshalBinary(data []byte) error

type AuthenticatorDataFlag

type AuthenticatorDataFlag uint8

const (
	AuthenticatorDataFlagUserPresent                    AuthenticatorDataFlag = 0x01
	AuthenticatorDataFlagUserVerified                   AuthenticatorDataFlag = 0x04
	AuthenticatorDataFlagAttestedCredentialDataIncluded AuthenticatorDataFlag = 0x40
	AuthenticatorDataFlagExtentionDataIncluded          AuthenticatorDataFlag = 0x80
)

type PackedAttestationStatement

type PackedAttestationStatement struct {
	Alg cose.Algorithm `cbor:"alg" json:"alg"`
	Sig []byte         `cbor:"sig" json:"sig"`
	X5c [][]byte       `cbor:"x5c" json:"x5c"`
}

> This is a WebAuthn optimized attestation statement format. https://w3c.github.io/webauthn/#sctn-packed-attestation

type PublicKeyCredentialDescriptor

type PublicKeyCredentialDescriptor struct {
	Type       string   `cbor:"type" json:"type"`
	ID         []byte   `cbor:"id" json:"id"`
	Transports []string `cbor:"transports" json:"transports"`
}

> This dictionary identifies a specific public key credential. https://w3c.github.io/webauthn/#dictdef-publickeycredentialdescriptor

type PublicKeyCredentialParameters

type PublicKeyCredentialParameters struct {
	Type string         `cbor:"type" json:"type"`
	Alg  cose.Algorithm `cbor:"alg" json:"alg"`
}

This dictionary is used to supply additional parameters when creating a new credential. https://w3c.github.io/webauthn/#dictdef-publickeycredentialparameters

type PublicKeyCredentialRpEntity

type PublicKeyCredentialRpEntity struct {
	Name string `cbor:"name" json:"name"`
	ID   string `cbor:"id" json:"id"`
}

> The PublicKeyCredentialRpEntity dictionary is used to supply additional Relying Party attributes when creating a new credential. https://w3c.github.io/webauthn/#dictdef-publickeycredentialrpentity

type PublicKeyCredentialUserEntity

type PublicKeyCredentialUserEntity struct {
	Name        string `cbor:"name" json:"name"`
	ID          []byte `cbor:"id" json:"id"`
	DisplayName string `cbor:"displayName" json:"displayName"`
}

> The PublicKeyCredentialUserEntity dictionary is used to supply additional user account attributes when creating a new credential. https://w3c.github.io/webauthn/#dictdef-publickeycredentialuserentity