Curve not enabled by default

[muscleman]

following some examples of implementing curve on a pub/sub i get cannot set public, secret or server public keys

setting socket.curveserver = true throws exceptions too.

• OS: [Ubuntu 22.04]
• ZeroMQ.js version: [6.0.0-beta.20]

[aminya]

Curve is not included in the prebuilt binaries anymore following the upstream approach. You should build the binaries from the source if that is desired.
Also see,
#638 (comment)

[muscleman]

so adding
`
#.npmrc

build_from_source=true
zmq_draft=true
`

and setting
#build.ts -DWITH_LIBSODIUM=ON

is enough to get curve?

[muscleman]

nope, still want work

[muscleman]

would be super helpful if someone could do a little documentation on how to turn on curve

[damiDev8]

@aminya is it planned that curve will be reintegrated into the prebuilt binaries?

[aminya]

Curve needs to be added to the project prebuilds so it works out of the box.

You can expedite the process by sponsoring the project
https://github.com/sponsors/aminya
https://polar.sh/aminya/
https://www.patreon.com/aminya

[aminya]

I have migrated the build to CMake/vcpkg. Now you can enable the Curve support through npmrc by building from the source.
https://github.com/zeromq/zeromq.js#curve-support

[antoncxx]

Hi, @aminya

Tried installing zeromq with the following .npmrc file:

build_from_source=true
zmq_curve="true"
zmq_sodium="true"

But when I run this snippet [on a ubuntu machine]:

import * as zmq from "zeromq";

try {
  zmq.curveKeyPair();
} catch (err) {
  console.log(err);
}

I get Error: Operation not supported.
Did I miss a step ?

[aminya]

It should have worked, if it doesn't that's an issue we need to look into. Did it rebuild Zeromq from the source once you did this?

[antoncxx]

It should have worked, if it doesn't that's an issue we need to look into. Did it rebuild Zeromq from the source once you did this?

I think so. At least the first time I attempted to do npm install zeromq it failed, because I didn't have cmake installed.
Once I installed all the required dependencies, the installation succeeded.

[aminya]

Ok. Thanks for the report. I'll soon try to add it to the CI and reproduce it.

[ctataryn]

@aminya I can confirm that adding:

build_from_source=true
zmq_curve="true"

to .npmrc doesn't seem to add Curve.

Here's my scenario:

We were using "zeromq": "^6.0.0-beta.6" and the following code works at runtime:

  wsiZmqDealerSock = new Dealer({
    routingId: ZMQ_ROUTING_ID,
    sendTimeout: 0,
    reconnectInterval: 2000,
    curveServer: false,
    curveServerKey: spk,
    curvePublicKey: cpk,
    curveSecretKey: csk
  })

However, we removed and re-generated our package-lock.json file and it upgraded zeromq as follows (in package-lock.json):

    "node_modules/zeromq": {
      "version": "6.1.2",
      "resolved": "https://registry.npmjs.org/zeromq/-/zeromq-6.1.2.tgz",
      "integrity": "sha512-5lqsW2UXnKhFhBbIm0wzrRnZmWaGI2b2bm4E03rYMK1c1jBMN0wbPnuyqqhGg7QkzBUmpqf+LyjLhg2TRJmvow==",
      "hasInstallScript": true,
      "license": "MIT AND MPL-2.0",
      "dependencies": {
        "@aminya/cmake-ts": "^0.3.0-aminya.7",
        "node-addon-api": "^8.2.1"
      },
      "engines": {
        "node": ">= 10",
        "pnpm": ">= 9"
      }
    }

After this, the Dealer code above would not work. After investigating, I found the documentation for enabling curve via .npmrc. I then removed the zeromq folder from node_modules then ran npm install again, but the above code still wouldn't run (I get the error: Cannot add property curveServer, object is not extensible).

Tried a few things, for instance I edited node_modules/zeromq/CMakeLists.txt and changed the following:

- option(ZMQ_CURVE "Enable CURVE security" OFF)
+ option(ZMQ_CURVE "Enable CURVE security" ON)

Then I ran:

npm explore zeromq --prefix "$(pwd)" -- npm run install --verbose

However, my code still failed with the same error.

Not sure if the above information helps, I hope it will, but admittedly I'm not that familiar with CMake so I'm not even sure if what I did was right.

[ctataryn]

Update:

By adding the following line to node_modules/zeromq/CMakeLists.txt:

set(VCPKG_MANIFEST_FEATURES, "${VCPKG_MANIFEST_FEATURES}" CACHE STRING "Features to enable for vcpkg manifest mode")

I was able to confirm that the curve feature was now included in ./node_modules/zeromq/staging/linux/x64/node/127/CMakeCache.txt:

//Features to enable for vcpkg manifest mode
VCPKG_MANIFEST_FEATURES,:STRING=curve

This is only after I force ZMQ_CURVE to ON as mentioned in my previous comment though...

However, my Dealer instantiation still errors out with Cannot add property curveServer, object is not extensible

Full install log file attached.
zeromq-curve-install.log

[ctataryn]

@aminya I sponsored and I'm hoping you have some time to take a 👀

[aminya]

@aminya I sponsored and I'm hoping you have some time to take a 👀

Thanks very much! I'll have a look soon.