Add readonly api to gateway #1389

travisperson · 2015-06-18T01:44:00Z

Issue #1322

Added the ability to expose individual commands to a read-only style
handler that can be used on any http interface.

Added the read-only handler to the gateway.

Tests to come

GitCop · 2015-06-18T01:44:01Z

There were the following issues with your Pull Request

Commit: fa319e7
- Invalid signoff. Commit message must end with License: MIT
  Signed-off-by: .* <.*>

Guidelines are available to help. Your feedback on GitCop is welcome on this issue

This message was auto-generated by https://gitcop.com

Issue ipfs#1322 Added the ability to expose individual commands to a read-only style handler that can be used on any http interface. Added the read-only handler to the gateway. License: MIT Signed-off-by: Travis Person <[email protected]>

License: MIT Signed-off-by: Travis Person <[email protected]>

travisperson · 2015-06-18T01:57:22Z

~~Reworking to instead add a read-only flag (maybe called gatewayAccessible) to the commands instead of a white list in handlers.go~~

travisperson · 2015-06-18T02:16:33Z

I actually want some input on the idea above.

One rework of this is to add a GatewayAccess flag to each command, this will make it a bit easier to understand which commands can be used on the gateway.

I also think having a way to define which commands can be used on a given http interface would be nice, because it will allow us to later define restricted interfaces.

So right now I'm almost thinking of a mesh of these two.

This would leave to a way to pass in a whitelist to the NewReadOnlyHandler, which would be renamed to NewWhiteListedHandler.

Issue with this is I'm not sure how to get all the commands with the GatewayAccess flag set into the whitelist.

So for now, I'd like to get some ideas about the direction this should go.

jbenet · 2015-06-18T09:04:56Z

commands/http/handler.go

@@ -71,6 +77,30 @@ func NewHandler(ctx cmds.Context, root *cmds.Command, allowedOrigin string) *Han
 	return &Handler{internal, c.Handler(internal)}
 }

+func NewReadOnlyHandler(ctx cmds.Context, root *cmds.Command, allowedOrigin string) *Handler {


problem with making two handlers is drift in the implementations.

maybe instead of creating two different handlers, make the original handler always check a list of available commands, and then we can just instantiate the read-only and read-write handlers by passing two different command lists.

that way the

if i.readOnly == true { if _, ok := readOnlyCmds[req.Command()]; !ok { ... } }

can turn into

if _, ok := availableCmds[req.Command()]; !ok { ... }

This PR adds the ability to expose commands to the gateway. Each commands handler uses a whitelist to expose the commands on the http interface. All commands listed under the root command are exposed by default to the commands port. Only commands with the `GatewayAccess` flag will be exposed on the gateway. License: MIT Signed-off-by: Travis Person <[email protected]>

Update the test to include the command lists Added test to to make sure an emptyu command list rejects requests License: MIT Signed-off-by: Travis Person <[email protected]>

travisperson · 2015-06-26T03:49:14Z

@harlantwood @jbenet

Sorry for this taking so long.

If I can get a quick CR on this as well as a list of command/subcommands that need gateway access I think we could merge this sometime this weekend (maybe tomorrow).

travisperson · 2015-06-26T03:53:28Z

(I think I may of accidentally overwrote one of my commits, I seem to be missing some code that lets it compile by adding the command lists to NewHandler)

License: MIT Signed-off-by: Travis Person <[email protected]>

jbenet · 2015-06-26T09:11:10Z

core/corehttp/gateway.go

@@ -25,7 +29,13 @@ func NewGateway(conf GatewayConfig) *Gateway {
 	}
 }

-func (g *Gateway) ServeOption() ServeOption {
+func (g *Gateway) ServeOption(cctx * commands.Context) ServeOption {


i dont think this is properly go fmt-ed ?

jbenet · 2015-06-26T09:17:46Z

comments above, but this LGTM. i dont like the cmds.Context seeping into everything... but dont know an easier workaround atm.

for now, list of (readonly!!) cmds to have:

ipfs refs
ipfs object get
ipfs object stat
ipfs object data
ipfs object links
ipfs block get
ipfs block stat
ipfs name resolve
ipfs cat
ipfs ls

travisperson · 2015-06-26T14:27:11Z

Ya agree on the context being moved around so much. I'll put that as a note and this weekend I may investigate the context a bit. I noticed there was a comment to replace the structure or get rid of it, and this PR definitely doesn't help with that idea.

I'll get those read-only commands added this afternoon.

harlantwood · 2015-06-26T20:15:22Z

Awesome, thanks @travisperson.

License: MIT Signed-off-by: Travis Person <[email protected]>

wking · 2015-07-03T00:22:05Z

On Fri, Jun 26, 2015 at 02:17:47AM -0700, Juan Batiz-Benet wrote:

ipfs ls

Maybe ‘ipfs file ls’ too?

harlantwood · 2015-07-06T19:23:35Z

I'll test this out for the dataviz case when it's ready.

jbenet · 2015-07-07T01:01:39Z

Hey @travisperson were you able to take a look at not makign the cmds context expand in scope?

travisperson · 2015-07-09T05:26:09Z

I took a quick look, but didn't really do too much digging yet.

jbenet · 2015-08-02T13:00:10Z

ok, can someone with some gateway experience take care of this? it's been outstanding for months now... :(

jbenet · 2015-08-07T08:19:38Z

cc @diasdavid

rht · 2015-08-15T03:13:02Z

commands/http/handler_test.go

+
+	commandList := map[*commands.Command]bool{}
+
+	handler := NewHandler(commands.Context{}, corecommands.Root, "*", commandList)


@travisperson another option is to define corecommands.RootRO inside corecommands and use it here. This way, no need for extra commandList arguments elsewhere.

jbenet · 2015-08-15T03:27:08Z

@rht could you take this one over?

Based on ipfs#1389 License: MIT Signed-off-by: rht <[email protected]>

whyrusleeping · 2015-08-15T18:11:39Z

I beleive this can be closed now. @rht ?

rht · 2015-08-16T00:32:23Z

@whyrusleeping I think so.

Based on ipfs/kubo#1389 License: MIT Signed-off-by: rht <[email protected]> This commit was moved from ipfs/kubo@dd99a70

jbenet added the backlog label Jun 18, 2015

Add readonly api to gateway

988c310

Issue ipfs#1322 Added the ability to expose individual commands to a read-only style handler that can be used on any http interface. Added the read-only handler to the gateway. License: MIT Signed-off-by: Travis Person <[email protected]>

travisperson force-pushed the feat/read-only-api-gateway branch from fa319e7 to 988c310 Compare June 18, 2015 01:48

Stripped out excess fmt statement

a786cf9

License: MIT Signed-off-by: Travis Person <[email protected]>

jbenet reviewed Jun 18, 2015
View reviewed changes

travisperson added 2 commits June 20, 2015 21:16

Updated tests to include the command list

b240796

Update the test to include the command lists Added test to to make sure an emptyu command list rejects requests License: MIT Signed-off-by: Travis Person <[email protected]>

Updated other tests and binary's

7a3337f

License: MIT Signed-off-by: Travis Person <[email protected]>

jbenet reviewed Jun 26, 2015
View reviewed changes

Added GatewayAccess to supplied commands

592707d

License: MIT Signed-off-by: Travis Person <[email protected]>

rht reviewed Aug 15, 2015
View reviewed changes

rht added a commit to rht/go-ipfs that referenced this pull request Aug 15, 2015

Add readonly api to gateway

5823cde

Based on ipfs#1389 License: MIT Signed-off-by: rht <[email protected]>

rht mentioned this pull request Aug 15, 2015

Add readonly api to gateway #1581

Merged

rht added a commit to rht/go-ipfs that referenced this pull request Aug 15, 2015

Add readonly api to gateway

3357d2f

Based on ipfs#1389 License: MIT Signed-off-by: rht <[email protected]>

rht added a commit to rht/go-ipfs that referenced this pull request Aug 15, 2015

Add readonly api to gateway

dd99a70

Based on ipfs#1389 License: MIT Signed-off-by: rht <[email protected]>

jbenet closed this Aug 16, 2015

jbenet removed the backlog label Aug 16, 2015

MichaelMure mentioned this pull request Mar 25, 2020

Read-only API calls are accepted on the gateway port #7031

Closed

hacdias pushed a commit to ipfs/boxo that referenced this pull request Jan 27, 2023

Add readonly api to gateway

671ce95

Based on ipfs/kubo#1389 License: MIT Signed-off-by: rht <[email protected]> This commit was moved from ipfs/kubo@dd99a70

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add readonly api to gateway #1389

Add readonly api to gateway #1389

travisperson commented Jun 18, 2015

GitCop commented Jun 18, 2015

travisperson commented Jun 18, 2015

travisperson commented Jun 18, 2015

jbenet Jun 18, 2015

travisperson commented Jun 26, 2015

travisperson commented Jun 26, 2015

jbenet Jun 26, 2015

jbenet commented Jun 26, 2015

travisperson commented Jun 26, 2015

harlantwood commented Jun 26, 2015

wking commented Jul 3, 2015

harlantwood commented Jul 6, 2015

jbenet commented Jul 7, 2015

travisperson commented Jul 9, 2015

jbenet commented Aug 2, 2015

jbenet commented Aug 7, 2015

rht Aug 15, 2015

jbenet commented Aug 15, 2015

whyrusleeping commented Aug 15, 2015

rht commented Aug 16, 2015


		commandList := map[*commands.Command]bool{}

		handler := NewHandler(commands.Context{}, corecommands.Root, "*", commandList)

Add readonly api to gateway #1389

Add readonly api to gateway #1389

Conversation

travisperson commented Jun 18, 2015

GitCop commented Jun 18, 2015

travisperson commented Jun 18, 2015

travisperson commented Jun 18, 2015

jbenet Jun 18, 2015

Choose a reason for hiding this comment

travisperson commented Jun 26, 2015

travisperson commented Jun 26, 2015

jbenet Jun 26, 2015

Choose a reason for hiding this comment

jbenet commented Jun 26, 2015

travisperson commented Jun 26, 2015

harlantwood commented Jun 26, 2015

wking commented Jul 3, 2015

harlantwood commented Jul 6, 2015

jbenet commented Jul 7, 2015

travisperson commented Jul 9, 2015

jbenet commented Aug 2, 2015

jbenet commented Aug 7, 2015

rht Aug 15, 2015

Choose a reason for hiding this comment

jbenet commented Aug 15, 2015

whyrusleeping commented Aug 15, 2015

rht commented Aug 16, 2015