Create limited RPC user. #363
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I haven't reviewed the code yet, but I did notice there are several documentation updates that will be needed that I don't see here:
|
| "getrawmempool": struct{}{}, | ||
| "getrawtransaction": struct{}{}, | ||
| "gettxout": struct{}{}, | ||
| "ping": struct{}{}, |
|
@aakselrod: Thanks for the PR. It looks good overall. I think we'll want to debate the specific command list. I think |
aakselrod
force-pushed
the
readonly-rpc
branch
2 times, most recently
from
48eb5ec
to
f3f129e
Compare
| } | ||
| if cfg.RPCLimitUser != "" && cfg.RPCLimitPass != "" { | ||
| login := cfg.RPCLimitUser + ":" + cfg.RPCLimitPass | ||
| roauth := "Basic " + base64.StdEncoding.EncodeToString([]byte(login)) |
There was a problem hiding this comment.
Not a big deal, but roauth should probably just be auth here as well since it's not read-only anymore.
There was a problem hiding this comment.
Changed to auth from roauth.
|
Alright, everything looks good! If you can squash/rebase it, I'll merge it. |
aakselrod
force-pushed
the
readonly-rpc
branch
2 times, most recently
from
9607cbe
to
1f2fdf9
Compare
The limited user is specified with the --rpclimituser and --rpclimitpass options (or the equivalent in the config file). The config struct and loadConfig() are updated to take the new options into account. The limited user can have neither the same username nor the same password as the admin user. The package-level rpcLimit map in rpcserver.go specifies the RPC commands accessible by limited users. This map includes both HTTP/S and websocket commands. The checkAuth function gets a new return parameter to signify whether the user is authorized to change server state. The result is passed to the jsonRPCRead function and to the WebsocketHandler function in rpcwebsocket.go. The wsClient struct is updated with an "isAdmin" field signifying that the client is authorized to change server state, written by WebsocketHandler and handleMessage. The handleMessage function also checks the field to allow or disallow an RPC call. The following documentation files are updated: - doc.go - sample-btcd.conf - docs/README.md - docs/json_rpc_api.md - docs/configure_rpc_server_listen_interfaces.md
|
I've tested the following:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The limited user is specified with the --rpclimituser and
--rpclimitpass options (or the equivalent in the config file).
The config struct and loadConfig() are updated to take the
new options into account. The limited user can have neither
the same username nor the same password as the admin user.
The package-level rpcLimit map in rpcserver.go specifies
the RPC commands accessible by limited users. This map
includes both HTTP/S and websocket commands.
The checkAuth function gets a new return parameter to
signify whether the user is authorized to change server
state. The result is passed to the jsonRPCRead function and
to the WebsocketHandler function in rpcwebsocket.go.
The wsClient struct is updated with an "isAdmin" field
signifying that the client is authorized to change server
state, written by WebsocketHandler and handleMessage.
The handleMessage function also checks the field to
allow or disallow an RPC call.
The following documentation files are updated: