README
¶
RTNS
RTNS (RTrade Name Service) is a stand-alone IPNS record management service, designed to facilitate secure publishing of IPNS records, leveraging an encrypted keystore known as kaas. Internally it facilitates scheduled republishing of all published records.
It is essentially a modified and condensed version of go-ipfs/namesys with minor optimizations.
Multi-Language
Usage
To import this library:
import "github.com/RTradeLtd/rtns"
You'll need to create a libp2p host, and a dht providing them as constructor arguments, and a valid keystore. This package contains a helper tool to wrab a KaaS client as a valid keystore interface type.
Development
Using $GOPATH
Ref: https://splice.com/blog/contributing-open-source-git-repositories-go/
- Fork the repository
- Clone the repository by running
git clone git@github.com:RTradeLtd/rtns.git $GOPATH/src/github.com/RTradeLtd/rtns - Run
cd $GOPATH/src/github.com/RTradeLtd/rtns - Set up remotes.
git remote rename origin upstream
git remote add origin git@github.com:<your-github-username>/rtns.git
- Add
export GO111MODULE=onto.bashrcor.bash_profile(if you're on a Mac) or.zshrc(if you're using zsh). Make sure to reload the rc file of your choice by runningsource <rc-file> - Run
go mod downloadto download the dependencies - To run the tests, use
go test ./...
Outside $GOPATH
- Fork and clone the repository to any location on your machine
- Run
cd rtns - Set up a remote for the upstream repository
git remote add upstream git@github.com:RTradeLtd/rtns.git
- Run
go mod downloadto download the dependencies - To run the tests, use
go test ./...
Limitations
- When used within Temporal, any keys derived from the fail-over KaaS host are not eligible for automated republishing.
Future Improvements
- DNSLink support
- Act as a gateway implementation to TNS (Temporal Name Server)
- Enable HA Kaas Backend
- This will involve repeatedly iterating through all available KaaS hosts attempting to retrieve the private key, until we either find the key or we iterate through all available KaaS hosts without finding one, triggering an error
- Enable automatic topic subscription for IPNS pubsub
- This would involve using rtfs to call an IPFS node, establishing a subscription for a given topic.
Documentation
¶
Overview ¶
Package rtns provides a secure, stand-alone IPNS publishing service that leverages the KaaS encrypted keystore service
Index ¶
- Constants
- Variables
- type RKeystore
- type RTNS
- func (r *RTNS) GetKey(name string) (ci.PrivKey, error)
- func (r *RTNS) HasKey(name string) (bool, error)
- func (r *RTNS) Publish(ctx context.Context, pk ci.PrivKey, cache bool, keyID, content string) error
- func (r *RTNS) PublishWithEOL(ctx context.Context, pk ci.PrivKey, eol time.Time, cache bool, ...) error
Constants ¶
const DefaultRecordLifetime = time.Hour * 24
DefaultRecordLifetime is the default lifetime for IPNS records
Variables ¶
var DefaultRebroadcastInterval = time.Hour * 4
DefaultRebroadcastInterval is the default interval at which we rebroadcast IPNS records
var FailureRetryInterval = time.Minute * 5
FailureRetryInterval is the interval at which we retry IPNS records broadcasts (when they fail)
Functions ¶
This section is empty.
Types ¶
type RKeystore ¶
type RKeystore struct {
// contains filtered or unexported fields
}
RKeystore satisfies the keystore.Keystore interface, providing access to a kaas backend for secure key management
func NewRKeystore ¶
NewRKeystore implements a keystore.Keystore compatible version of the kaas client
func (*RKeystore) Get ¶
Get retrieves a key from the Keystore if it exists, and returns ErrNoSuchKey otherwise.
type RTNS ¶
type RTNS struct {
// contains filtered or unexported fields
}
RTNS manages all the needed components to interact with public and private IPNS networks.
func NewRTNS ¶
func NewRTNS(ctx context.Context, rvs routing.ValueStore, ds datastore.Datastore, keys keystore.Keystore, size int) *RTNS
NewRTNS instantiates our RTNS service, and starts the republisher
Source Files
Directories