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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
|
/*
* This file is part of LibEuFin.
* Copyright (C) 2024 Taler Systems S.A.
* 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/>
*/
/**
* This file contains helpers to construct EBICS 2.x requests.
*/
package tech.libeufin.nexus.ebics
import org.slf4j.Logger
import org.slf4j.LoggerFactory
import org.w3c.dom.Document
import tech.libeufin.common.crypto.CryptoUtil
import tech.libeufin.common.*
import tech.libeufin.nexus.*
import tech.libeufin.nexus.BankPublicKeysFile
import tech.libeufin.nexus.ClientPrivateKeysFile
import tech.libeufin.nexus.EbicsSetupConfig
import java.io.InputStream
import java.time.Instant
import java.time.ZoneId
import java.util.*
import javax.xml.datatype.DatatypeFactory
import java.security.interfaces.*
private val logger: Logger = LoggerFactory.getLogger("libeufin-nexus-ebics2")
/**
* Parses the raw XML that came from the bank into the Nexus representation.
*
* @param clientEncryptionKey client private encryption key, used to decrypt
* the transaction key.
* @param xml the bank raw XML response
* @return the internal representation of the XML response, or null if the parsing or the decryption failed.
* Note: it _is_ possible to successfully return the internal repr. of this response, where
* the payload is null. That's however still useful, because the returned type provides bank
* and EBICS return codes.
*/
fun parseKeysMgmtResponse(
clientEncryptionKey: RSAPrivateCrtKey,
xml: Document
): EbicsKeyManagementResponseContent {
return XmlDestructor.fromDoc(xml, "ebicsKeyManagementResponse") {
lateinit var technicalReturnCode: EbicsReturnCode
lateinit var bankReturnCode: EbicsReturnCode
lateinit var reportText: String
var payload: ByteArray? = null
one("header") {
one("mutable") {
technicalReturnCode = EbicsReturnCode.lookup(one("ReturnCode").text())
reportText = one("ReportText").text()
}
}
one("body") {
bankReturnCode = EbicsReturnCode.lookup(one("ReturnCode").text())
payload = opt("DataTransfer") {
val descriptionInfo = one("DataEncryptionInfo") {
DataEncryptionInfo(
one("TransactionKey").text().decodeBase64(),
one("EncryptionPubKeyDigest").text().decodeBase64()
)
}
decryptAndDecompressPayload(
clientEncryptionKey,
descriptionInfo,
listOf(one("OrderData").text())
).readBytes()
}
}
EbicsKeyManagementResponseContent(technicalReturnCode, bankReturnCode, payload)
}
}
private fun XmlBuilder.RSAKeyXml(key: RSAPrivateCrtKey) {
el("ns2:PubKeyValue") {
el("ds:RSAKeyValue") {
el("ds:Modulus", key.modulus.encodeBase64())
el("ds:Exponent", key.publicExponent.encodeBase64())
}
}
}
private fun XMLOrderData(cfg: EbicsSetupConfig, name: String, schema: String, build: XmlBuilder.() -> Unit): String {
return XmlBuilder.toBytes(name) {
attr("xmlns:ds", "http://www.w3.org/2000/09/xmldsig#")
attr("xmlns:ns2", schema)
build()
el("ns2:PartnerID", cfg.ebicsPartnerId)
el("ns2:UserID", cfg.ebicsUserId)
}.inputStream().deflate().encodeBase64()
}
/**
* Generates the INI message to upload the signature key.
*
* @param cfg handle to the configuration.
* @param clientKeys set of all the client keys.
* @return the raw EBICS INI message.
*/
fun generateIniMessage(cfg: EbicsSetupConfig, clientKeys: ClientPrivateKeysFile): ByteArray {
val inner = XMLOrderData(cfg, "ns2:SignaturePubKeyOrderData", "http://www.ebics.org/S001") {
el("ns2:SignaturePubKeyInfo") {
RSAKeyXml(clientKeys.signature_private_key)
el("ns2:SignatureVersion", "A006")
}
}
val doc = XmlBuilder.toDom("ebicsUnsecuredRequest", "urn:org:ebics:H004") {
attr("http://www.w3.org/2000/xmlns/", "xmlns", "urn:org:ebics:H004")
attr("http://www.w3.org/2000/xmlns/", "xmlns:ds", "http://www.w3.org/2000/09/xmldsig#")
attr("Version", "H004")
attr("Revision", "1")
el("header") {
attr("authenticate", "true")
el("static") {
el("HostID", cfg.ebicsHostId)
el("PartnerID", cfg.ebicsPartnerId)
el("UserID", cfg.ebicsUserId)
el("OrderDetails") {
el("OrderType", "INI")
el("OrderAttribute", "DZNNN")
}
el("SecurityMedium", "0200")
}
el("mutable")
}
el("body/DataTransfer/OrderData", inner)
}
return XMLUtil.convertDomToBytes(doc)
}
/**
* Generates the HIA message: uploads the authentication and
* encryption keys.
*
* @param cfg handle to the configuration.
* @param clientKeys set of all the client keys.
* @return the raw EBICS HIA message.
*/
fun generateHiaMessage(cfg: EbicsSetupConfig, clientKeys: ClientPrivateKeysFile): ByteArray {
val inner = XMLOrderData(cfg, "ns2:HIARequestOrderData", "urn:org:ebics:H004") {
el("ns2:AuthenticationPubKeyInfo") {
RSAKeyXml(clientKeys.authentication_private_key)
el("ns2:AuthenticationVersion", "X002")
}
el("ns2:EncryptionPubKeyInfo") {
RSAKeyXml(clientKeys.encryption_private_key)
el("ns2:EncryptionVersion", "E002")
}
}
val doc = XmlBuilder.toDom("ebicsUnsecuredRequest", "urn:org:ebics:H004") {
attr("http://www.w3.org/2000/xmlns/", "xmlns", "urn:org:ebics:H004")
attr("http://www.w3.org/2000/xmlns/", "xmlns:ds", "http://www.w3.org/2000/09/xmldsig#")
attr("Version", "H004")
attr("Revision", "1")
el("header") {
attr("authenticate", "true")
el("static") {
el("HostID", cfg.ebicsHostId)
el("PartnerID", cfg.ebicsPartnerId)
el("UserID", cfg.ebicsUserId)
el("OrderDetails") {
el("OrderType", "HIA")
el("OrderAttribute", "DZNNN")
}
el("SecurityMedium", "0200")
}
el("mutable")
}
el("body/DataTransfer/OrderData", inner)
}
return XMLUtil.convertDomToBytes(doc)
}
/**
* Generates the HPB message: downloads the bank keys.
*
* @param cfg handle to the configuration.
* @param clientKeys set of all the client keys.
* @return the raw EBICS HPB message.
*/
fun generateHpbMessage(cfg: EbicsSetupConfig, clientKeys: ClientPrivateKeysFile): ByteArray {
val nonce = getNonce(128)
val doc = XmlBuilder.toDom("ebicsNoPubKeyDigestsRequest", "urn:org:ebics:H004") {
attr("http://www.w3.org/2000/xmlns/", "xmlns", "urn:org:ebics:H004")
attr("http://www.w3.org/2000/xmlns/", "xmlns:ds", "http://www.w3.org/2000/09/xmldsig#")
attr("Version", "H004")
attr("Revision", "1")
el("header") {
attr("authenticate", "true")
el("static") {
el("HostID", cfg.ebicsHostId)
el("Nonce", nonce.encodeUpHex())
el("Timestamp", Instant.now().xmlDateTime())
el("PartnerID", cfg.ebicsPartnerId)
el("UserID", cfg.ebicsUserId)
el("OrderDetails") {
el("OrderType", "HPB")
el("OrderAttribute", "DZHNN")
}
el("SecurityMedium", "0000")
}
el("mutable")
}
el("AuthSignature")
el("body")
}
XMLUtil.signEbicsDocument(doc, clientKeys.authentication_private_key)
return XMLUtil.convertDomToBytes(doc)
}
class HpbResponseData(
val hostID: String,
val encryptionPubKey: RSAPublicKey,
val encryptionVersion: String,
val authenticationPubKey: RSAPublicKey,
val authenticationVersion: String
)
fun parseEbicsHpbOrder(orderDataRaw: InputStream): HpbResponseData {
return XmlDestructor.fromStream(orderDataRaw, "HPBResponseOrderData") {
val (authenticationPubKey, authenticationVersion) = one("AuthenticationPubKeyInfo") {
Pair(
one("PubKeyValue").one("RSAKeyValue") {
CryptoUtil.loadRsaPublicKeyFromComponents(
one("Modulus").text().decodeBase64(),
one("Exponent").text().decodeBase64(),
)
},
one("AuthenticationVersion").text()
)
}
val (encryptionPubKey, encryptionVersion) = one("EncryptionPubKeyInfo") {
Pair(
one("PubKeyValue").one("RSAKeyValue") {
CryptoUtil.loadRsaPublicKeyFromComponents(
one("Modulus").text().decodeBase64(),
one("Exponent").text().decodeBase64(),
)
},
one("EncryptionVersion").text()
)
}
val hostID: String = one("HostID").text()
HpbResponseData(
hostID = hostID,
encryptionPubKey = encryptionPubKey,
encryptionVersion = encryptionVersion,
authenticationPubKey = authenticationPubKey,
authenticationVersion = authenticationVersion
)
}
}
data class EbicsKeyManagementResponseContent(
val technicalReturnCode: EbicsReturnCode,
val bankReturnCode: EbicsReturnCode?,
val orderData: ByteArray?
)
|
