aboutsummaryrefslogtreecommitdiffstats
path: root/cmd/puppeth/wizard_faucet.go
blob: e7d5ad4885f112aa033847615e5d2f25f2e70924 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
// Copyright 2017 The go-ethereum Authors
// This file is part of go-ethereum.
//
// go-ethereum is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// go-ethereum is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.

package main

import (
    "encoding/json"
    "fmt"
    "net/http"

    "github.com/ethereum/go-ethereum/accounts/keystore"
    "github.com/ethereum/go-ethereum/log"
)

// deployFaucet queries the user for various input on deploying a faucet, after
// which it executes it.
func (w *wizard) deployFaucet() {
    // Select the server to interact with
    server := w.selectServer()
    if server == "" {
        return
    }
    client := w.servers[server]

    // Retrieve any active faucet configurations from the server
    existed := true

    infos, err := checkFaucet(client, w.network)
    if err != nil {
        infos = &faucetInfos{
            node:    &nodeInfos{portFull: 30303, peersTotal: 25},
            port:    80,
            host:    client.server,
            amount:  1,
            minutes: 1440,
            tiers:   3,
        }
        existed = false
    }
    infos.node.genesis, _ = json.MarshalIndent(w.conf.Genesis, "", "  ")
    infos.node.network = w.conf.Genesis.Config.ChainId.Int64()

    // Figure out which port to listen on
    fmt.Println()
    fmt.Printf("Which port should the faucet listen on? (default = %d)\n", infos.port)
    infos.port = w.readDefaultInt(infos.port)

    // Figure which virtual-host to deploy ethstats on
    if infos.host, err = w.ensureVirtualHost(client, infos.port, infos.host); err != nil {
        log.Error("Failed to decide on faucet host", "err", err)
        return
    }
    // Port and proxy settings retrieved, figure out the funding amount per period configurations
    fmt.Println()
    fmt.Printf("How many Ethers to release per request? (default = %d)\n", infos.amount)
    infos.amount = w.readDefaultInt(infos.amount)

    fmt.Println()
    fmt.Printf("How many minutes to enforce between requests? (default = %d)\n", infos.minutes)
    infos.minutes = w.readDefaultInt(infos.minutes)

    fmt.Println()
    fmt.Printf("How many funding tiers to feature (x2.5 amounts, x3 timeout)? (default = %d)\n", infos.tiers)
    infos.tiers = w.readDefaultInt(infos.tiers)
    if infos.tiers == 0 {
        log.Error("At least one funding tier must be set")
        return
    }
    // Accessing GitHub gists requires API authorization, retrieve it
    if infos.githubUser != "" {
        fmt.Println()
        fmt.Printf("Reuse previous (%s) GitHub API authorization (y/n)? (default = yes)\n", infos.githubUser)
        if w.readDefaultString("y") != "y" {
            infos.githubUser, infos.githubToken = "", ""
        }
    }
    if infos.githubUser == "" {
        // No previous authorization (or new one requested)
        fmt.Println()
        fmt.Println("Which GitHub user to verify Gists through? (default = none = rate-limited API)")
        infos.githubUser = w.readDefaultString("")

        if infos.githubUser == "" {
            log.Warn("Funding requests via GitHub will be heavily rate-limited")
        } else {
            fmt.Println()
            fmt.Println("What is the GitHub personal access token of the user? (won't be echoed)")
            infos.githubToken = w.readPassword()

            // Do a sanity check query against github to ensure it's valid
            req, _ := http.NewRequest("GET", "https://api.github.com/user", nil)
            req.SetBasicAuth(infos.githubUser, infos.githubToken)
            res, err := http.DefaultClient.Do(req)
            if err != nil {
                log.Error("Failed to verify GitHub authentication", "err", err)
                return
            }
            defer res.Body.Close()

            var msg struct {
                Login   string `json:"login"`
                Message string `json:"message"`
            }
            if err = json.NewDecoder(res.Body).Decode(&msg); err != nil {
                log.Error("Failed to decode authorization response", "err", err)
                return
            }
            if msg.Login != infos.githubUser {
                log.Error("GitHub authorization failed", "user", infos.githubUser, "message", msg.Message)
                return
            }
        }
    }
    // Accessing the reCaptcha service requires API authorizations, request it
    if infos.captchaToken != "" {
        fmt.Println()
        fmt.Println("Reuse previous reCaptcha API authorization (y/n)? (default = yes)")
        if w.readDefaultString("y") != "y" {
            infos.captchaToken, infos.captchaSecret = "", ""
        }
    }
    if infos.captchaToken == "" {
        // No previous authorization (or old one discarded)
        fmt.Println()
        fmt.Println("Enable reCaptcha protection against robots (y/n)? (default = no)")
        if w.readDefaultString("n") == "n" {
            log.Warn("Users will be able to requests funds via automated scripts")
        } else {
            // Captcha protection explicitly requested, read the site and secret keys
            fmt.Println()
            fmt.Printf("What is the reCaptcha site key to authenticate human users?\n")
            infos.captchaToken = w.readString()

            fmt.Println()
            fmt.Printf("What is the reCaptcha secret key to verify authentications? (won't be echoed)\n")
            infos.captchaSecret = w.readPassword()
        }
    }
    // Figure out where the user wants to store the persistent data
    fmt.Println()
    if infos.node.datadir == "" {
        fmt.Printf("Where should data be stored on the remote machine?\n")
        infos.node.datadir = w.readString()
    } else {
        fmt.Printf("Where should data be stored on the remote machine? (default = %s)\n", infos.node.datadir)
        infos.node.datadir = w.readDefaultString(infos.node.datadir)
    }
    // Figure out which port to listen on
    fmt.Println()
    fmt.Printf("Which TCP/UDP port should the light client listen on? (default = %d)\n", infos.node.portFull)
    infos.node.portFull = w.readDefaultInt(infos.node.portFull)

    // Set a proper name to report on the stats page
    fmt.Println()
    if infos.node.ethstats == "" {
        fmt.Printf("What should the node be called on the stats page?\n")
        infos.node.ethstats = w.readString() + ":" + w.conf.ethstats
    } else {
        fmt.Printf("What should the node be called on the stats page? (default = %s)\n", infos.node.ethstats)
        infos.node.ethstats = w.readDefaultString(infos.node.ethstats) + ":" + w.conf.ethstats
    }
    // Load up the credential needed to release funds
    if infos.node.keyJSON != "" {
        if key, err := keystore.DecryptKey([]byte(infos.node.keyJSON), infos.node.keyPass); err != nil {
            infos.node.keyJSON, infos.node.keyPass = "", ""
        } else {
            fmt.Println()
            fmt.Printf("Reuse previous (%s) funding account (y/n)? (default = yes)\n", key.Address.Hex())
            if w.readDefaultString("y") != "y" {
                infos.node.keyJSON, infos.node.keyPass = "", ""
            }
        }
    }
    for i := 0; i < 3 && infos.node.keyJSON == ""; i++ {
        fmt.Println()
        fmt.Println("Please paste the faucet's funding account key JSON:")
        infos.node.keyJSON = w.readJSON()

        fmt.Println()
        fmt.Println("What's the unlock password for the account? (won't be echoed)")
        infos.node.keyPass = w.readPassword()

        if _, err := keystore.DecryptKey([]byte(infos.node.keyJSON), infos.node.keyPass); err != nil {
            log.Error("Failed to decrypt key with given passphrase")
            infos.node.keyJSON = ""
            infos.node.keyPass = ""
        }
    }
    // Check if the user wants to run the faucet in debug mode (noauth)
    noauth := "n"
    if infos.noauth {
        noauth = "y"
    }
    fmt.Println()
    fmt.Printf("Permit non-authenticated funding requests (y/n)? (default = %v)\n", infos.noauth)
    infos.noauth = w.readDefaultString(noauth) != "n"

    // Try to deploy the faucet server on the host
    nocache := false
    if existed {
        fmt.Println()
        fmt.Printf("Should the faucet be built from scratch (y/n)? (default = no)\n")
        nocache = w.readDefaultString("n") != "n"
    }
    if out, err := deployFaucet(client, w.network, w.conf.bootLight, infos, nocache); err != nil {
        log.Error("Failed to deploy faucet container", "err", err)
        if len(out) > 0 {
            fmt.Printf("%s\n", out)
        }
        return
    }
    // All ok, run a network scan to pick any changes up
    w.networkStats()
}