Add REST hidden service deamon

README.md

@@ -40,4 +40,7 @@ lndconnect
     --adminmacaroonpath=    Path to read the admin macaroon from
     --readonlymacaroonpath= Path to read the read-only macaroon from
     --invoicemacaroonpath=  Path to read the invoice-only macaroon from
+
+-c, --createonion           Create onion hidden service to access REST interface
+-r, --tor.restkeypath=      The path to the private key of the onion service being created
 ```

config.go

@@ -6,12 +6,14 @@ package main
 
 import (
 	"fmt"
+	"log"
 	"os"
 	"os/user"
 	"path/filepath"
+	"strconv"
 	"strings"
 
-	"github.com/btcsuite/btcutil"
+	"github.com/btcsuite/btcd/btcutil"
 	"github.com/jessevdk/go-flags"
 	"github.com/lightningnetwork/lnd/tor"
 )
@@ -25,36 +27,51 @@ const (
 	defaultReadMacFilename    = "readonly.macaroon"
 	defaultInvoiceMacFilename = "invoice.macaroon"
 	defaultRPCPort            = 10009
+	defaultRESTPort           = 8080
+	defaultRESTKeyFileName    = "rest_onion_private_key"
+	defaultQRFileName         = "lndconnect-qr.png"
 )
 
 var (
 	defaultLndDir      = btcutil.AppDataDir("lnd", false)
 	defaultConfigFile  = filepath.Join(defaultLndDir, defaultConfigFilename)
 	defaultDataDir     = filepath.Join(defaultLndDir, defaultDataDirname)
 	defaultTLSCertPath = filepath.Join(defaultLndDir, defaultTLSCertFilename)
+	defaultRESTKeyPath = filepath.Join(defaultLndDir, defaultRESTKeyFileName)
+	defaultQRFilePath  = filepath.Join(defaultLndDir, defaultQRFileName)
 )
 
 type chainConfig struct {
-	Active   bool `long:"active" description:"If the chain should be active or not"`
+	Active   bool `long:"active"  description:"If the chain should be active or not"`
 	MainNet  bool `long:"mainnet" description:"Use the main network"`
 	TestNet3 bool `long:"testnet" description:"Use the test network"`
-	SimNet   bool `long:"simnet" description:"Use the simulation test network"`
+	SimNet   bool `long:"simnet"  description:"Use the simulation test network"`
 	RegTest  bool `long:"regtest" description:"Use the regression test network"`
 }
 
+type torConfig struct {
+	Active          bool   `long:"active"          description:"Allow outbound and inbound connections to be routed through Tor"`
+	V3              bool   `long:"v3"              description:"Automatically set up a v3 onion service to listen for inbound connections"`
+	Control         string `long:"control"         description:"The host:port that Tor is listening on for Tor control connections"`
+	TargetIPAddress string `long:"targetipaddress" description:"IP address that Tor should use as the target of the hidden service"`
+	Password        string `long:"password"        description:"If provided, the HASHEDPASSWORD authentication method will be used instead of the SAFECOOKIE one."`
+	RESTKeyPath     string `long:"restkeypath"     description:"The path to the private key of the onion service being created if provided."                       short:"r"`
+}
+
 type arrayFlags []string
 
 type lndConnectConfig struct {
-	LocalIp   bool       `short:"i" long:"localip" description:"Include local ip in QRCode"`
-	Localhost bool       `short:"l" long:"localhost" description:"Use 127.0.0.1 for ip"`
-	Host      string     `long:"host" description:"Use specific host name"`
-	NoCert    bool       `long:"nocert" description:"Don't include the certificate"`
-	Port      uint16     `short:"p" long:"port" description:"Use this port"`
-	Url       bool       `short:"j" long:"url" description:"Display url instead of a QRCode"`
-	Image     bool       `short:"o" long:"image" description:"Output QRCode to file"`
-	Invoice   bool       `long:"invoice" description:"Use invoice macaroon"`
-	Readonly  bool       `long:"readonly" description:"Use readonly macaroon"`
-	Query     arrayFlags `short:"q" long:"query" description:"Add additional url query parameters"`
+	LocalIP     bool       `short:"i" long:"localip"     description:"Include local ip in QRCode"`
+	Localhost   bool       `short:"l" long:"localhost"   description:"Use 127.0.0.1 for ip"`
+	Host        string     `          long:"host"        description:"Use specific host name"`
+	NoCert      bool       `          long:"nocert"      description:"Don't include the certificate"`
+	Port        uint16     `short:"p" long:"port"        description:"Use this port"`
+	URL         bool       `short:"j" long:"url"         description:"Display url instead of a QRCode"`
+	Image       bool       `short:"o" long:"image"       description:"Output QRCode to file"`
+	Invoice     bool       `          long:"invoice"     description:"Use invoice macaroon"`
+	Readonly    bool       `          long:"readonly"    description:"Use readonly macaroon"`
+	Query       arrayFlags `short:"q" long:"query"       description:"Add additional url query parameters"`
+	CreateOnion bool       `short:"c" long:"createonion" description:"Create onion v3 hidden service to access REST interface."`
 }
 
 // config defines the configuration options for lndconnect.
@@ -64,27 +81,29 @@ type lndConnectConfig struct {
 type config struct {
 	LndConnect *lndConnectConfig `group:"LndConnect"`
 
-	LndDir         string `long:"lnddir" description:"The base directory that contains lnd's data, logs, configuration file, etc."`
-	ConfigFile     string `long:"C" long:"configfile" description:"Path to configuration file"`
-	DataDir        string `short:"b" long:"datadir" description:"The directory to find lnd's data within"`
-	TLSCertPath    string `long:"tlscertpath" description:"Path to read the TLS certificate from"`
-	AdminMacPath   string `long:"adminmacaroonpath" description:"Path to read the admin macaroon from"`
-	ReadMacPath    string `long:"readonlymacaroonpath" description:"Path to read the read-only macaroon from"`
-	InvoiceMacPath string `long:"invoicemacaroonpath" description:"Path to read the invoice-only macaroon from"`
+	LndDir           string   `long:"lnddir"               description:"The base directory that contains lnd's data, logs, configuration file, etc."`
+	ConfigFile       string   `long:"configfile"           description:"Path to configuration file"                                                  short:"C"`
+	DataDir          string   `long:"datadir"              description:"The directory to find lnd's data within"                                     short:"b"`
+	TLSCertPath      string   `long:"tlscertpath"          description:"Path to read the TLS certificate from"`
+	AdminMacPath     string   `long:"adminmacaroonpath"    description:"Path to read the admin macaroon from"`
+	ReadMacPath      string   `long:"readonlymacaroonpath" description:"Path to read the read-only macaroon from"`
+	InvoiceMacPath   string   `long:"invoicemacaroonpath"  description:"Path to read the invoice-only macaroon from"`
+	RawRESTListeners []string `long:"restlisten"           description:"Interface/Port/Socket listening for REST connections"`
 
-	Bitcoin  *chainConfig `group:"Bitcoin" namespace:"bitcoin"`
+	Bitcoin  *chainConfig `group:"Bitcoin"  namespace:"bitcoin"`
 	Litecoin *chainConfig `group:"Litecoin" namespace:"litecoin"`
 
+	Tor *torConfig `group:"Tor" namespace:"tor"`
+
 	// The following lines we only need to be able to parse the
 	// configuration INI file without errors. The content will be ignored.
-	BtcdMode      *chainConfig `hidden:"true" group:"btcd" namespace:"btcd"`
-	BitcoindMode  *chainConfig `hidden:"true" group:"bitcoind" namespace:"bitcoind"`
-	NeutrinoMode  *chainConfig `hidden:"true" group:"neutrino" namespace:"neutrino"`
-	LtcdMode      *chainConfig `hidden:"true" group:"ltcd" namespace:"ltcd"`
+	BtcdMode      *chainConfig `hidden:"true" group:"btcd"      namespace:"btcd"`
+	BitcoindMode  *chainConfig `hidden:"true" group:"bitcoind"  namespace:"bitcoind"`
+	NeutrinoMode  *chainConfig `hidden:"true" group:"neutrino"  namespace:"neutrino"`
+	LtcdMode      *chainConfig `hidden:"true" group:"ltcd"      namespace:"ltcd"`
 	LitecoindMode *chainConfig `hidden:"true" group:"litecoind" namespace:"litecoind"`
 	Autopilot     *chainConfig `hidden:"true" group:"Autopilot" namespace:"autopilot"`
-	Tor           *chainConfig `hidden:"true" group:"Tor" namespace:"tor"`
-	Hodl          *chainConfig `hidden:"true" group:"hodl" namespace:"hodl"`
+	Hodl          *chainConfig `hidden:"true" group:"hodl"      namespace:"hodl"`
 
 	net tor.Net
 }
@@ -93,10 +112,10 @@ type config struct {
 // line options.
 //
 // The configuration proceeds as follows:
-// 	1) Start with a default config with sane settings
-// 	2) Pre-parse the command line to check for an alternative config file
-// 	3) Load configuration file overwriting defaults with any specified options
-// 	4) Parse CLI options and overwrite/add any specified options
+//  1. Start with a default config with sane settings
+//  2. Pre-parse the command line to check for an alternative config file
+//  3. Load configuration file overwriting defaults with any specified options
+//  4. Parse CLI options and overwrite/add any specified options
 func loadConfig() (*config, error) {
 	defaultCfg := config{
 		LndConnect: &lndConnectConfig{
@@ -106,7 +125,10 @@ func loadConfig() (*config, error) {
 		ConfigFile:  defaultConfigFile,
 		DataDir:     defaultDataDir,
 		TLSCertPath: defaultTLSCertPath,
-		net:         &tor.ClearNet{},
+		Tor: &torConfig{
+			RESTKeyPath: defaultRESTKeyPath,
+		},
+		net: &tor.ClearNet{},
 	}
 
 	// Pre-parse the command line options to pick up an alternative config
@@ -130,6 +152,7 @@ func loadConfig() (*config, error) {
 		}
 		preCfg.DataDir = filepath.Join(lndDir, defaultDataDirname)
 		preCfg.TLSCertPath = filepath.Join(lndDir, defaultTLSCertFilename)
+		preCfg.Tor.RESTKeyPath = filepath.Join(lndDir, defaultRESTKeyFileName)
 	}
 
 	// Next, load any additional configuration options from the file.
@@ -176,7 +199,7 @@ func loadConfig() (*config, error) {
 			networkName = "simnet"
 		}
 		if numNets > 1 {
-			str := "The mainnet, testnet, regtest, and " +
+			str := "the mainnet, testnet, regtest, and " +
 				"simnet params can't be used together -- " +
 				"choose one of the four"
 			err := fmt.Errorf(str)
@@ -256,3 +279,16 @@ func cleanAndExpandPath(path string) string {
 	// but the variables can still be expanded via POSIX-style $VARIABLE.
 	return filepath.Clean(os.ExpandEnv(path))
 }
+
+// updates config with onion host and port
+func updateHostAddrConfig(addr string, loadedConfig *config) error {
+	parsedAddr := strings.Split(addr, ":")
+	loadedConfig.LndConnect.Host = parsedAddr[0]
+	parsedPort, err := strconv.ParseUint(parsedAddr[1], 10, 16)
+	if err != nil {
+		log.Fatal(err)
+	}
+	loadedConfig.LndConnect.Port = uint16(parsedPort)
+	loadedConfig.LndConnect.NoCert = true
+	return nil
+}

crypto.go

@@ -0,0 +1,16 @@
+package main
+
+import "io"
+
+// MockEncrypter is a mocked up structure implementing tor.NewOnionFile required encrypter methods
+type MockEncrypter struct{}
+
+// EncryptPayloadToWriter is implementing expected signature
+func (m MockEncrypter) EncryptPayloadToWriter(_ []byte, _ io.Writer) error {
+	return nil
+}
+
+// DecryptPayloadFromReader is implementing expected signature
+func (m MockEncrypter) DecryptPayloadFromReader(_ io.Reader) ([]byte, error) {
+	return []byte("hello world!"), nil
+}

go.mod

@@ -1,15 +1,14 @@
-module github.com/LN-Zap/lndconnect
+module github.com/roshii/lndconnect
 
 go 1.16
 
 require (
 	github.com/Baozisoftware/qrcode-terminal-go v0.0.0-20170407111555-c0650d8dff0f
-	github.com/btcsuite/btcutil v1.0.3-0.20201208143702-a53e38424cce
-	github.com/glendc/go-external-ip v0.0.0-20200601212049-c872357d968e
-	github.com/jessevdk/go-flags v1.4.0
-	github.com/lightningnetwork/lnd v0.13.0-beta.rc3
-	github.com/mattn/go-colorable v0.1.8 // indirect
+	github.com/btcsuite/btcd/btcutil v1.1.2
+	github.com/glendc/go-external-ip v0.1.0
+	github.com/jessevdk/go-flags v1.5.0
+	github.com/lightningnetwork/lnd/tor v1.1.0
 	github.com/skip2/go-qrcode v0.0.0-20200617195104-da1b6568686e
 )
 
-replace go.etcd.io/etcd => go.etcd.io/etcd v0.5.0-alpha.5.0.20201125193152-8a03d2e9614b
+require github.com/mattn/go-colorable v0.1.13 // indirect