fix: wrap base64-encoded PEM with 64-char line boundary by littledivy · Pull Request #1292 · PrismarineJS/node-minecraft-protocol

littledivy · 2024-03-14T11:24:23Z

According to RFC7468:

Generators MUST wrap the base64-encoded lines so that each line
consists of exactly 64 characters except for the final line, which
will encode the remainder of the data (within the 64-character line
boundary), and they MUST NOT emit extraneous whitespace.

Parsers can avoid branching and prevent timing sidechannel attacks. Ref https://arxiv.org/pdf/2108.04600.pdf

Fixes compatibility with Deno as it enforces stricter handling of PEM.

rom1504 · 2024-03-17T14:41:09Z

how did you check this improve something?

rom1504 · 2024-06-02T16:45:03Z

Hi @littledivy if nobody can verify that fix solve some issues, I think we should close this PR

ozaner · 2024-07-24T22:50:47Z

Hey @rom1504 this solves Deno compatibility. Without this fix, the node-minecraft-protocol library would only work with the NodeJS runtime and not others that have properly implemented RFC7468 (i.e. Deno). I've verified that this is a blocker towards that goal.

rom1504 · 2024-07-25T02:32:11Z

What example were you able to run with deno?

extremeheat · 2024-07-25T09:34:54Z

It may be the standard length, but for Minecraft we'd likely want to match the encoding behavior to be like vanilla Minecraft otherwise it's one of the areas that can be easily flagged by server software (like anticheat, antibot, etc).

I'm looking into the vanilla behavior here.

extremeheat

Ok per https://github.com/extremeheat/extracted_minecraft_data/blob/client1.20.5/client/net/minecraft/util/Crypt.java#L41 it seems minecraft is using 76-char width.

extremeheat · 2024-07-25T09:45:48Z

src/server/login.js

  let pem = '-----BEGIN RSA PUBLIC KEY-----\n'
  let base64PubKey = mcPubKeyBuffer.toString('base64')
-  const maxLineLength = 76
+  const maxLineLength = 64


For server/ we can keep it at 76 (but it probably won't matter whatever the width is as vanilla client doesn't care). It's not going to break Deno or anything as this call result isn't passed to anything except being sent to clients.

extremeheat · 2024-07-25T09:45:57Z

src/client/encrypt.js

  let pem = '-----BEGIN PUBLIC KEY-----\n'
  let base64PubKey = mcPubKeyBuffer.toString('base64')
-  const maxLineLength = 65
+  const maxLineLength = 64


For the client/ width seems to not matter at all as it's not sent to server or anything but just as an intermediate variable that we pass to encrypt method -

node-minecraft-protocol/src/client/encrypt.js

Line 48 in 5675af4

const pubKey = mcPubKeyToPem(packet.publicKey)

ozaner · 2024-07-25T11:52:54Z

I see. Honestly, even though I didn't make this PR, I think it should be closed.

The main purpose of this PR was to enable Deno support, but since changing these widths seems to go against the actual Minecraft protocol, and since more work beyond changing these widths would probably need to be done to make it compatible with Deno, it doesn't seem worth it.

A full on proper port of this package is probably necessary for anyone wanting to use it with Deno (or better Deno-Node compatibility) which is definitely not in the scope of this project.

Thanks @extremeheat for helping to investigate this though.

extremeheat · 2024-07-26T00:33:25Z

No, what I said was that only the client PEM encoder method needs to be changed, and that changing it here would have no effect on anything (beyond maybe fixing Deno). The width doesn't matter to nmp as long as it can be read by the crypto call.

On the server code there is nothing to change

ozaner · 2024-10-11T05:54:26Z

As of the release of Deno 2.0, Deno now has full backwards compatibility with npm packages. I've verified that this package (and thus the packages that depend on it like mineflayer) does indeed work with Deno 2.0.

So I think we should finally close this PR now.

interrrp · 2024-10-31T11:04:53Z

As of the release of Deno 2.0, Deno now has full backwards compatibility with npm packages. I've verified that this package (and thus the packages that depend on it like mineflayer) does indeed work with Deno 2.0.

So I think we should finally close this PR now.

As of Deno 2.0.4, the issue arises yet again:

$ deno --version
deno 2.0.4 (stable, release, x86_64-pc-windows-msvc)
v8 12.9.202.13-rusty
typescript 5.6.2

$ deno task dev 
Task dev deno run -A --watch src/main.ts
Watcher Process started.
error: Uncaught Error: ASN.1 error: PEM error: PEM Base64 error: invalid Base64 encoding

Update: I downgraded to previous Mineflayer and Minecraft versions (down to 1.12.2!), and they all showed the same error. I believe this PR should be reopened.

ozaner · 2024-11-01T05:10:03Z

@interrrp can you send your Deno code? I just tried it with Deno 2.0.4 on Minecraft 1.20.4 and it was able to join my local server just fine. Here is my code:

import { createBot } from 'npm:mineflayer'

const bot = createBot({
  host: "localhost",
  port: 25565,
  username: 'TestBot',
});

bot.on('chat', (username, message) => {
  if (username === bot.username) return
  bot.chat(message)
})

interrrp · 2024-11-01T10:55:23Z

@interrrp can you send your Deno code? I just tried it with Deno 2.0.4 on Minecraft 1.20.4 and it was able to join my local server just fine. Here is my code:
import { createBot } from 'npm:mineflayer'

const bot = createBot({
  host: "localhost",
  port: 25565,
  username: 'TestBot',
});

bot.on('chat', (username, message) => {
  if (username === bot.username) return
  bot.chat(message)
})

It's a bit complicated, mine was loading from an external file. However, I tried your code, and it still did not work under the same Deno and Minecraft versions.

ozaner · 2024-11-01T14:56:13Z

Yeah honestly not sure what the problem is. I tried running it as a .ts file, using watcher mode instead of running directly, and it still works for me.

All I can think of is that you aren't on Deno 2.0 but you apparently are. Well, in any case, I think your PR is a good change and would probably fix this.

Asguho · 2024-11-28T14:17:48Z

i also get the same error, when trying the code in mc 1.20.4 and deno 2.1.1:

Uncaught Error: ASN.1 error: PEM error: PEM Base64 error: invalid Base64 encoding
    at Object.publicEncrypt (ext:deno_node/internal/crypto/cipher.ts:221:10)
    at sendEncryptionKeyResponse (file:///C:/Users/aske/Documents/GitHub/deno-mineflayer/node/node_modules/.deno/minecraft-protocol@1.50.0/node_modules/minecraft-protocol/src/client/encrypt.js:49:52)
    at gotSharedSecret (file:///C:/Users/aske/Documents/GitHub/deno-mineflayer/node/node_modules/.deno/minecraft-protocol@1.50.0/node_modules/minecraft-protocol/src/client/encrypt.js:28:9)
    at ext:deno_node/internal/crypto/_randomBytes.ts:42:9
    at callback (ext:deno_web/02_timers.js:58:7)
    at eventLoopTick (ext:core/01_core.js:210:13)

Asguho · 2024-11-28T14:21:16Z

Since the premise for closing this PR was that Deno had implemented full backward compatibility, and this is not the case, would it be possible to reopen it?

Nexus-00 · 2025-03-20T04:05:57Z

i also get the same error, when trying the code in mc 1.20.4 and deno 2.1.1:

Uncaught Error: ASN.1 error: PEM error: PEM Base64 error: invalid Base64 encoding
    at Object.publicEncrypt (ext:deno_node/internal/crypto/cipher.ts:221:10)
    at sendEncryptionKeyResponse (file:///C:/Users/aske/Documents/GitHub/deno-mineflayer/node/node_modules/.deno/minecraft-protocol@1.50.0/node_modules/minecraft-protocol/src/client/encrypt.js:49:52)
    at gotSharedSecret (file:///C:/Users/aske/Documents/GitHub/deno-mineflayer/node/node_modules/.deno/minecraft-protocol@1.50.0/node_modules/minecraft-protocol/src/client/encrypt.js:28:9)
    at ext:deno_node/internal/crypto/_randomBytes.ts:42:9
    at callback (ext:deno_web/02_timers.js:58:7)
    at eventLoopTick (ext:core/01_core.js:210:13)

I can confirm that as of Deno version 2.2.4, the error remains.

According to [RFC7468](https://datatracker.ietf.org/doc/html/rfc7468) > Generators MUST wrap the base64-encoded lines so that each line consists of exactly 64 characters except for the final line, which will encode the remainder of the data (within the 64-character line boundary), and they MUST NOT emit extraneous whitespace. Parsers can avoid branching and prevent timing sidechannel attacks. Ref https://arxiv.org/pdf/2108.04600.pdf Fixes compatibility with Deno as it enforces stricter handling of PEM.

littledivy · 2025-04-10T05:23:58Z

@extremeheat Sorry for the delay, I have reverted the server change.

LunarLollipop · 2025-04-20T01:41:37Z

error: Uncaught Error: ASN.1 error: PEM error: PEM Base64 error: invalid Base64 encoding at Object.publicEncrypt (ext:deno_node/internal/crypto/cipher.ts:220:22) at sendEncryptionKeyResponse (file:///Users/luna/deno/node_modules/minecraft-protocol/src/client/encrypt.js:49:52)

Issue still exists in deno 2.2.11. and minecraft_protocol 1.57.0

I tried manually change from 65 -> 64 in node_modules (locally) and this fixed issue with creating bot.

Is there a specific reason 65 is used? If no, I hope this will be merged soon.

CubeBeveled · 2025-06-07T15:33:56Z

burh please merge this

i couldnt get nodejs to work so am using deno

extremeheat · 2025-06-08T18:17:38Z

I tried manually change from 65 -> 64 in node_modules (locally) and this fixed issue with creating bot.

Can anyone verify this ? cc @CubeBeveled

interrrp · 2025-07-27T09:00:00Z

Issue is still present as of Mineflayer 4.30.0 and Deno 2.4.2
Applying the change on ~/.cache/deno/npm/registry.npmjs.org/minecraft-protocol/1.58.0/src/client/encrypt.js manually will fix it

rom1504 · 2025-07-27T09:03:55Z

This seems to help in some cases while not breaking anything. Merged.

rom1504 · 2025-07-27T09:04:04Z

/makerelease

littledivy mentioned this pull request Mar 14, 2024

Uncaught Error: ASN.1 error: PEM error: PEM Base64 error: invalid Base64 encoding denoland/deno#20397

Closed

extremeheat reviewed Jul 25, 2024

View reviewed changes

extremeheat closed this Oct 12, 2024

interrrp mentioned this pull request Oct 31, 2024

PEM Base64 Error while using mineflayer NPM Package denoland/deno#26634

Closed

extremeheat reopened this Mar 20, 2025

littledivy force-pushed the rfc7468_pem branch from 5675af4 to 65f6587 Compare April 10, 2025 05:23

extremeheat approved these changes Apr 10, 2025

View reviewed changes

rom1504 merged commit 0f6da56 into PrismarineJS:master Jul 27, 2025
28 checks passed

rom1504bot mentioned this pull request Jul 27, 2025

Release 1.59.0 #1414

Merged

Uh oh!

Conversation

littledivy commented Mar 14, 2024

Uh oh!

rom1504 commented Mar 17, 2024

Uh oh!

rom1504 commented Jun 2, 2024

Uh oh!

ozaner commented Jul 24, 2024

Uh oh!

rom1504 commented Jul 25, 2024

Uh oh!

extremeheat commented Jul 25, 2024

Uh oh!

extremeheat left a comment

Choose a reason for hiding this comment

Uh oh!

extremeheat Jul 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

extremeheat Jul 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ozaner commented Jul 25, 2024

Uh oh!

extremeheat commented Jul 26, 2024

Uh oh!

ozaner commented Oct 11, 2024

Uh oh!

interrrp commented Oct 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ozaner commented Nov 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

interrrp commented Nov 1, 2024

Uh oh!

ozaner commented Nov 1, 2024

Uh oh!

Asguho commented Nov 28, 2024

Uh oh!

Asguho commented Nov 28, 2024

Uh oh!

Nexus-00 commented Mar 20, 2025

Uh oh!

littledivy commented Apr 10, 2025

Uh oh!

LunarLollipop commented Apr 20, 2025

Uh oh!

CubeBeveled commented Jun 7, 2025

Uh oh!

extremeheat commented Jun 8, 2025

Uh oh!

interrrp commented Jul 27, 2025

Uh oh!

Uh oh!

rom1504 commented Jul 27, 2025

Uh oh!

rom1504 commented Jul 27, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

extremeheat Jul 25, 2024 •

edited

Loading

extremeheat Jul 25, 2024 •

edited

Loading

interrrp commented Oct 31, 2024 •

edited

Loading

ozaner commented Nov 1, 2024 •

edited

Loading