Stratum V2 employs a type of encryption scheme called AEAD (authenticated encryption with associated data) to address the security aspects of all communication that occurs between clients and servers. This provides both confidentiality and integrity for the ciphertexts (i.e. encrypted data) being transferred, as well as providing integrity for associated data which is not encrypted. Prior to opening any Stratum V2 channels for mining, clients MUST first initiate the cryptographic session state that is used to encrypt all messages sent between themselves and servers. Thus, the cryptographic session state is independent of V2 messaging conventions.
At the same time, this specification proposes optional use of a particular handshake protocol based on the Noise Protocol framework (opens new window). The client and server establish secure communication using Diffie-Hellman (DH) key agreement, as described in greater detail in the Authenticated Key Agreement Handshake section below.
Using the handshake protocol to establish secured communication is optional on the local network (e.g. local mining devices talking to a local mining proxy). However, it is mandatory for remote access to the upstream nodes, whether they be pool mining services, job declarating services or template distributors.
Data transferred by the mining protocol MUST not provide adversary information that they can use to estimate the performance of any particular miner. Any intelligence about submitted shares can be directly converted to estimations of a miner’s earnings and can be associated with a particular username. This is unacceptable privacy leakage that needs to be addressed.
The reasons why Noise Protocol Framework has been chosen are listed below:
Noise encrypted session requires Elliptic Curve (EC), Hash function (HASH()
) and cipher function that supports AEAD mode1.
This specification describes mandatory cryptographic primitives that each implementation needs to support. These primitives are chosen so that Noise Encryption layer for Stratum V2 can be implemented using primitives already present in Bitcoin Core project at the time of writing this spec.
Secp256k1 curve points, i.e. Public Keys, are points with of X- and Y-coordinate. We serialize them in three different ways, only using the x-coordinate.
When signing or verifying a certificate, we use the 32 byte x-only encoding as defined in BIP 340.3.
When sharing keys during the handshake, whether in plain text or encrypted, we use the 64 byte ElligatorSwift x-only encoding as defined in BIP3247 under "ElligatorSwift encoding of curve X coordinates". This encoding uses 64-bytes instead of 32-bytes in order to produce a pseudo-random bytesteam. This is useful because the protocol handshake starts with each side sending their public key in plain text. Additionally the use of X-only ElligatorSwift ECDH removes the need to grind or negate private keys.
The Authority public key is base58-check encoded as described in 4.7.
Digital signatures are serialized in 64-bytes like in BIP3403.
Key generation algorithm:
sk
d' = int(sk)
d = 0
or d' > n
where n
is group order of secp256k1 curveP
as d'⋅G
(sk, ellswift_pub)
To perform X-only ECDH we use ellswift_ecdh_xonly(ellswift_theirs, d) as described in BIP3247 under "Shared secret computation". The result is 32 bytes.
No assumption is made about the parity of Y-coordinate. For the purpose of signing (e.g. certificate) and ECDH (handshake) it is not necessary to "grind" the private key. The choosen algoritms take care of this by implicitly negatating the key, as if its public key had an even Y-coordinate.
For more information refer to BIP3403 and BIP3247.
SHA-256()
is used as a HASH()
k
, nonce n
, associated_data ad
, plaintext pt
and ciphertext ct
ENCRYPT(k, n, ad, pt)
DECRYPT(k, n, ad, ct)
Object that encapsulates encryption and decryption operations with underlying AEAD mode cipher functions using 32-byte encryption key k
and 8-byte nonce n
.
CipherState has the following interface:
InitializeKey(key)
:
k = key
, n = 0
EncryptWithAd(ad, plaintext)
k
is non-empty, performs ENCRYPT(k, n++, ad, plaintext)
on the underlying cipher function, otherwise returns plaintext
. The ++
post-increment operator applied to n
means: "use the current n value, then increment it".ENCRYPT
is an evaluation of ChaCha20-Poly1305
(IETF variant) with the passed arguments, with nonce n
encoded as 32 zero bits, followed by a little-endian 64-bit value. Note: this follows the Noise Protocol convention, rather than our normal endian.DecryptWithAd(ad, ciphertext)
k
is non-empty performs DECRYPT(k, n++, ad, plaintext)
on the underlying cipher function, otherwise returns ciphertext. If an authentication failure occurs in DECRYPT()
then n
is not incremented and an error is signaled to the caller.DECRYPT
is an evaluation of ChaCha20-Poly1305
(IETF variant) with the passed arguments, with nonce n
encoded as 32 zero bits, followed by a little-endian 64-bit value.Throughout the handshake process, each side maintains these variables:
ck
: chaining key. Accumulated hash of all previous ECDH outputs. At the end of the handshake ck
is used to derive encryption key k
.h
: handshake hash. Accumulated hash of all handshake data that has been sent and received so far during the handshake processe
, re
ephemeral keys. Ephemeral key and remote party's ephemeral key, respectively.s
, rs
static keys. Static key and remote party's static key, respectively.The following functions will also be referenced:
generateKey()
: generates and returns a fresh secp256k1
keypair
generateKey
has two attributes:
.public_key
, which returns an abstract object representing the public key.private_key
, which represents the private key used to generate the public key.serializeEllSwift()
that outputs a 64-byte EllSwift encoded serialization of the X-coordinate of EC point (the Y-coordinate is ignored)a || b
denotes the concatenation of two byte strings a
and b
HMAC-HASH(key, data)
RFC 2104
5k' = k || <zero-bytes>
temp = SHA-256((k' XOR ipad) || data)
where ipad is repeated 0x36 byteSHA-256((k' XOR opad) || temp)
where opad is repeated 0x5c byteHKDF(chaining_key, input_key_material)
: a function defined in RFC 5869
6, evaluated with a zero-length info
field and 2 num_output
field:
temp_key = HMAC-HASH(chaining_key, input_key_material)
output1 = HMAC-HASH(temp_key, byte(0x01))
output2 = HMAC-HASH(temp_key, output1 || byte(0x02))
(output1, output2)
MixKey(input_key_material)
: Executes the following steps:
(ck, temp_k) = HKDF(ck, input_key_material, 2)
InitializeKey(temp_k)
MixHash(data)
: Sets h = HASH(h || data)
EncryptAndHash(plaintext)
:
k
is non-empty sets ciphertext = EncryptWithAd(h, plaintext)
, otherwise ciphertext = plaintext
MixHash(ciphertext)
ciphertext
DecryptAndHash(ciphertext)
:
k
is non-empty sets plaintext = DecryptWithAd(h, ciphertext)
, otherwise plaintext = ciphertext
MixHash(ciphertext)
plaintext
ECDH(k, rk)
: performs an Elliptic-Curve Diffie-Hellman operation
using k
, which is a valid secp256k1
private key, and rk
, which is a EllSwift
encoded public key
v2_ecdh
defined in BIP3247:
k, ellswift_k
be key pair created by ellswift_create()
functionrk
be remote public key encoded as ellswift.initiator
be bool flag that is true if the party performing ECDH initiated the handshakeECDH(k, rk) = v2_ecdh(k, ellswift_k, rk, initiator)
v2_ecdh(k, ellswift_k, rk, initiator)
:
ecdh_point_x32
= ellswift_ecdh_xonly(rk, k)
tagged_hash(ellswift_k, rk, ecdh_point_x32)
tagged_hash(rk, ellswift_k, ecdh_point_x32)
ellswift_ecdh_xonly
- see BIP3247
tagged_hash(a, b, c)
:
SHA256("bip324_ellswift_xonly_ecdh")
SHA256(concatenate(tag, tag, a, b, c))
The handshake chosen for the authenticated key exchange is an Noise_NX
augmented by server authentication with simple 2 level public key infrastructure.
The complete authenticated key agreement (Noise NX
) is performed in three distinct steps (acts).
-> e
<- e, ee, s, es, SIGNATURE_NOISE_MESSAGE
SIGNATURE_NOISE_MESSAGE
Should the decryption (i.e. authentication code validation) fail at any point, the session must be terminated.
-> e
Prior to starting first round of NX-handshake, both initiator and responder initializes handshake variables h
(hash output), ck
(chaining key) and k
(encryption key):
h = HASH(protocolName)
protocolName
more than 32 bytes in length, apply HASH
to it.protocolName
is official noise protocol name: Noise_NX_Secp256k1+EllSwift_ChaChaPoly_SHA256
encoded as an ASCII stringck = h
h = HASH(h)
k
emptyInitiator generates ephemeral keypair and sends the public key to the responder:
e
, appends e.public_key.serializeEllSwift()
to the buffer (64 bytes plaintext EllSwift encoded public key)MixHash(e.public_key)
EncryptAndHash()
with empty payload and appends the ciphertext to the buffer (note that k is empty at this point, so this effectively reduces down to MixHash()
on empty data)Field name | Description |
---|---|
PUBKEY | Initiator's ephemeral public key |
Message length: 64 bytes
re.public_key
MixHash(re.public_key)
DecryptAndHash()
on remaining bytes (i.e. on empty data with empty k, thus effectively only calls MixHash()
on empty data)<- e, ee, s, es, SIGNATURE_NOISE_MESSAGE
Responder provides its ephemeral, encrypted static public keys and encrypted SIGNATURE_NOISE_MESSAGE
to the initiator, performs Elliptic-Curve Diffie-Hellman operations.
Field Name | Data Type | Description |
---|---|---|
version | U16 | Version of the certificate format |
valid_from | U32 | Validity start time (unix timestamp) |
not_valid_after | U32 | Signature is invalid after this point in time (unix timestamp) |
signature | SIGNATURE | Certificate signature |
Length: 74 bytes
e
, appends e.public_key
to the buffer (64 bytes plaintext EllSwift encoded public key)MixHash(e.public_key)
MixKey(ECDH(e.private_key, re.public_key))
EncryptAndHash(s.public_key)
(64 bytes encrypted EllSwift encoded public key, 16 bytes MAC)MixKey(ECDH(s.private_key, re.public_key))
EncryptAndHash(SIGNATURE_NOISE_MESSAGE)
to the buffertemp_k1, temp_k2 = HKDF(ck, zerolen, 2)
c1
and c2
c1.InitializeKey(temp_k1)
and c2.InitializeKey(temp_k2)
(c1, c2)
Field name | Description |
---|---|
PUBKEY | Responder's plaintext ephemeral public key |
PUBKEY | Responder's encrypted static public key |
MAC | Message authentication code for responder's static public key |
SIGNATURE_NOISE_MESSAGE | Signed message containing Responder's static key. Signature is issued by authority that is generally known to operate the server acting as the noise responder |
MAC | Message authentication code for SIGNATURE_NOISE_MESSAGE |
Message length: 170 bytes
re.public_key
MixHash(re.public_key)
MixKey(ECDH(e.private_key, re.public_key))
DecryptAndHash()
and stores the results as rs.public_key
which is server's static public key (note that 64 bytes is the public key and 16 bytes is MAC)MixKey(ECDH(e.private_key, rs.public_key)
DecryptAndHash()
and deserialize plaintext into SIGNATURE_NOISE_MESSAGE
(74 bytes data + 16 bytes MAC)temp_k1, temp_k2 = HKDF(ck, zerolen, 2)
c1
and c2
c1.InitializeKey(temp_k1)
and c2.InitializeKey(temp_k2)
(c1, c2)
During the handshake, initiator receives SIGNATURE_NOISE_MESSAGE
and server's static public key. These parts make up a CERTIFICATE
signed by an authority whose public key is generally known (for example from pool's website). Initiator confirms the identity of the server by verifying the signature in the certificate.
Field Name | Data Type | Description | Signed field |
---|---|---|---|
version | U16 | Version of the certificate format | YES |
valid_from | U32 | Validity start time (unix timestamp) | YES |
not_valid_after | U32 | Signature is invalid after this point in time (unix timestamp) | YES |
server_public_key | PUBKEY | Server's static public key that was used during NX handshake | YES |
authority_public_key | PUBKEY | Certificate authority's public key that signed this message | NO |
signature | SIGNATURE | Signature over the serialized fields marked for signing | NO |
This message is not sent directly. Instead, it is constructed from SIGNATURE_NOISE_MESSAGE and server's static public key that are sent during the handshake process
The PUBKEY fields are encoded using only their 32 byte x-coordinate and not with EllSwift. For the purpose of generating and verifying the certificate, the 64 byte EllSwift encoded server_public_key can be decoded to its 32 byte x-coordinate.
Schnorr signature with key prefixing is used3
signature is constructed for
m
, where m
is HASH
of the serialized fields of the CERTIFICATE
that are marked for signing, i.e. m = SHA-256(version || valid_from || not_valid_after || server_public_key)
P
that is Certificate AuthoritySignature itself is concatenation of an EC point R
and an integer s
(note that each item is serialized as 32 bytes array) for which identity s⋅G = R + HASH(R || P || m)⋅P
holds.
After handshake process is finished, both initiator and responder have CipherState objects for encryption and decryption and after initiator validated server's identity, any subsequent traffic is encrypted and decrypted with EncryptWithAd()
and DecryptWithAd()
methods of the respective CipherState objects with zero-length associated data.
Maximum transport message length (ciphertext) is for noise protocol message 65535 bytes.
Since Stratum Message Frame consists of
Stratum Message header and stratum message payload are processed separately.
message_length
is the length of the plaintext payload.EncryptWithAd([], header)
- 22 bytes
5. EncryptWithAd([], payload)
- variable length encrypted messagemessage_length
(payload_length) in the encrypted Stratum message header always reflects the plaintext payload size. The size of the encrypted payload is implicitly understood to be message_length + MAC size for each block. This simplifies the decryption process and ensures clarity in interpreting frame data.frame.message_length
should first be converted to the ciphertext length, and then that amount of data should be read and decrypted into plaintext payload. If decryption fails, the process stopsframe.extension_type
and frame.message_type
or fail*converting plaintext length to ciphertext length:
#define MAX_CT_LEN 65535
#define MAC_LEN 16
#define MAX_PT_LEN (MAX_CT_LEN - MAC_LEN)
uint pt_len_to_ct_len(uint pt_len) {
uint remainder;
remainder = pt_len % MAX_PT_LEN;
if (remainder > 0) {
remainder += MAC_LEN;
}
return pt_len / MAX_PT_LEN * MAX_CT_LEN + remainder;
}
+--------------------------------------------------+-------------------------------------------------------------------+
| Extended noise header | Encrypted stratum-message payload |
+--------------------------------------------------+-------------------+-------------------+---------------------------+
| Header AEAD ciphertext | Noise block 1 | Noise block 2 | Last Noise block |
| 22 Bytes | 65535 Bytes | 65535 Bytes | 17 - 65535 Bytes |
+----------------------------------------+---------+-----------+-------+-----------+-------+---------------+-----------+
| Encrypted Stratum message Header | MAC | ct_pld_1 | MAC_1 | ct_pld_2 | MAC_2 | ct_pld_rest | MAC_rest |
| 6 Bytes | 16 B | 65519 B | 16 B | 65519 B | 16 B | 1 - 65519 B | 16 Bytes |
+================+==========+============+=========+===========+=======+===========+=======+===============+===========+
| extension_type | msg_type | pld_length | <padd | pt_pld_1 | <padd | pt_pld_2 | <padd | pt_pld_rest | <padding> |
| U16 | U8 | U24 | ing> | 65519 B | ing> | 65519 B | ing> | 1 - 65519 B | |
+----------------+----------+------------+---------+-------------------------------------------------------------------+
The `pld_length` field in the Encrypted Stratum message Header now consistently represents the plaintext length of the payload.
Serialized stratum-v2 body (payload) is split into 65519-byte chunks and encrypted to form 65535-bytes AEAD ciphertexts,
where `ct_pld_N` is the N-th ciphertext block of payload and `pt_pld_N` is the N-th plaintext block of payload.
Downstream nodes that want to use the above outlined security scheme need to have configured the Pool Authority Public Key of the pool that they intend to connect to. It is provided by the target pool and communicated to its users via a trusted channel. At least, it can be published on the pool's public website.
The key can be embedded into the mining URL as part of the path.
Authority Public key is base58-check (opens new window) encoded 32-byte secp256k1 public key (with implicit Y coordinate) prefixed with a LE u16 version prefix, currently [1, 0]
:
[1, 0] | 2 bytes prefix |
---|---|
PUBKEY | 32 bytes authority public key |
URL example:
stratum2+tcp://thepool.com:34254/9bXiEd8boQVhq7WddEcERUL5tyyJVFYdU8th3HfbNXK3Yw6GRXh
raw_ca_public_key = [118, 99, 112, 0, 151, 156, 28, 17, 175, 12, 48, 11, 205, 140, 127, 228, 134, 16, 252, 233, 185, 193, 30, 61, 174, 227, 90, 224, 176, 138, 116, 85]
prefixed_base58check = "9bXiEd8boQVhq7WddEcERUL5tyyJVFYdU8th3HfbNXK3Yw6GRXh"