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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
/*
* This file is part of LibEuFin.
* Copyright (C) 2023 Stanisci and Dold.
* LibEuFin is free software; you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation; either version 3, or
* (at your option) any later version.
* LibEuFin 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 Affero General
* Public License for more details.
* You should have received a copy of the GNU Affero General Public
* License along with LibEuFin; see the file COPYING. If not, see
* <http://www.gnu.org/licenses/>
*/
package tech.libeufin.nexus
import com.github.ajalt.clikt.core.CliktCommand
import com.github.ajalt.clikt.parameters.groups.*
import com.github.ajalt.clikt.parameters.options.*
import io.ktor.client.*
import io.ktor.client.plugins.*
import tech.libeufin.common.*
import tech.libeufin.common.crypto.*
import tech.libeufin.nexus.ebics.*
import tech.libeufin.nexus.ebics.EbicsKeyMng.Order.*
import java.nio.file.*
import java.time.Instant
import kotlin.io.path.*
/**
* Obtains the client private keys, regardless of them being
* created for the first time, or read from an existing file
* on disk.
*
* @param path path to the file that contains the keys.
* @return current or new client keys
*/
private fun loadOrGenerateClientKeys(path: Path): ClientPrivateKeysFile {
// If exists load from disk
val current = loadClientKeys(path)
if (current != null) return current
// Else create new keys
val newKeys = generateNewKeys()
persistClientKeys(newKeys, path)
logger.info("New client private keys created at '$path'")
return newKeys
}
/**
* @return the "this" string with a space every two characters.
*/
fun String.spaceEachTwo() =
buildString {
this@spaceEachTwo.forEachIndexed { pos, c ->
when {
(pos == 0) -> this.append(c)
(pos % 2 == 0) -> this.append(" $c")
else -> this.append(c)
}
}
}
/**
* Asks the user to accept the bank public keys.
*
* @param bankKeys bank public keys, in format stored on disk.
* @return true if the user accepted, false otherwise.
*/
private fun askUserToAcceptKeys(bankKeys: BankPublicKeysFile): Boolean {
val encHash = CryptoUtil.getEbicsPublicKeyHash(bankKeys.bank_encryption_public_key).encodeUpHex()
val authHash = CryptoUtil.getEbicsPublicKeyHash(bankKeys.bank_authentication_public_key).encodeUpHex()
println("The bank has the following keys:")
println("Encryption key: ${encHash.spaceEachTwo()}")
println("Authentication key: ${authHash.spaceEachTwo()}")
print("type 'yes, accept' to accept them: ")
val userResponse: String? = readlnOrNull()
return userResponse == "yes, accept"
}
/**
* Collects all the steps from generating the message, to
* sending it to the bank, and finally updating the state
* on disk according to the response.
*
* @param cfg handle to the configuration.
* @param privs bundle of all the private keys of the client.
* @param client the http client that requests to the bank.
* @param orderType INI or HIA.
* @param autoAcceptBankKeys only given in case of HPB. Expresses
* the --auto-accept-key CLI flag.
*/
suspend fun doKeysRequestAndUpdateState(
cfg: NexusConfig,
privs: ClientPrivateKeysFile,
client: HttpClient,
order: EbicsKeyMng.Order
) {
logger.info("Doing key request $order")
val req = EbicsKeyMng(cfg, privs, true).request(order)
val xml = client.postToBank(cfg.hostBaseUrl, req, order.name)
val resp = EbicsKeyMng.parseResponse(xml, privs.encryption_private_key)
when (order) {
INI, HIA -> {
if (resp.technicalCode == EbicsReturnCode.EBICS_INVALID_USER_OR_USER_STATE) {
throw Exception("$order status code ${resp.technicalCode}: either your IDs are incorrect, or you already have keys registered with this bank")
}
}
HPB -> {
if (resp.technicalCode == EbicsReturnCode.EBICS_AUTHENTICATION_FAILED) {
throw Exception("$order status code ${resp.technicalCode}: could not download bank keys, send client keys (and/or related PDF document with --generate-registration-pdf) to the bank")
}
}
}
val orderData = resp.okOrFail(order.name)
when (order) {
INI -> privs.submitted_ini = true
HIA -> privs.submitted_hia = true
HPB -> {
val orderData = requireNotNull(orderData) {
"HPB: missing order data"
}
val (authPub, encPub) = EbicsKeyMng.parseHpbOrder(orderData)
val bankKeys = BankPublicKeysFile(
bank_authentication_public_key = authPub,
bank_encryption_public_key = encPub,
accepted = false
)
try {
persistBankKeys(bankKeys, cfg.bankPublicKeysPath)
} catch (e: Exception) {
throw Exception("Could not update the $order state on disk", e)
}
}
}
if (order != HPB) {
try {
persistClientKeys(privs, cfg.clientPrivateKeysPath)
} catch (e: Exception) {
throw Exception("Could not update the $order state on disk", e)
}
}
}
/**
* Mere collector of the steps to load and parse the config.
*
* @param configFile location of the configuration entry point.
* @return internal representation of the configuration.
*/
fun extractEbicsConfig(configFile: Path?): NexusConfig {
val config = loadConfig(configFile)
return NexusConfig(config)
}
/**
* Mere collector of the PDF generation steps. Fails the
* process if a problem occurs.
*
* @param privs client private keys.
* @param cfg configuration handle.
*/
private fun makePdf(privs: ClientPrivateKeysFile, cfg: NexusConfig) {
val pdf = generateKeysPdf(privs, cfg)
val path = Path("/tmp/libeufin-nexus-keys-${Instant.now().epochSecond}.pdf")
try {
path.writeBytes(pdf, StandardOpenOption.CREATE_NEW)
} catch (e: Exception) {
if (e is FileAlreadyExistsException) throw Exception("PDF file exists already at '$path', not overriding it")
throw Exception("Could not write PDF to '$path'", e)
}
println("PDF file with keys created at '$path'")
}
/**
* CLI class implementing the "ebics-setup" subcommand.
*/
class EbicsSetup: CliktCommand("Set up the EBICS subscriber") {
private val common by CommonOption()
private val forceKeysResubmission by option(
help = "Resubmits all the keys to the bank"
).flag(default = false)
private val autoAcceptKeys by option(
help = "Accepts the bank keys without the user confirmation"
).flag(default = false)
private val generateRegistrationPdf by option(
help = "Generates the PDF with the client public keys to send to the bank"
).flag(default = false)
/**
* This function collects the main steps of setting up an EBICS access.
*/
override fun run() = cliCmd(logger, common.log) {
val cfg = extractEbicsConfig(common.config)
// Config is sane. Go (maybe) making the private keys.
val clientKeys = loadOrGenerateClientKeys(cfg.clientPrivateKeysPath)
val client = HttpClient {
install(HttpTimeout) {
// It can take a lot of time for the bank to generate documents
socketTimeoutMillis = 5 * 60 * 1000
}
}
// Privs exist. Upload their pubs
val keysNotSub = !clientKeys.submitted_ini
if ((!clientKeys.submitted_ini) || forceKeysResubmission)
doKeysRequestAndUpdateState(cfg, clientKeys, client, INI)
// Eject PDF if the keys were submitted for the first time, or the user asked.
if (keysNotSub || generateRegistrationPdf) makePdf(clientKeys, cfg)
if ((!clientKeys.submitted_hia) || forceKeysResubmission)
doKeysRequestAndUpdateState(cfg, clientKeys, client, HIA)
// Checking if the bank keys exist on disk.
var bankKeys = loadBankKeys(cfg.bankPublicKeysPath)
if (bankKeys == null) {
doKeysRequestAndUpdateState(cfg, clientKeys, client, HPB)
logger.info("Bank keys stored at ${cfg.bankPublicKeysPath}")
bankKeys = loadBankKeys(cfg.bankPublicKeysPath)!!
}
if (!bankKeys.accepted) {
// Finishing the setup by accepting the bank keys.
if (autoAcceptKeys) bankKeys.accepted = true
else bankKeys.accepted = askUserToAcceptKeys(bankKeys)
if (!bankKeys.accepted) {
throw Exception("Cannot successfully finish the setup without accepting the bank keys")
}
try {
persistBankKeys(bankKeys, cfg.bankPublicKeysPath)
} catch (e: Exception) {
throw Exception("Could not set bank keys as accepted on disk", e)
}
}
println("setup ready")
}
}
|
