lib

README

taubyte/domain-validation

Used to validate ownership of DNS domains

Generate Keys

To use this package you need to generate a symetric pair for keys:

openssl ecparam -name prime256v1 -genkey -noout -out private.key

openssl ec -in private.key -pubout -out public.pem

NOTE: the private key need to be kept safe.

Maintainers

• Samy Fodil @samyfodil
• Tafseer Khan @tafseer-khan
• Aron Jalbuena @arontaubyte

Documentation

Index

• func Address(project *cid.Cid, fqdn string) string
• func FromDNS(ctx context.Context, project *cid.Cid, fqdn string, options ...Option) error
• func TXTEntry(project *cid.Cid, fqdn string) string
• type Claims
  • func FromToken(token Token, options ...Option) (*Claims, error)
  • func New(options ...Option) (*Claims, error)
  • func (claims *Claims) Calculate()
  • func (claims *Claims) Sign() (Token, error)
  • func (claims *Claims) Valid() error
• type Option
  • func FQDN(fqdn string) Option
  • func PrivateKey(data []byte) Option
  • func Project(project cid.Cid) Option
  • func PublicKey(data []byte) Option
• type Repository
• type Resolver
  • func UseResolver(r Resolver) Resolver
• type Token
  • func (t Token) Bytes() ([]byte, error)

Functions

func Address

func Address(project *cid.Cid, fqdn string) string

func FromDNS

func FromDNS(ctx context.Context, project *cid.Cid, fqdn string, options ...Option) error

func TXTEntry

func TXTEntry(project *cid.Cid, fqdn string) string

Types

type Claims

type Claims struct {
	Address string `json:"address"` // address is hash(fqdn+projectID)
	// contains filtered or unexported fields
}

func FromToken

func FromToken(token Token, options ...Option) (*Claims, error)

func New

func New(options ...Option) (*Claims, error)

func (*Claims) Calculate

func (claims *Claims) Calculate()

func (*Claims) Sign

func (claims *Claims) Sign() (Token, error)

func (*Claims) Valid

func (claims *Claims) Valid() error

type Option

type Option func(*Claims) error

func FQDN

func FQDN(fqdn string) Option

func PrivateKey

func PrivateKey(data []byte) Option

func Project

func Project(project cid.Cid) Option

func PublicKey

func PublicKey(data []byte) Option

type Repository

type Repository struct {
	Id string `json:"id"`
}

type Resolver

type Resolver interface {
	LookupTXT(context.Context, string) ([]string, error)
}

func UseResolver

func UseResolver(r Resolver) Resolver

type Token

type Token string

func (Token) Bytes

func (t Token) Bytes() ([]byte, error)