Grant Negotiation Access Protocol
draft-richer-transactional-authz-11

Document Type Active Internet-Draft (individual)
Last updated 2020-09-11
Stream (None)
Intended RFC status (None)
Formats plain text html xml pdf htmlized (tools) htmlized bibtex
Stream Stream state (No stream defined)
Consensus Boilerplate Unknown
RFC Editor Note (None)
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to (None)
GNAP                                                      J. Richer, Ed.
Internet-Draft                                       Bespoke Engineering
Intended status: Standards Track                      September 11, 2020
Expires: March 15, 2021

                   Grant Negotiation Access Protocol
                  draft-richer-transactional-authz-11

Abstract

   This document defines a mechanism for delegating authorization to a
   piece of software, and conveying that delegation to the software.
   This delegation can include access to a set of APIs as well as
   information passed directly to the software.

   This document has been prepared by the GNAP working group design team
   of Kathleen Moriarty, Fabien Imbault, Dick Hard, Mike Jones, and
   Justin Richer.  This document is input into the GNAP working group.

   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
   "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
   "OPTIONAL" in this document are to be interpreted as described in
   BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all
   capitals, as shown here.

Status of This Memo

   This Internet-Draft is submitted in full conformance with the
   provisions of BCP 78 and BCP 79.

   Internet-Drafts are working documents of the Internet Engineering
   Task Force (IETF).  Note that other groups may also distribute
   working documents as Internet-Drafts.  The list of current Internet-
   Drafts is at https://datatracker.ietf.org/drafts/current/.

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
   material or to cite them other than as "work in progress."

   This Internet-Draft will expire on March 15, 2021.

Copyright Notice

   Copyright (c) 2020 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

Richer                   Expires March 15, 2021                 [Page 1]
Internet-Draft      Grant Negotiation Access Protocol     September 2020

   This document is subject to BCP 78 and the IETF Trust's Legal
   Provisions Relating to IETF Documents (https://trustee.ietf.org/
   license-info) in effect on the date of publication of this document.
   Please review these documents carefully, as they describe your rights
   and restrictions with respect to this document.  Code Components
   extracted from this document must include Simplified BSD License text
   as described in Section 4.e of the Trust Legal Provisions and are
   provided without warranty as described in the Simplified BSD License.

Table of Contents

   1.  Protocol  . . . . . . . . . . . . . . . . . . . . . . . . . .   4
     1.1.  Roles . . . . . . . . . . . . . . . . . . . . . . . . . .   4
     1.2.  Sequences . . . . . . . . . . . . . . . . . . . . . . . .   6
       1.2.1.  Redirect-based Interaction  . . . . . . . . . . . . .   9
       1.2.2.  User-code Interaction . . . . . . . . . . . . . . . .  11
       1.2.3.  Asynchronous Authorization  . . . . . . . . . . . . .  13
       1.2.4.  Software-only Authorization . . . . . . . . . . . . .  14
       1.2.5.  Refreshing an Expired Access Token  . . . . . . . . .  15
   2.  Requesting Access . . . . . . . . . . . . . . . . . . . . . .  16
     2.1.  Requesting Resources  . . . . . . . . . . . . . . . . . .  18
       2.1.1.  Requesting a Single Access Token  . . . . . . . . . .  18
       2.1.2.  Requesting Resources By Reference . . . . . . . . . .  20
       2.1.3.  Requesting Multiple Access Tokens . . . . . . . . . .  22
     2.2.  Requesting User Information . . . . . . . . . . . . . . .  24
     2.3.  Identifying the RC by Key . . . . . . . . . . . . . . . .  24
       2.3.1.  Authenticating the RC . . . . . . . . . . . . . . . .  26
       2.3.2.  Identifying the Client Key By Reference . . . . . . .  26
     2.4.  Identifying the User  . . . . . . . . . . . . . . . . . .  27
       2.4.1.  Identifying the User by Reference . . . . . . . . . .  28
     2.5.  Interacting with the User . . . . . . . . . . . . . . . .  29
       2.5.1.  Redirect to an Arbitrary URL  . . . . . . . . . . . .  30
       2.5.2.  Open an Application-specific URL  . . . . . . . . . .  31
       2.5.3.  Receive a Callback After Interaction  . . . . . . . .  31
       2.5.4.  Display a Short User Code . . . . . . . . . . . . . .  34
       2.5.5.  Indicate Desired Interaction Locales  . . . . . . . .  34
       2.5.6.  Extending Interaction Capabilities  . . . . . . . . .  34
     2.6.  Providing Displayable RC Information  . . . . . . . . . .  34
     2.7.  Declaring RC Capabilities . . . . . . . . . . . . . . . .  35
     2.8.  Referencing an Existing Grant Request . . . . . . . . . .  35
     2.9.  Requesting OpenID Connect Claims  . . . . . . . . . . . .  36
     2.10. Extending The Grant Request . . . . . . . . . . . . . . .  37
   3.  Grant Response  . . . . . . . . . . . . . . . . . . . . . . .  37
Show full document text