config.go 2.58 KB
Newer Older
Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
1 2 3
package config

import (
4 5 6 7
	"crypto"
	"crypto/x509"
	"encoding/base64"
	"errors"
8
	"os"
9 10

	u "github.com/jbenet/go-ipfs/util"
Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
11 12
)

Juan Batiz-Benet's avatar
go lint  
Juan Batiz-Benet committed
13
// Identity tracks the configuration of the local node's identity.
Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
14
type Identity struct {
15
	PeerID  string
16
	PrivKey string
Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
17 18
}

Juan Batiz-Benet's avatar
go lint  
Juan Batiz-Benet committed
19
// Datastore tracks the configuration of the datastore.
Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
20
type Datastore struct {
Juan Batiz-Benet's avatar
gofmt  
Juan Batiz-Benet committed
21 22
	Type string
	Path string
Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
23 24
}

Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
25 26 27 28 29 30 31 32
// Addresses stores the (string) multiaddr addresses for the node.
type Addresses struct {
	Swarm string // address for the swarm network
	API   string // address for the local API (RPC)
}

// BootstrapPeer is a peer used to bootstrap the network.
type BootstrapPeer struct {
33
	Address string
34
	PeerID  string // until multiaddr supports ipfs, use another field.
35 36
}

Juan Batiz-Benet's avatar
go lint  
Juan Batiz-Benet committed
37
// Config is used to load IPFS config files.
Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
38
type Config struct {
Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
39 40 41
	Identity  Identity         // local node's peer identity
	Datastore Datastore        // local node's storage
	Addresses Addresses        // local node's addresses
42
	Bootstrap []*BootstrapPeer // local nodes's bootstrap peers
Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
43 44
}

Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
45
// DefaultPathRoot is the default parth for the IPFS node's root dir.
46
const DefaultPathRoot = "~/.go-ipfs"
Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
47 48

// DefaultConfigFilePath points to the ipfs node config file.
49
const DefaultConfigFilePath = DefaultPathRoot + "/config"
Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
50

Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
51
// DecodePrivateKey is a helper to decode the users PrivateKey
52 53 54 55 56 57
func (i *Identity) DecodePrivateKey(passphrase string) (crypto.PrivateKey, error) {
	pkb, err := base64.StdEncoding.DecodeString(i.PrivKey)
	if err != nil {
		return nil, err
	}

Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
58 59
	// currently storing key unencrypted. in the future we need to encrypt it.
	// TODO(security)
60 61 62
	return x509.ParsePKCS1PrivateKey(pkb)
}

Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
63 64
// Filename returns the proper tilde expanded config filename.
func Filename(filename string) (string, error) {
Juan Batiz-Benet's avatar
gofmt  
Juan Batiz-Benet committed
65
	if len(filename) == 0 {
66
		filename = DefaultConfigFilePath
Juan Batiz-Benet's avatar
gofmt  
Juan Batiz-Benet committed
67 68
	}

69
	// tilde expansion on config file
70 71 72
	return u.TildeExpansion(filename)
}

Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
73 74 75
// Load reads given file and returns the read config, or error.
func Load(filename string) (*Config, error) {
	filename, err := Filename(filename)
76 77
	if err != nil {
		return nil, err
Juan Batiz-Benet's avatar
gofmt  
Juan Batiz-Benet committed
78 79
	}

80
	// if nothing is there, fail. User must run 'ipfs init'
Juan Batiz-Benet's avatar
gofmt  
Juan Batiz-Benet committed
81
	if _, err := os.Stat(filename); os.IsNotExist(err) {
82
		return nil, errors.New("ipfs not initialized, please run 'ipfs init'")
Juan Batiz-Benet's avatar
gofmt  
Juan Batiz-Benet committed
83 84 85
	}

	var cfg Config
86 87 88 89 90 91 92
	err = ReadConfigFile(filename, &cfg)
	if err != nil {
		return nil, err
	}

	// tilde expansion on datastore path
	cfg.Datastore.Path, err = u.TildeExpansion(cfg.Datastore.Path)
Juan Batiz-Benet's avatar
gofmt  
Juan Batiz-Benet committed
93 94 95 96 97
	if err != nil {
		return nil, err
	}

	return &cfg, err
Juan Batiz-Benet's avatar
Juan Batiz-Benet committed
98
}
99 100 101

// Set sets the value of a particular config key
func Set(filename, key, value string) error {
102
	return WriteConfigKey(filename, key, value)
103
}