--- name: "Net::OAuth2::Profile::WebServer" section: "3pm" platform: "linux" package: "libnet-oauth2-perl" version: "0.67-1" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/Net::OAuth2::Profile::WebServer" --- # Net::OAuth2::Profile::WebServer(3pm) OAuth2 for web-server use ## NAME Net::OAuth2::Profile::WebServer - OAuth2 for web-server use ## INHERITANCE ``` Net::OAuth2::Profile::WebServer is a Net::OAuth2::Profile ``` ## SYNOPSIS ``` # See examples/psgi/ my $auth = Net::OAuth2::Profile::WebServer->new ( name => 'Google Contacts' , client_id => $id , client_secret => $secret , site => 'https://accounts.google.com' , scope => 'https://www.google.com/m8/feeds/' , authorize_path => '/o/oauth2/auth' , access_token_path => '/o/oauth2/token' , protected_resource_url => 'https://www.google.com/m8/feeds/contacts/default/full' ); # Let user ask for a grant from the resource owner print $auth->authorize_response->as_string; # or, in Plack: redirect $auth->authorize; # Prove your identity at the authorization server # The $info are the parameters from the callback to your service, it # will contain a 'code' value. my $access_token = $auth->get_access_token($info->{code}); # communicate with the resource serve my $response = $access_token->get('/me'); $response->is_success or die "error: " . $response->status_line; print "Yay, it worked: " . $response->decoded_content; ``` ## DESCRIPTION Use OAuth2 in a WebServer context. Read the DETAILS section, far below this man-page before you start implementing this interface. Extends "DESCRIPTION" in Net::OAuth2::Profile. ## METHODS Extends "METHODS" in Net::OAuth2::Profile. ### Constructors Extends "Constructors" in Net::OAuth2::Profile. - Net::OAuth2::Profile::WebServer-\>**new**(%options) ``` -Option --Defined in --Default auto_save client_id Net::OAuth2::Profile client_secret Net::OAuth2::Profile grant_type Net::OAuth2::Profile 'authorization_code' hd Net::OAuth2::Profile undef redirect_uri undef referer undef scope Net::OAuth2::Profile undef secrets_in_params Net::OAuth2::Profile site Net::OAuth2::Profile undef state Net::OAuth2::Profile undef token_scheme Net::OAuth2::Profile 'auth-header:Bearer' user_agent Net::OAuth2::Profile ``` - auto\_save =\> CODE When a new token is received or refreshed, it usually needs to get save into a database or file. The moment you receive a new token is clear, but being aware of refreshes in your main program is a hassle. Read more about configuring this in the "DETAILS" section below. - client\_id =\> STRING - client\_secret =\> STRING - grant\_type =\> STRING - hd =\> STRING - redirect\_uri =\> URI - referer =\> URI Adds a `"Referer"` header to each request. Some servers check whether provided redirection uris point to the same server the page where the link was found. - scope =\> STRING - secrets\_in\_params =\> BOOLEAN - site =\> URI - state =\> STRING - token\_scheme =\> SCHEME - user\_agent =\> LWP::UserAgent object ### Accessors Extends "Accessors" in Net::OAuth2::Profile. - $obj-\>**auto\_save**() - $obj-\>**bearer\_token\_scheme**() Inherited, see "Accessors" in Net::OAuth2::Profile - $obj-\>**grant\_type**() Inherited, see "Accessors" in Net::OAuth2::Profile - $obj-\>**hd**() Inherited, see "Accessors" in Net::OAuth2::Profile - $obj-\>**id**() Inherited, see "Accessors" in Net::OAuth2::Profile - $obj-\>**redirect\_uri**() - $obj-\>**referer**( \[$uri\] ) - $obj-\>**scope**() Inherited, see "Accessors" in Net::OAuth2::Profile - $obj-\>**secret**() Inherited, see "Accessors" in Net::OAuth2::Profile - $obj-\>**site**() Inherited, see "Accessors" in Net::OAuth2::Profile - $obj-\>**state**() Inherited, see "Accessors" in Net::OAuth2::Profile - $obj-\>**user\_agent**() Inherited, see "Accessors" in Net::OAuth2::Profile ### Actions Extends "Actions" in Net::OAuth2::Profile. - $obj-\>**authorize**(%options) On initial contact of a new user, you have to redirect to the resource owner. Somewhere in the near future, your application will be contacted again by the same user but then with an authorization grant code. Only the most common `%options` are listed... there may be more: read the docs on what your server expects. ``` -Option --Default client_id new(client_id) response_type 'code' scope undef state undef ``` - client\_id =\> STRING - response\_type =\> STRING - scope =\> STRING - state =\> STRING example: ``` my $auth = Net::OAuth2::Profile::WebServer->new(...); # From the Plack demo, included in this distribution (on CPAN) get '/get' => sub { redirect $auth->authorize }; # In generic HTTP, see method authorize_response use HTTP::Status 'HTTP_TEMPORARY_REDIRECT'; # 307 print HTTP::Response->new ( HTTP_TEMPORARY_REDIRECT => 'Get authorization grant' , [ Location => $auth->authorize ] )->as_string; ``` - $obj-\>**authorize\_response**( \[$request\] ) Convenience wrapper around **authorize()**, to produce a complete HTTP::Response object to be sent back. - $obj-\>**get\_access\_token**(CODE, %options) ``` -Option --Default client_id new(client_id) client_secret new(client_secret) ``` - client\_id =\> STRING - client\_secret =\> STRING - $obj-\>**update\_access\_token**($token, %options) Ask the server for a new token. You may pass additional `%options` as pairs. However, this method is often triggered automatically, in which case you can to use the `"refresh_token_params"` option of **new()**. example: ``` $auth->update_access_token($token); $token->refresh; # nicer ``` ### Helpers Extends "Helpers" in Net::OAuth2::Profile. - $obj-\>**add\_token**($request, $token, $scheme) Inherited, see "Helpers" in Net::OAuth2::Profile - $obj-\>**build\_request**($method, $uri, $params) Inherited, see "Helpers" in Net::OAuth2::Profile - $obj-\>**params\_from\_response**($response, $reason) Inherited, see "Helpers" in Net::OAuth2::Profile - $obj-\>**site\_url**( \<$uri\|$path\>, $params ) Inherited, see "Helpers" in Net::OAuth2::Profile ## DETAILS OAuth2 is a server-server protocol, not the usual client-server set-up. The consequence is that the protocol handlers on both sides will not wait for another during the communication: the remote uses callback urls to pass on the response. Your side of the communication, your webservice, needs to re-group these separate processing steps into logical sessions. ### The process The client side of the process has three steps, nicely described in \ - 1\. Send an authorization request to resource owner It needs a `"client_id"`: usually the name of the service where you want get access to. The answer is a redirect, based on the `"redirection_uri"` which you usually pass on. Additional `"scope"`, `"state"`, and `"hd"` parameters can be needed or useful. The redirect will provide you with (amongst other things) a `"code"` parameter. - 2\. Translate the code into an access token With the code, you go to an authorization server which will validate your existence. An access token (and sometimes a refresh token) are returned. - 3\. Address the protected resource The access token, usually a 'bearer' token, is added to each request to the resource you want to address. The token may refresh itself when needed. ### Saving the token Your application must implement a persistent session, probably in a database or file. The session information is kept in an Net::OAuth2::AccessToken object, and does contain more facts than just the access token. Let's discuss the three approaches. *no saving* The Plack example contained in the CPAN distribution of this module is a single process server. The tokens are administered in the memory of the process. It is nice to test your settings, but probably not realistic for any real-life application. *automatic saving* When your own code is imperative: ``` my $auth = Net::OAuth2::Profile::WebServer->new ( ... , auto_save => \&save_session ); sub save_session($$) { my ($profile, $token) = @_; ... } ``` When your own code is object oriented: ``` sub init(...) { my ($self, ...) = @_; my $auth = Net::OAuth2::Profile::WebServer->new ( ... , auto_save => sub { $self->save_session(@_) } ); } sub save_session($$) { my ($self, $profile, $token) = @_; ... } ``` *explicit saving* In this case, do not use new(auto\_save). ## COPYRIGHTS Copyrights 2013-2019 on the perl code and the related documentation\ by \[Mark Overmeer \\] for SURFnet bv, The Netherlands. For other contributors see "Changes". Copyrights 2011-2012 by Keith Grennan. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See *http://dev.perl.org/licenses/*