ttjsv2

Documentation

Overview

Package ttjsv2 provides the claiming client implementation for The Things Join Server 2.0 API.

Index

• type ClaimData
• type ClaimRequest
  • func (req ClaimRequest) Apply(ctx context.Context, c Component) (ClaimRequest, error)
• type Component
• type Config
• type ConfigFile
• type EndDevicesErrors
• type ErrorResponse
• type KEK
• type TLSConfig
  • func (conf TLSConfig) IsZero() bool
  • func (conf TLSConfig) TLSConfig(fetcher fetch.Interface, ks crypto.KeyService) (*tls.Config, error)
• type TTJS
  • func NewClient(c Component, fetcher fetch.Interface, conf Config) *TTJS
  • func (c *TTJS) BatchUnclaim(ctx context.Context, ids []*ttnpb.EndDeviceIdentifiers) error
  • func (c *TTJS) Claim(ctx context.Context, joinEUI, devEUI types.EUI64, ...) error
  • func (c *TTJS) GetClaimStatus(ctx context.Context, ids *ttnpb.EndDeviceIdentifiers) (*ttnpb.GetClaimStatusResponse, error)
  • func (c *TTJS) SupportsJoinEUI(eui types.EUI64) bool
  • func (c *TTJS) Unclaim(ctx context.Context, ids *ttnpb.EndDeviceIdentifiers) error

Types

type ClaimData

type ClaimData struct {
	HomeNetID string  `json:"homeNetID"`
	HomeNSID  *string `json:"homeNSID,omitempty"`
	Locked    bool    `json:"locked"`
}

ClaimData contains information about the claim.

type ClaimRequest

type ClaimRequest struct {
	OwnerToken           string  `json:"ownerToken"`
	HomeNetID            string  `json:"homeNetID"`
	HomeNSID             *string `json:"homeNSID,omitempty"`
	ASID                 string  `json:"asID"`
	RegenerateOwnerToken *bool   `json:"regenerateOwnerToken,omitempty"`
	Lock                 *bool   `json:"lock,omitempty"`
	KEK                  *KEK    `json:"kek,omitempty"`
}

ClaimRequest is the claim request message.

func (ClaimRequest) Apply

func (req ClaimRequest) Apply(ctx context.Context, c Component) (ClaimRequest, error)

Apply applies the context to the request.

type Component

type Component interface {
	httpclient.Provider
	KeyService() crypto.KeyService
}

Component abstracts the component.

type Config

type Config struct {
	NetID           types.NetID
	NSID            *types.EUI64
	ASID            string
	JoinEUIPrefixes []types.EUI64Prefix
	ConfigFile
}

Config is the configuration for The Things Join Server claiming client.

type ConfigFile

type ConfigFile struct {
	URL string    `yaml:"url"`
	TLS TLSConfig `yaml:"tls"`

	// BasicAuth is no longer used and is only kept for backwards compatibility.
	// TODO: Remove (https://github.com/TheThingsNetwork/lorawan-stack/issues/6049)
	BasicAuth struct {
		Username string `yaml:"username"`
		Password string `yaml:"password"`
	} `yaml:"basic-auth"`
}

ConfigFile defines the configuration file for The Things Join Server claiming client.

type EndDevicesErrors

type EndDevicesErrors map[string]ErrorResponse

EndDevicesErrors is a map of end device identifiers to error responses.

type ErrorResponse

type ErrorResponse struct {
	Message string `json:"message"`
}

ErrorResponse is a message that may be returned by The Things Join Server in case of an error.

type KEK

type KEK struct {
	Label string `json:"label"`
	Key   string `json:"key"`
}

KEK contains the key encryption key.

type TLSConfig

type TLSConfig struct {
	RootCA      string `yaml:"root-ca"`
	Source      string `yaml:"source"`
	Certificate string `yaml:"certificate"`
	Key         string `yaml:"key"`
}

TLSConfig contains the TLS configuration.

func (TLSConfig) IsZero

func (conf TLSConfig) IsZero() bool

IsZero returns true if the TLSConfig is empty.

func (TLSConfig) TLSConfig

func (conf TLSConfig) TLSConfig(fetcher fetch.Interface, ks crypto.KeyService) (*tls.Config, error)

TLSConfig returns the *tls.Config.

type TTJS

type TTJS struct {
	Component
	// contains filtered or unexported fields
}

TTJS is a client that claims end devices on a The Things Join Server.

func NewClient

func NewClient(c Component, fetcher fetch.Interface, conf Config) *TTJS

NewClient applies the config and returns a new TTJS client.

func (*TTJS) BatchUnclaim

func (c *TTJS) BatchUnclaim(
	ctx context.Context,
	ids []*ttnpb.EndDeviceIdentifiers,
) error

BatchUnclaim implements EndDeviceClaimer.

func (*TTJS) Claim

func (c *TTJS) Claim(ctx context.Context, joinEUI, devEUI types.EUI64, claimAuthenticationCode string) error

Claim implements EndDeviceClaimer.

func (*TTJS) GetClaimStatus

func (c *TTJS) GetClaimStatus(
	ctx context.Context, ids *ttnpb.EndDeviceIdentifiers,
) (*ttnpb.GetClaimStatusResponse, error)

GetClaimStatus implements EndDeviceClaimer.

func (*TTJS) SupportsJoinEUI

func (c *TTJS) SupportsJoinEUI(eui types.EUI64) bool

SupportsJoinEUI implements EndDeviceClaimer.

func (*TTJS) Unclaim

func (c *TTJS) Unclaim(ctx context.Context, ids *ttnpb.EndDeviceIdentifiers) error

Unclaim implements EndDeviceClaimer.