feat(wallet): add change mnemonic password rpc #2317

borngraced · 2025-01-10T00:26:55Z

implement functionality to change the password for seed storage in kdf with it's rpc method

Example JSON Request

{
       "method": "change_mnemonic_password",
	"userpass": "rpc_password",
	"mmrpc": "2.0",
	"params": {
		"current_password": "old_password123",
		"new_password": "new_password456"
	}
 }

Example JSON Response

{
    "result": null
}

mariocynicys · 2025-01-10T08:04:33Z

mm2src/mm2_main/src/lp_wallet.rs

+    let encrypted_data = encrypt_mnemonic(&mnemonic, &req.new_password)?;
+    // save new encrypted mnemonic data with new password
+    save_encrypted_passphrase(&ctx, &wallet_name, &encrypted_data).await?;
+


could u actually verify whether this would play well in wasm?
this call eventually does table.add_item, which if the item already exists will error ConstraintError (as per this).

We should use table.replace_item to be able to supported updates.

done thank you 9e50c9f

laruh · 2025-01-10T08:26:44Z

Why the result is bool and not Ok if password updated successfully or Err if failed?

mm2src/mm2_main/src/lp_wallet.rs

shamardy · 2025-01-23T14:48:34Z

One thing I need @CharlVS's opinion on regarding this PR: Should we update the password using an RPC or during KDF initialization? I think the GUI will provide users the option to update the password before starting KDF. Also, some CLI users will not want to pass the encryption password through RPC at all. Can we have the two modes if possible @borngraced?

CharlVS · 2025-01-23T15:27:36Z

@shamardy

using an RPC or during KDF initialization?

For the GUI, I'd strongly prefer it to be via RPC. Doing via startup-config for GUI is not ideal because:

The user would have to sign out to change their password or change their password before signing in, which goes against what they'd expect based on the typical flow in other apps.
The user would have to shut down their trading bot and also wait for swaps to complete.

This is outside my domain, but I'd expect it to be a non-issue for CLI users since they face a similar issue with private key RPCs. Those concerned about this would/should be using HTTPS mode. However, the damage from a single coin's leaked private key could be far less than that from a leaked password.

If you implement startup-config password changes, it's worth considering either terminating KDF after the password is updated, or make the fields named password and old_password so that it's idempotent. (Ignore old_password if password is valid)

borngraced · 2025-01-24T04:17:59Z

One thing I need @CharlVS's opinion on regarding this PR: Should we update the password using an RPC or during KDF initialization? I think the GUI will provide users the option to update the password before starting KDF. Also, some CLI users will not want to pass the encryption password through RPC at all. Can we have the two modes if possible @borngraced?

Also, some CLI users will not want to pass the encryption password through RPC at all

seems to be a good reason why we would want to have the both.

make the fields named password and old_password so that it's idempotent. (Ignore old_password if password is valid)

If password is valid -> nothing is needed to be done
Else if old_password valid -> update password to new password
Else -> reject

cc. @CharlVS @shamardy

mariocynicys · 2025-01-24T10:46:52Z

Should we update the password using an RPC or during KDF initialization? I think the GUI will provide users the option to update the password before starting KDF.

Why would the GUI want to provide such a feat considering that RPC comm is internal on the same device (well if you want a GUI to re-launch KDF with different config, this means that GUI runs KDF internally).

Also, some CLI users will not want to pass the encryption password through RPC at all

If KDF is on the same device that shouldn't be an issue for a CLI user. If it's on a different device, they could log into the device/machine hosting KDF and do the RPC there (well if they wanted to go with changing the config route, this means they must have access to that device hosting KDF).
That's assuming that the hosting device isn't compromised. If it's compromised then having the password plainly in the config file is already dangerous.

mariocynicys

Thanks! LGTM
non-blocking comments inline.

mariocynicys · 2025-01-24T10:57:27Z

mm2src/mm2_main/src/rpc/dispatcher/dispatcher.rs

@@ -217,6 +217,7 @@ async fn dispatcher_v2(request: MmRpcRequest, ctx: MmArc) -> DispatcherResult<Re
        "trade_preimage" => handle_mmrpc(ctx, request, trade_preimage_rpc).await,
        "trezor_connection_status" => handle_mmrpc(ctx, request, trezor_connection_status).await,
        "update_nft" => handle_mmrpc(ctx, request, update_nft).await,
+        "update_seed_storage_password" => handle_mmrpc(ctx, request, update_seed_storage_password_rpc).await,


i think we better drop the word storage here.

storage makes it feel as if the whole seed store (multiple seeds) is encrypted using a single pass and not just the single seed in question.
better alternatives imo: update_seed_password or update_seedphrase/passphrase_password

that's a non-blocking comment though since im not a certified linguist.

We should use the word mnemonic not seed since we have get_mnemonic RPC. How about change_mnemonic_password

mariocynicys · 2025-01-24T10:58:47Z

mm2src/mm2_main/src/lp_wallet.rs

+        ))))?;
+    // encrypt mnemonic with new passphrase.
+    let encrypted_data = encrypt_mnemonic(&mnemonic, &req.new_password)?;
+    // save new encrypted mnemonic data::default() with new password


data::default() what?

typo, thanks for the catch

well actually this is blocking 🤦‍♂️

shamardy · 2025-01-24T11:57:34Z

Why would the GUI want to provide such a feat considering that RPC comm is internal on the same device

I thought that updating password flow will be like some websites where you do it without logging in, but @CharlVS cleared that.

If it's compromised then having the password plainly in the config file is already dangerous.

It's shouldn't be in the config file, it should be passed as args with the start KDF command.

shamardy · 2025-01-24T11:58:41Z

One thing I need @CharlVS's opinion on regarding this PR: Should we update the password using an RPC or during KDF initialization? I think the GUI will provide users the option to update the password before starting KDF. Also, some CLI users will not want to pass the encryption password through RPC at all. Can we have the two modes if possible @borngraced?

Also, some CLI users will not want to pass the encryption password through RPC at all

seems to be a good reason why we would want to have the both.

make the fields named password and old_password so that it's idempotent. (Ignore old_password if password is valid)

If password is valid -> nothing is needed to be done

Else if old_password valid -> update password to new password

Else -> reject

cc. @CharlVS @shamardy

No need to, let's have the RPC command only for now like it is now.

shamardy

A few comments from my side!

mm2src/mm2_main/src/lp_wallet.rs

mm2src/mm2_main/src/rpc/dispatcher/dispatcher.rs

laruh

LGTM!

shamardy

LGTM! Only one nit.

Can you please add test coverage for the new RPC?

mm2src/mm2_main/src/lp_wallet.rs

borngraced · 2025-01-26T19:31:12Z

LGTM! Only one nit.

Can you please add test coverage for the new RPC?

done c782372 and c782372

shamardy · 2025-02-11T21:12:15Z

@borngraced please resolve conflicts

MM_DATETIME

shamardy · 2025-02-12T12:25:27Z

please update this comment #2317 (comment) @borngraced

* dev: fix(derive_key_from_path): check length of current_key_material (#2356) chore(release): bump mm2 version to 2.4.0-beta (#2346) fix(tests): add additional testnet sepolia nodes to test code (#2358) fix(swaps): maintain legacy compatibility for negotiation messages (#2353) refactor(SwapOps): impl defaults for protocol specific swapops fns (#2354) feat(tpu-v2): provide swap protocol versioning (#2324) feat(wallet): add change mnemonic password rpc (#2317) fix(tpu-v2): fix tpu-v2 wait for payment spend and extract secret (#2261) feat(tendermint): unstaking/undelegation (#2330) fix(utxo-withdraw): get hw ctx only when `PrivKeyPolicy` is trezor (#2333) feat(event-streaming): API-driven subscription management (#2172) fix(hash-types): remove panic, enforce fixed-size arrays (#2279) fix(ARRR): store unconfirmed change output (#2276) feat(tendermint): staking/delegation (#2322) chore(deps): `timed-map` migration (#2247) fix(mem-leak): `running_swap` never shrinks (#2301) chore(dep-bump): libp2p (#2326) refactor(build script): rewrite the main build script (#2319)

* dev: (24 commits) fix(eth-tpu): remove state from funding validation (KomodoPlatform#2334) improvement(rpc-server): rpc server dynamic port allocation (KomodoPlatform#2342) fix(tests): fix or ignore unstable tests (KomodoPlatform#2365) fix(fs): make `filter_files_by_extension` return only files (KomodoPlatform#2364) fix(derive_key_from_path): check length of current_key_material (KomodoPlatform#2356) chore(release): bump mm2 version to 2.4.0-beta (KomodoPlatform#2346) fix(tests): add additional testnet sepolia nodes to test code (KomodoPlatform#2358) fix(swaps): maintain legacy compatibility for negotiation messages (KomodoPlatform#2353) refactor(SwapOps): impl defaults for protocol specific swapops fns (KomodoPlatform#2354) feat(tpu-v2): provide swap protocol versioning (KomodoPlatform#2324) feat(wallet): add change mnemonic password rpc (KomodoPlatform#2317) fix(tpu-v2): fix tpu-v2 wait for payment spend and extract secret (KomodoPlatform#2261) feat(tendermint): unstaking/undelegation (KomodoPlatform#2330) fix(utxo-withdraw): get hw ctx only when `PrivKeyPolicy` is trezor (KomodoPlatform#2333) feat(event-streaming): API-driven subscription management (KomodoPlatform#2172) fix(hash-types): remove panic, enforce fixed-size arrays (KomodoPlatform#2279) fix(ARRR): store unconfirmed change output (KomodoPlatform#2276) feat(tendermint): staking/delegation (KomodoPlatform#2322) chore(deps): `timed-map` migration (KomodoPlatform#2247) fix(mem-leak): `running_swap` never shrinks (KomodoPlatform#2301) ...

* dev: feat(rpc): add is_success field to legacy MySwapStatusResponse (#2371) fix(key-derivation): use stored Argon2 parameters instead of default values (#2360) fix(tests): stabilize `tendermint_coin::test_claim_staking_rewards` (#2373) improvement(RPCs): group staking rpcs under a namespace (#2372) feat(tendermint): claim delegation rewards (#2351) fix(eth-tpu): remove state from funding validation (#2334) improvement(rpc-server): rpc server dynamic port allocation (#2342) fix(tests): fix or ignore unstable tests (#2365) fix(fs): make `filter_files_by_extension` return only files (#2364) fix(derive_key_from_path): check length of current_key_material (#2356) chore(release): bump mm2 version to 2.4.0-beta (#2346) fix(tests): add additional testnet sepolia nodes to test code (#2358) fix(swaps): maintain legacy compatibility for negotiation messages (#2353) refactor(SwapOps): impl defaults for protocol specific swapops fns (#2354) feat(tpu-v2): provide swap protocol versioning (#2324) feat(wallet): add change mnemonic password rpc (#2317)

borngraced added 3 commits January 9, 2025 15:14

initial commit

dc16267

minor changes to code arrangement in update_seed_storage_password

4a536c6

Merge branch 'dev' into implement-update-seed-storage-rpc

5f7830e

borngraced added the status: in progress label Jan 10, 2025

borngraced self-assigned this Jan 10, 2025

borngraced added 4 commits January 10, 2025 02:22

fix wasm and minor changes

cfd85b8

cargo fmt

6d798a8

remove unused

a34ac6b

remove unnecessary vars

cda913d

borngraced requested review from shamardy and mariocynicys January 10, 2025 01:41

borngraced added status: pending review and removed status: in progress labels Jan 10, 2025

mariocynicys reviewed Jan 10, 2025

View reviewed changes

laruh requested changes Jan 10, 2025

View reviewed changes

mm2src/mm2_main/src/lp_wallet.rs Outdated Show resolved Hide resolved

mm2src/mm2_main/src/lp_wallet.rs Outdated Show resolved Hide resolved

update result type and use replace for indexeddb

9e50c9f

dimxy reviewed Jan 10, 2025

View reviewed changes

mm2src/mm2_main/src/lp_wallet.rs Show resolved Hide resolved

update doc

b02c3f4

borngraced changed the title ~~feat(wallet): add support for updating seed storage password~~ feat(wallet): add update seed storage password rpc Jan 17, 2025

borngraced added 3 commits January 17, 2025 12:02

return SuccessResponse in rpc result

509ced8

remove unused

0f15020

update response type

1e6d3ad

mariocynicys previously approved these changes Jan 24, 2025

View reviewed changes

typo :p

da80143

shamardy reviewed Jan 24, 2025

View reviewed changes

mm2src/mm2_main/src/lp_wallet.rs Outdated Show resolved Hide resolved

mm2src/mm2_main/src/lp_wallet.rs Outdated Show resolved Hide resolved

mm2src/mm2_main/src/rpc/dispatcher/dispatcher.rs Outdated Show resolved Hide resolved

naming and nits

dd492b0

laruh previously approved these changes Jan 24, 2025

View reviewed changes

shamardy previously approved these changes Jan 24, 2025

View reviewed changes

mm2src/mm2_main/src/lp_wallet.rs Outdated Show resolved Hide resolved

borngraced changed the title ~~feat(wallet): add update seed storage password rpc~~ feat(wallet): add change mnemonic password rpc Jan 24, 2025

doc comment

d9647de

borngraced dismissed stale reviews from shamardy and laruh via d9647de January 24, 2025 14:00

dimxy reviewed Jan 24, 2025

View reviewed changes

mm2src/mm2_main/src/lp_wallet.rs Show resolved Hide resolved

borngraced added 2 commits January 26, 2025 14:27

ignore nix confs

ce2ead2

implement unit test for change mnemonic passphrase rpc

c782372

remove comment and rename MnemonicsError to MnemoniRpcError

6b6fa6d

smk762 self-requested a review February 3, 2025 03:19

smk762 mentioned this pull request Feb 3, 2025

New KDF method: update_seed_storage_password KomodoPlatform/komodo-docs-mdx#409

Open

shamardy added the 2.4.0-beta label Feb 11, 2025

Merge branch 'dev' into implement-update-seed-storage-rpc

8f87cdd

shamardy reviewed Feb 12, 2025

View reviewed changes

MM_DATETIME Outdated Show resolved Hide resolved

borngraced force-pushed the implement-update-seed-storage-rpc branch from 965a020 to 8f87cdd Compare February 12, 2025 12:37

remove obsolete file

70a563d

shamardy approved these changes Feb 12, 2025

View reviewed changes

shamardy merged commit 2e6f8bb into dev Feb 12, 2025
19 of 24 checks passed

shamardy deleted the implement-update-seed-storage-rpc branch February 12, 2025 13:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(wallet): add change mnemonic password rpc #2317

feat(wallet): add change mnemonic password rpc #2317

borngraced commented Jan 10, 2025 •

edited

Loading

mariocynicys Jan 10, 2025

borngraced Jan 10, 2025 •

edited

Loading

laruh commented Jan 10, 2025

shamardy commented Jan 23, 2025

CharlVS commented Jan 23, 2025

borngraced commented Jan 24, 2025 •

edited

Loading

mariocynicys commented Jan 24, 2025

mariocynicys left a comment

mariocynicys Jan 24, 2025

shamardy Jan 24, 2025

mariocynicys Jan 24, 2025

mariocynicys Jan 24, 2025

borngraced Jan 24, 2025

mariocynicys Jan 24, 2025

borngraced Jan 24, 2025

shamardy commented Jan 24, 2025

shamardy commented Jan 24, 2025

shamardy left a comment

laruh left a comment

shamardy left a comment

borngraced commented Jan 26, 2025 •

edited

Loading

shamardy commented Feb 11, 2025

shamardy commented Feb 12, 2025

feat(wallet): add change mnemonic password rpc #2317

feat(wallet): add change mnemonic password rpc #2317

Conversation

borngraced commented Jan 10, 2025 • edited Loading

Example JSON Request

Example JSON Response

Choose a reason for hiding this comment

borngraced Jan 10, 2025 • edited Loading

Choose a reason for hiding this comment

laruh commented Jan 10, 2025

shamardy commented Jan 23, 2025

CharlVS commented Jan 23, 2025

borngraced commented Jan 24, 2025 • edited Loading

mariocynicys commented Jan 24, 2025

mariocynicys left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shamardy commented Jan 24, 2025

shamardy commented Jan 24, 2025

shamardy left a comment

Choose a reason for hiding this comment

laruh left a comment

Choose a reason for hiding this comment

shamardy left a comment

Choose a reason for hiding this comment

borngraced commented Jan 26, 2025 • edited Loading

shamardy commented Feb 11, 2025

shamardy commented Feb 12, 2025

borngraced commented Jan 10, 2025 •

edited

Loading

borngraced Jan 10, 2025 •

edited

Loading

borngraced commented Jan 24, 2025 •

edited

Loading

borngraced commented Jan 26, 2025 •

edited

Loading