OAuth redirect urls

16 views
Skip to first unread message

sdc50

unread,
Sep 16, 2015, 6:43:02 PM9/16/15
to Tethys Platform
Nathan,

Ezra and I are still a little confused about the Hydroshare redirect urls.  I assumed that the redirect urls were just something that we make up and then make sure that we have a controller to handle them. I told Ezra to follow the convention listed in in the docs, which was: https://www.example.org/oauth2/complete/hydroshare-oauth2/. I was then digging around to see where the controllers were to handle the redirect urls, but it looks like there is a url pattern which directs all the /oauth2/ urls to the Python Social Auth code: 

url(r'^oauth2/', include('social.apps.django_app.urls', namespace='social')),

This makes me think that the redirect urls must be dictated by Python Social Auth, but I don't see them anywhere in the documentation. Can you give us a little more explanation of what these should be?

Thanks!

Nathan Swain

unread,
Sep 17, 2015, 10:54:42 AM9/17/15
to Tethys Platform
Scott,

No problem, it is a little confusing. The controllers/views for the OAuth2 callbacks are automatically generated by python_social_auth and imported via the URL include statement you discovered. Generally, the pattern is:

http:/<host>:<port>/complete/<backend-name>/ 

As you can see I prepended all these social oauth URLs with "oauth2/" so that the pattern becomes: 

http:/<host>:<port>/oauth2/complete/<backend-name>/

So, what this means is you don't have to worry about implementing the controllers/views. However, you do need to define <backend-name>, which is done via the backend class that I setup and should be "hydroshare" making the callback URL:

http://<host>:<port>/oauth2/complete/hydroshare/

One thing to note is that it is perfectly legal to register a callback with 'localhost' as the host for testing. So I would probably ask them to whitelist not only the host that the testing Tethys server is on, but also the demo server, all possible hydroshare servers, and a localhost instance. That way they will all be good to go for the future.

If you wish to change the backend name, see line 23 of this file: https://github.com/tethysplatform/tethys/blob/master/tethys_services/backends/hydroshare.py

I've tried finding where this is documented, but as you have discovered, the Python Social Auth docs are lacking in many critical ways. There is a very hard to find reference in the implementing your own backend documentation under the description of the "name" parameter:


Hopefully this helps.



On Wed, Sep 16, 2015 at 11:35 PM, Nathan Swain <nathan....@gmail.com> wrote:

--
You received this message because you are subscribed to the Google Groups "Tethys Platform" group.
To unsubscribe from this group and stop receiving emails from it, send an email to tethysplatfor...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/tethysplatform/7fb49362-c9ee-4d5b-84aa-0545d803ceac%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
--
Nathan Swain



--
Nathan Swain, PhD
Aquaveo

sdc50

unread,
Sep 17, 2015, 10:25:46 PM9/17/15
to Tethys Platform, Ezra Rice
Nathan,

Thanks for shedding some light on the topic. I think the fog is starting to clear for me. We did give Rob callback urls for localhost:8000, the demo server and the appsdev hydroshare server. I imagine we'll have to reconfigure all of that when they go to their production server.

Ezra,

It looks like we emailed Rob the wrong callback urls. See Nathan's response. It looks like it should end in just /hydroshare/ not /hydroshare-oauth2/.


On Thursday, September 17, 2015 at 8:54:42 AM UTC-6, swainn wrote:
Scott,

No problem, it is a little confusing. The controllers/views for the OAuth2 callbacks are automatically generated by python_social_auth and imported via the URL include statement you discovered. Generally, the pattern is:

http:/<host>:<port>/complete/<backend-name>/ 

As you can see I prepended all these social oauth URLs with "oauth2/" so that the pattern becomes: 

http:/<host>:<port>/oauth2/complete/<backend-name>/

So, what this means is you don't have to worry about implementing the controllers/views. However, you do need to define <backend-name>, which is done via the backend class that I setup and should be "hydroshare" making the callback URL:

http://<host>:<port>/oauth2/complete/hydroshare/

One thing to note is that it is perfectly legal to register a callback with 'localhost' as the host for testing. So I would probably ask them to whitelist not only the host that the testing Tethys server is on, but also the demo server, all possible hydroshare servers, and a localhost instance. That way they will all be good to go for the future.

If you wish to change the backend name, see line 23 of this file: https://github.com/tethysplatform/tethys/blob/master/tethys_services/backends/hydroshare.py

I've tried finding where this is documented, but as you have discovered, the Python Social Auth docs are lacking in many critical ways. There is a very hard to find reference in the implementing your own backend documentation under the description of the "name" parameter:


Hopefully this helps.
 
 
Nathan,

Ezra and I are still a little confused about the Hydroshare redirect urls.  I assumed that the redirect urls were just something that we make up and then make sure that we have a controller to handle them. I told Ezra to follow the convention listed in in the docs, which was: https://www.example.org/oauth2/complete/hydroshare-oauth2/. I was then digging around to see where the controllers were to handle the redirect urls, but it looks like there is a url pattern which directs all the /oauth2/ urls to the Python Social Auth code: 

url(r'^oauth2/', include('social.apps.django_app.urls', namespace='social')),

This makes me think that the redirect urls must be dictated by Python Social Auth, but I don't see them anywhere in the documentation. Can you give us a little more explanation of what these should be?

Thanks!

--
You received this message because you are subscribed to the Google Groups "Tethys Platform" group.
To unsubscribe from this group and stop receiving emails from it, send an email to tethysplatform+unsubscribe@googlegroups.com.
--
Nathan Swain

Dan Ames

unread,
Sep 21, 2015, 5:04:50 PM9/21/15
to sdc50, Tethys Platform, Ezra Rice
Hey Ezra, any update on this work with Rob? 

To unsubscribe from this group and stop receiving emails from it, send an email to tethysplatfor...@googlegroups.com.
--
Nathan Swain



--
Nathan Swain, PhD
Aquaveo

--
You received this message because you are subscribed to the Google Groups "Tethys Platform" group.
To unsubscribe from this group and stop receiving emails from it, send an email to tethysplatfor...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/tethysplatform/018ef66d-3cb8-4c5e-ad8d-567de01be80c%40googlegroups.com.
Reply all
Reply to author
Forward
0 new messages