invite

package

v0.2.1 Latest Latest Go to latest Published: Aug 5, 2021 License: MIT Imports: 14 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/cryptoscope/ssb

Links

Open Source Insights

Documentation ¶

Overview ¶

Package invite contains functions for parsing invite codes and dialing a pub as a guest to redeem a token. The muxrpc handlers and storage are found in plugins/legacyinvite.

Index ¶

Variables
func NewPubMessageFromToken(tok Token) (*refs.OldPubMessage, error)
func Redeem(ctx context.Context, tok Token, longTerm refs.FeedRef) error
type Token
- func ParseLegacyToken(input string) (Token, error)
- func (c Token) String() string

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrInvalidToken = errors.New("invite: invalid token")

Functions ¶

func NewPubMessageFromToken ¶

func NewPubMessageFromToken(tok Token) (*refs.OldPubMessage, error)

func Redeem ¶

func Redeem(ctx context.Context, tok Token, longTerm refs.FeedRef) error

Redeem takes an invite token and a long term key. It uses the information in the token to build a guest-client connection and place an 'invite.use' rpc call with it's longTerm key. If the peer responds with a message it returns nil

Types ¶

type Token ¶

type Token struct {
	Peer    refs.FeedRef
	Address net.Addr

	Seed [32]byte
}

func ParseLegacyToken ¶

func ParseLegacyToken(input string) (Token, error)

ParseLegacyToken takes an legacy invite token of the form host:port:@feed.Ref~base64Seed

func (Token) String ¶

func (c Token) String() string

Source Files ¶

View all Source files

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