Speckle Auth, Hops, and remote Rhino Compute

Building on the conversation started in Running Speckle on Rhino Compute

To my understanding, Speckle is now set up to work in a headless Rhino instance using Rhino.Compute, using the Speckle Manager to authenticate using the users details.

So a desktop user can utilise Speckle in a compute context, where the speckle workflow is 100% internal to the script and assuming there is a logged in user.

In a “truely remote” compute environment, a use case might be:

  1. User visits a web app and authenticates with speckle
  2. User uploads a GH script to run remotely
  3. GH script is sent to RhinoCompute VM via Resthopper endpoiints
  4. GH script executes using credentials provided by app

So you’d need some way to authenticate a Speckle node directly, so that you could provide the auth info through Resthopper?

There are a couple of ways to approach this so I’m interested in other people’s thoughts.

2 Likes

Hey @chris.welch!

Interesting suggestion, and 100% valid. Obviously most of the existing logic needs to be revised for this use-case, which I have already started thinking about during Christmas.

On this, what I had in mind is creating a new node that would have the token and server as an input and would spit out a correct account object or error out if the token is invalid.

I’m fairly certain this would not be “as magical” as it sounds, as it may involve some re-thinking on the account fetching logic on Core. Pinging @teocomi and @luisfraguada on this too!

Happy to hear your thoughts on this, and any alternative ideas you may have had in mind.

P.S. Not sure if passing in an auth token to a GH file as a plain text string is the best of ideas from a security perspective… :thinking:

Hey @chris.welch , see this info to set up accounts on the remote machine without the use of Manager:

Another way could be to have your own logic in C#.

We’ve been asked this in the past and our answer is that it could too easily lead to credentials being leaked, that’s why we’re a bit reluctant heading that way :wink:

4 Likes

@teocomi, if I’m to understand this correctly, this functionality already exists, and the process would be something along the lines of:

  1. User visits a web app and authenticates with speckle
  2. User token added to %appdata%\Speckle\Accounts\ on VM with RhinoCompute and Speckle installed
  3. User uploads a GH script to run remotely
  4. GH script is sent to RhinoCompute VM via Resthopper endpoints
  5. GH script executes using credentials within %appdata%\Speckle\Accounts\

If the user revokes the app then the token expires, as expected.

The only issue I could see there (which I haven’t tested) is that if multiple users added to that list have access to a stream, it might short circuit? (e.g user A and B have access to a stream and are authenticated with the app, user B uploads and runs a script that uses the stream, speckle GH node checks authenticated users in order and as A has access, commit has thier name against it).

1 Like

A cursory look with a new account with no permissions indicates that this is the case:

The expected behaviour woud be that sGet would return a null because the selected user doesn’t have permissions on the test stream, and the send and recieve nodes should also throw an error if a specific user is specified and that user doesn’t have permission. I think if that behaviour changed, then you could handle the rest of the auth just through Grasshopper, as the send and recieve would both be fed a null in the case that the permissions were incorrect.

2 Likes

Thanks for the detailed comments @chris.welch,

we’re already discussing some changes on these lines:

Currently, the sender outputs an “unauthenticated Stream Wrapper object”. Meaning, even if it did use the correct account to send, the output commit url will still be one with no account set on it. This is a fairly easy change to make.

The second issue is that Stream Get is in fact using a different logic to fetch the account than the one implemented in the StreamWrapper. This is yet another easy change that will result in the expected behaviour you described.

There may be other places where this change will make sense so I’ll have a look and open an issue about all this in our repo.

2 Likes

Cheers folks, I’ll keep this thread unresolved until those changes are implemented

Hi @chris.welch!

We’ve already starting working on the auth changes needed to make this happen. I’m hoping to have them merged soon and make a pre-release so you (and the rest of the community) can give it a go before we settle on any particulars.

Here’s the PR in case you’re curious! feat(gh): Adds new nodes to enable account authentication with a token by AlanRynne · Pull Request #2108 · specklesystems/speckle-sharp · GitHub

2 Likes

Hey @chris.welch,

I forgot to ping you back on this, but 2.12 contains the new nodes described in the PR linked above.

Feel free to give them a go and come back to us with any feedback. We’re also in conversations with other users about how to improve this workflow and how to minimise the amount of changes required to a GH script to get it running on compute properly, so anything in that regard would be appreciated!

2 Likes

Hey @AlanRynne just got a chance to test these tonight and this is looking great - good balance of flexibility and providing tools to set things up securely. I’ll have more of a play and update with any feedback!

3 Likes

Hello all,
I see a very interesting discussion going on here so i thought maybe can be relevant to ask it here.

I am intending to start with Speckle Rhino compute, to call a grasshopper definition and use the geometry parts in speckle as input to my gh definition, and i see that the process is discussed here but i need some more info about how to start with using rhino compute in Speckle and Hops? I would appreciate any guidance with this.

Also i saw some documentation that using Rhino Compute for production environment costs 10 cents per core per hour. My question is that if we want to use it for Speckle do we need that charging version?

Regards
Niloo

This would be a question for McNeel. @luis ?

Niloo, if you’re running Rhino.Compute in the background on your home PC, you’re fine, here’s some procedural generation stuff I was doing with Speckle last year:

GitHub - secretlyagoblin/speckle-notebooks

My understanding is other than that its 10c US an hour. It was simple enough for us to set up

Thank you very much @chris.welch for the definitions. I see that you have used Speckle Stream there as the input. The thing i do not understand is how i can start connecting the RC to Speckle so my gh definition runs in the background and i see the result in speckle.

I want to have the geometry in Speckle and run the gh definition in background for that geometry in Speckle (to do a daylight analysis for example) and then see the result in Speckle. As i understood i can use Specklepy and call Rhino Compute in python, and then i can use all the plugins i have in grasshopper . But i am a bit blank about the process of coding in Speckle and if i have to use Hops or is there another way to call a gh definition from Speckle?