Difference between revisions of "Master Portal Internals"

From PDP/Grid Wiki
Jump to navigationJump to search
(typo)
(auth start)
Line 20: Line 20:
 
* User Authentication : the Master Portal is not configured to authenticate users, therefore user authentication requests have to be forwarded to the Delegation Server. On the diagram the /startRequest and /authorize calls serve this purpose.
 
* User Authentication : the Master Portal is not configured to authenticate users, therefore user authentication requests have to be forwarded to the Delegation Server. On the diagram the /startRequest and /authorize calls serve this purpose.
 
* Certificate Requests : the Master Portal cannot issue '''new credentials''' for authenticated users, it can only retrieve credentials for users who already have a valid credential in the MyProxy Credential Store. Asking for a '''new credential''' (either for new users, or users who's credential expired in the credential store) can be done by calling the GetCert Endpoint. The /forwardgetcert is used for this.   
 
* Certificate Requests : the Master Portal cannot issue '''new credentials''' for authenticated users, it can only retrieve credentials for users who already have a valid credential in the MyProxy Credential Store. Asking for a '''new credential''' (either for new users, or users who's credential expired in the credential store) can be done by calling the GetCert Endpoint. The /forwardgetcert is used for this.   
 +
 
== Authentication Flow ==
 
== Authentication Flow ==
 +
 +
The Master Portal does not authenticate users locally, instead authentication requests are forwarded to the Delegation Server. An unmodified OA4MP Server can be configured to authenticate users either by their password credentials or via shibboleth, but has no support for authN request forwarding. The Master Portal implements this missing authN forwarding.
 +
 +
The Master Portal authN flow is divided into two sub-flows:
 +
 +
* AUTHORIZATION_ACTION_START : the user is not yet authenticated
 +
*# The VO Portal start an OIDC/OA4MP flow by sending an authorization request to the Master Portal (OA4MP Server).
 +
*# Following the [http://grid.ncsa.illinois.edu/myproxy/oauth/server/manuals/authorized.xhtml OA4MP mini-protocol] a call to /authorize'''d''' endpoint is made to retrieve the '''code''' & '''state''' of the initiated transaction.
 +
*# The authN request forwarding is done by triggering a second OIDC/OA4MP flow between the Master Portal (OA4MP Client) and the Delegation Service. The /startRequest endpoint will kick this second flow off.
 +
*#* The '''code''' & '''state''' are sent from the Master Portal (OA4MP Server) to the Master Portal (OA4MP Client) for session keeping.
 +
*# The Master Portal (OA4MP Client) starts the second OIDC/OA4MP flow by sending an authorization request to the Delegation Server
 +
*#* The '''identifier''' is send along in a cookie. This is used to keep session between the user (browser) and the Master Portal (OA4MP Client).
 +
*# In case the user is correctly authenticated, the Delegation Server will trigger a browser redirect to the ''redirect_uri'' (/ready endpoint) on the Master Portal (OA4MP Client). This endpoint has to be pre-registered with the Delegation Server!
 +
*#* The '''identifier''' is extracted from the cookies in order to identify the pending authN session of Master Portal (OA4MP Client).
 +
*# The Master Portal (OA4MP Client) retrieves an Access Token from the Delegation Server
 +
*# The Master Portal (OA4MP Client) retrieves an information of the authenticated user from the Delegation Server. This includes the '''username'''.
 +
* AUTHORIZATION_ACTION_OK : the user is authenticated
 +
*# The authenticated '''username''' is send back from the Master Portal (OA4MP Client) to the Master Portal (OA4MP Server) to its' /authorize endpoint.
 +
*#* The previously received '''code''' & '''state''' are also send back in order to identify the pending authN session of Master Portal (OA4MP Server).
 +
 +
Once the Delegation Server receives the authorization request, it will authenticate the user by forwarding him to a WAYF.

Revision as of 17:48, 13 January 2016

The Master Portal stands at the heart of the CILogon Pre-Pilot Work. The Master Portal caches long lived user proxies into its MyProxy Crendential Store, and returns short lived proxies on demand for authenticated users via the VO Portal.

Structure

The Master Portal is made up internally of a OA4MP Server and Client. For the purpose of the VO Portal, the Master Portal is an OA4MP Server. For the purpose of the Delegation Service the Master Portal is an OA4MP Client. The motivation of having OA4MP Client and Server rolled into one unit was to have a mediator between the VO Portal and the Delegation Server (Online CA), caching user credentials (long lived proxies) passing through it.

Masterportal-structure.svg

Most of the endpoints in the above diagram are part of the standard OIDC/OA4MP protocol. The new endpoint are marked with blue:

  • /getproxy : retrieves voms proxies via the GetProxy Endpoint.
  • /forwardgetcert : simply forward the call to the GetCert Endpoint.

The Master Portal (OA4MP Server) takes registrations from VO Portals. Once a VO Portal is registered and approved, it can use the Master Portal (OA4MP Server) exposed endpoint in order to start an OIDC/OA4MP flow(1) between VO Portal and Master Portal. The only deviation from the original flow is that at the end, instead of calling the GetCert Endpoint, the VO Portal calls the GetProxy Endpoint.

The Master Portal (OA4MP Client) component has to be registered with the Delegation Server (OA4MP Server). It starts a second OIDC/OA4MP flow(2) between Master Portal and Delegation Server. Here, the GetCert Endpoint is left unchanged.

The two components will interact for the following reasons:

  • User Authentication : the Master Portal is not configured to authenticate users, therefore user authentication requests have to be forwarded to the Delegation Server. On the diagram the /startRequest and /authorize calls serve this purpose.
  • Certificate Requests : the Master Portal cannot issue new credentials for authenticated users, it can only retrieve credentials for users who already have a valid credential in the MyProxy Credential Store. Asking for a new credential (either for new users, or users who's credential expired in the credential store) can be done by calling the GetCert Endpoint. The /forwardgetcert is used for this.

Authentication Flow

The Master Portal does not authenticate users locally, instead authentication requests are forwarded to the Delegation Server. An unmodified OA4MP Server can be configured to authenticate users either by their password credentials or via shibboleth, but has no support for authN request forwarding. The Master Portal implements this missing authN forwarding.

The Master Portal authN flow is divided into two sub-flows:

  • AUTHORIZATION_ACTION_START : the user is not yet authenticated
    1. The VO Portal start an OIDC/OA4MP flow by sending an authorization request to the Master Portal (OA4MP Server).
    2. Following the OA4MP mini-protocol a call to /authorized endpoint is made to retrieve the code & state of the initiated transaction.
    3. The authN request forwarding is done by triggering a second OIDC/OA4MP flow between the Master Portal (OA4MP Client) and the Delegation Service. The /startRequest endpoint will kick this second flow off.
      • The code & state are sent from the Master Portal (OA4MP Server) to the Master Portal (OA4MP Client) for session keeping.
    4. The Master Portal (OA4MP Client) starts the second OIDC/OA4MP flow by sending an authorization request to the Delegation Server
      • The identifier is send along in a cookie. This is used to keep session between the user (browser) and the Master Portal (OA4MP Client).
    5. In case the user is correctly authenticated, the Delegation Server will trigger a browser redirect to the redirect_uri (/ready endpoint) on the Master Portal (OA4MP Client). This endpoint has to be pre-registered with the Delegation Server!
      • The identifier is extracted from the cookies in order to identify the pending authN session of Master Portal (OA4MP Client).
    6. The Master Portal (OA4MP Client) retrieves an Access Token from the Delegation Server
    7. The Master Portal (OA4MP Client) retrieves an information of the authenticated user from the Delegation Server. This includes the username.
  • AUTHORIZATION_ACTION_OK : the user is authenticated
    1. The authenticated username is send back from the Master Portal (OA4MP Client) to the Master Portal (OA4MP Server) to its' /authorize endpoint.
      • The previously received code & state are also send back in order to identify the pending authN session of Master Portal (OA4MP Server).

Once the Delegation Server receives the authorization request, it will authenticate the user by forwarding him to a WAYF.