Allow rpc_user and rpc_pass in config file #1527

raphjaph · 2023-02-06T18:06:57Z

#1399

Probably closes:
#1785
#1562

raphjaph · 2023-02-06T22:36:27Z

Let's not support this as flags but as a option in the config file. https://docs.rs/config/latest/config/

bliotti · 2023-02-07T01:37:53Z

PR title says "instead of" we are just adding to.

bliotti · 2023-02-07T02:47:14Z

Tested 37d36ea 👍🏼

rpcuser and rpcpassword will soon be deprecated. ref: JSON-RPC Interface:Security

raphjaph · 2023-02-07T19:43:31Z

Yea, using rpc_user and rpc_pass should not be encouraged

andrewtoth · 2023-02-10T03:41:09Z

rpcuser and rpcpassword will soon be deprecated.

They will not be deprecated from use in clients. The deprecation refers to using bare rpcuser/rpcpassword in favor of generating an rpcauth with the user and password in Bitcoin Core's bitcoin.conf. When configuring bitcoind you should not use rpcuser/rpcpassword but rpcauth, which does not expose the password in plaintext in the config file. For clients rpcuser/rpcpassword will not be deprecated.

…pass

raphjaph · 2023-02-13T14:26:35Z

They will not be deprecated from use in clients. The deprecation refers to using bare rpcuser/rpcpassword in favor of generating an rpcauth with the user and password in Bitcoin Core's bitcoin.conf. When configuring bitcoind you should not use rpcuser/rpcpassword but rpcauth, which does not expose the password in plaintext in the config file. For clients rpcuser/rpcpassword will not be deprecated.

Yes, true. Passing credentials as command line flags is still not ideal because those will be stored in plaintext in your bash history. I've add it as flags anyway because that fear is probably overblown.

raphjaph · 2023-02-13T14:37:07Z

rpc_user and rpc_pass can now be passed in to ord in a plethora of ways. In order of precedence:

in the ord.yaml config file
as environmental variables
as command line options
through the cookie file

Generally I think we have to overhaul or configuration setup. I think there should be global Config or Options struct maybe initialized with lazy_static! à la this method. We were creating rpc clients in different places in index.rs that didn't go through our Options methods. These were verifying that the client is and Bitcoin Core are the correct version, etc. This PR also contains some .clone()s in places that might be inefficient.

Sjors · 2023-02-18T13:38:01Z

In addition to these methods, you could also read rpcuser and rpcpassword from bitcoin.conf, like bitcoin-cli does. For example a user might want to run their bitcoind under a different user than ord, in which case it won't have access to the cookie file, but you can create a bitcoin.conf file with the RPC credentials. (this isn't super useful in practice because Bitcoin Core doesn't have a way yet to limit RPC permissions)

raphjaph · 2023-02-22T18:37:48Z

In addition to these methods, you could also read rpcuser and rpcpassword from bitcoin.conf, like bitcoin-cli does. For example a user might want to run their bitcoind under a different user than ord, in which case it won't have access to the cookie file, but you can create a bitcoin.conf file with the RPC credentials. (this isn't super useful in practice because Bitcoin Core doesn't have a way yet to limit RPC permissions)

I think rpcuser/rpcpass from bitcoin.conf is being deprecated in favor of rpcauth. This will only store the username, password hash and salt.

Sjors · 2023-02-23T11:10:43Z

Assuming a system with two users: bitcoin and ord. It makes sense for the bitcoin user to use rpcauth so only the hash is stored, which all bitcoind needs. But the ord user would use rpcpass, which is what bitcoin-cli or another client needs. It's a bit confusing that both bitcoind and bitcoin-cli use the same config file. I don't think this will stop working anytime soon.

…pass

src/options.rs

…pass

casey

SO CLOSE

src/options.rs

tests/index.rs

casey · 2023-04-24T21:32:14Z

tests/index.rs

@@ -35,3 +35,32 @@ fn re_opening_database_does_not_trigger_schema_check() {
    .rpc_server(&rpc_server)
    .run();
 }
+
+#[test]
+fn index_runs_with_rpc_user_and_pass_as_env_vars() {


Let's modify this test to make sure we're using the correct values. Let's record the user and pass which are passed each time a client connects, and then do something like assert_eq!(rpc_server.client_credentials, &[("foo", "bar")]).

The way the our mock bitcoin core instance is written I do not have access to the Basic Authentication http header. So I can't know what credentials are passed in.

casey · 2023-04-24T21:34:31Z

tests/server.rs

@@ -298,3 +298,50 @@ fn expected_sat_time_is_rounded() {
    r".*<dt>timestamp</dt><dd><time>.* \d+:\d+:\d+ UTC</time> \(expected\)</dd>.*",
  );
 }
+
+#[test]
+fn server_runs_with_rpc_user_and_pass_as_env_vars() {


Let's do the same style of test in index_runs_with_rpc_user_and_pass_as_env_vars

…pass

Add the ability to authenticate bitcoind RPC calls using a username and password, as an alternative to cookie file authentication.

allow rpc_user and rpc_pass instead of cookie file

37d36ea

raphjaph requested a review from casey February 6, 2023 18:07

raphjaph marked this pull request as draft February 6, 2023 22:36

raphjaph changed the title ~~Allow rpc_user and rpc_pass instead of cookie file~~ Allow rpc_user and rpc_pass in config file Feb 7, 2023

raphjaph added 7 commits February 10, 2023 14:58

merging

5f0376f

stashing

439324b

Merge branch 'master' of https://github.com/casey/ord into allow-rpc-…

2ff901d

…pass

see diff

e0a918e

quick fix

453b957

takes env vars as well

0d00d5e

placate clippy

3578d55

raphjaph added 2 commits February 13, 2023 15:26

read rpc_user and rpc_pass from config file as well

6676846

fmt

95c3b06

raphjaph marked this pull request as ready for review February 13, 2023 14:37

Merge branch 'master' into allow-rpc-pass

b17e52d

Merge branch 'master' into allow-rpc-pass

f02aacb

raphjaph added 2 commits February 27, 2023 10:23

stash

c3e326a

Merge branch 'master' of https://github.com/casey/ord into allow-rpc-…

d37c440

…pass

AngusP mentioned this pull request Mar 3, 2023

Add remote rpc support #1785

Closed

casey reviewed Mar 3, 2023

View reviewed changes

src/options.rs Outdated Show resolved Hide resolved

raphjaph added 3 commits April 11, 2023 07:55

Merge branch 'master' into allow-rpc-pass

34515dc

fix nits

c388e0c

Merge branch 'master' of https://github.com/casey/ord into allow-rpc-…

2af9415

…pass

soenkehahn mentioned this pull request Apr 18, 2023

Tweak --config and --config-dir help text #2028

Closed

raphjaph and others added 13 commits April 24, 2023 21:57

Merge branch 'master' of https://github.com/casey/ord into allow-rpc-…

e0299cd

…pass

fix justfile

9949879

derive_var arg fix

cb7b496

better error msgs

f141c1d

Improve error messages and add logging

3b1dc37

Use default::default

8e60b79

tweak

6ef45ee

Use more explicit variable names

aee8d94

Make command line arguments more explicit

db1a5b4

Use default default

a354ff7

Delete test

796f171

Use default::default

884c976

improve test derive var

c6e2d39

casey requested changes Apr 24, 2023

View reviewed changes

raphjaph added 6 commits April 26, 2023 20:55

Merge branch 'master' of https://github.com/casey/ord into allow-rpc-…

0891cf1

…pass

improved some tests

56109dd

remove asssert

762b3ed

get rid of credentials tests

ddb62b7

done

c8d069e

quick fix

3d6328e

casey approved these changes May 1, 2023

View reviewed changes

casey merged commit 3204d83 into ordinals:master May 1, 2023

This was referenced May 1, 2023

feat: add ability to connect to bitcoind using inline credentials #1562

Closed

Support rpc_user and rpc_pass #1399

Closed

raphjaph deleted the allow-rpc-pass branch May 1, 2023 18:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow rpc_user and rpc_pass in config file #1527

Allow rpc_user and rpc_pass in config file #1527

raphjaph commented Feb 6, 2023 •

edited

Loading

raphjaph commented Feb 6, 2023 •

edited

Loading

bliotti commented Feb 7, 2023 •

edited

Loading

bliotti commented Feb 7, 2023 •

edited

Loading

raphjaph commented Feb 7, 2023

andrewtoth commented Feb 10, 2023 •

edited

Loading

raphjaph commented Feb 13, 2023

raphjaph commented Feb 13, 2023 •

edited

Loading

Sjors commented Feb 18, 2023

raphjaph commented Feb 22, 2023

Sjors commented Feb 23, 2023 •

edited

Loading

casey left a comment

casey Apr 24, 2023

raphjaph Apr 26, 2023

casey Apr 24, 2023

raphjaph Apr 26, 2023

Allow rpc_user and rpc_pass in config file #1527

Allow rpc_user and rpc_pass in config file #1527

Conversation

raphjaph commented Feb 6, 2023 • edited Loading

raphjaph commented Feb 6, 2023 • edited Loading

bliotti commented Feb 7, 2023 • edited Loading

bliotti commented Feb 7, 2023 • edited Loading

raphjaph commented Feb 7, 2023

andrewtoth commented Feb 10, 2023 • edited Loading

raphjaph commented Feb 13, 2023

raphjaph commented Feb 13, 2023 • edited Loading

Sjors commented Feb 18, 2023

raphjaph commented Feb 22, 2023

Sjors commented Feb 23, 2023 • edited Loading

casey left a comment

Choose a reason for hiding this comment

casey Apr 24, 2023

Choose a reason for hiding this comment

raphjaph Apr 26, 2023

Choose a reason for hiding this comment

casey Apr 24, 2023

Choose a reason for hiding this comment

raphjaph Apr 26, 2023

Choose a reason for hiding this comment

raphjaph commented Feb 6, 2023 •

edited

Loading

raphjaph commented Feb 6, 2023 •

edited

Loading

bliotti commented Feb 7, 2023 •

edited

Loading

bliotti commented Feb 7, 2023 •

edited

Loading

andrewtoth commented Feb 10, 2023 •

edited

Loading

raphjaph commented Feb 13, 2023 •

edited

Loading

Sjors commented Feb 23, 2023 •

edited

Loading