Child pages
  • UMA1 Interop Features and Feature Tests
Skip to end of metadata
Go to start of metadata

UMA1 Interop Features and Feature Tests

Main UMA1 Interop Testing page | Participants and Solutions | Results

The feature tests provided below are historical. We are redesigning them in light of feedback from the OpenID Connect interop and conformance testing process and Roland Hedberg's UMA test suite implementation process. The tests below may be inaccurate with respect to UMA V1.0 Candidate specs, as they date from the pre-V0.9 era.


These feature tests relate exclusively to the core protocol specification, any other normatively referenced technical specifications, and the software entities that serve as protocol endpoints implementing these specifications. None relate to the Binding Obligations specification because that spec describes expected behaviors of operators and users of these endpoints, which makes them untestable for the purposes of an interop. Feature tests are marked as either required (req) or optional (opt) based on the optionality of the underlying spec clauses they're derived from, where req is for all testable MUST/REQUIRED clauses and opt is for all other testable clauses. We have not yet defined what "full conformance" means in any formal sense. (A few untestable clauses do appear in the technical specifications.)

A feature test identifier has three parts, separated by hyphens. Every identifier starts with FT. The second part indicates the software entity being tested: AS, RS, or C. The third part, which may have embedded hyphens, describes the nature of the test. The supporting clauses in the technical specifications have been classified using feature "tags". The tests are grouped under primary feature tags for ease of test result reporting.

Feature tests for "config"

Machine-readability of entity capabilities and constraints. 

IDreq/optDescriptionSuccess
FT-as-config-datareqAS provides configuration data that conforms to specified formats and provides all required properties and values.

Data conforms and is complete

 

FT-as-config-endpt

reqAS makes config data available through https://as_uri/.well-known/uma-configuration.AS config data endpoint uses https: scheme with specific URL form, with a valid certificate
FT-rs-get-config-dataoptRS successfully accesses and parses AS config data properties it needs at https://as_uri/.well-known/uma-configuration, including all endpoint-related properties not specific to the RS and including handling of non-understood extension properties.RS successfully accesses and parses AS config data
FT-c-get-config-dataoptClient successfully accesses and parses AS config data properties it needs at https://as_uri/.well-known/uma-configuration, including all endpoint-related properties not specific to the client and including handling of non-understood extension properties.Client successfully accesses and parses AS config data


Feature tests for "dynreg"

Client registration of resource servers (which are clients of the AS's protection API) and clients of resource servers (which are also clients of the AS's authorization API) at run time when services have not "met" before a resource owner or requesting party forces the issue.

IDreq/optDescriptionSuccess
FT-as-dyn-client-regoptAS config data "dynamic_client_endpoint" property provides a URI valueProperty has a URI provided
FT-rs-get-dyn-client-credsoptRS interacts with AS to request and receive client credentials dynamicallyRS gets client credentials dynamically
FT-c-get-dyn-client-credsoptC interacts with AS to request and receive client credentials dynamicallyC gets client credentials dynamically

 

Feature tests for "pat"

 "Protection of the protection API" at the authorization server, and the association made between the authorization server, resource server, and resource owner as a result of protection API token (PAT) issuance.

IDreq/optDescriptionSuccess
FT-rs-get-patreqAS issues PAT to RS using OAuth authorization_code grant flow and request for protection API scopeAS issues PAT to RS IFF RS engages correctly
FT-as-require-patreqAS requires OAuth clients of protection API (definitionally, RSs) to present valid OAuth access tokens with protection API scope in order to use endpointsAS allows RSs to make protection API calls IFF they present protection API scope
FT-rs-use-patreqRS presents valid OAuth access token with protection API scope when making calls to all protection API endpointsRS presents PAT to all protection API endpoints

Feature tests for "aat"

"Protection of the authorization API" at the authorization server, and the association made between the authorization server, client, and requesting party as a result of authorization API token (AAT) issuance.

IDreq/optDescriptionSuccess
FT-c-get-aatreqAS issues AAT to Client given OAuth authorization_code grant flow and request for authorization API scopeAS issues AAT to client IFF client engages correctly
FT-as-require-aatreqAS requires OAuth clients of authorization API (definitionally, Clients) to present valid OAuth access tokens with authorization API scope in order to use endpointsAS allows Client to make authorization API calls IFF they present authorization API scope
FT-c-use-aatreqClient presents valid OAuth access token with authorization API scope when making calls to all authorization API endpointsClient presents AAT to all authorization API endpoints

Feature tests for "protapi"

RS-AS communication through the protection API and its various endpoints.

IDreq/optDescriptionSuccess
FT-as-rsrreqAS presents all of the following methods at a resource set registration endpoint of form rsreguri/resource_set/rsid, and treats others as unsupported: PUT with unique ID to register new resource set description; GET with unique ID to read already-registered resource set description, handling the presence of any policy_uri property in AS's response; PUT with If-Match and unique ID to update already-registered resource set description, handling the presence of any policy_uri property in AS's response; DELETE with a unique ID to delete an already-registered resource set description; and GET on resource_set path to read list of already-registered resource set descriptions.RS able to use all elements of resource set registration API
FT-rs-rsrreqRS uses: PUT with unique ID to register new resource set description; GET with unique ID to read already-registered resource set description, handling the presence of any policy_uri property in AS's response; PUT with If-Match and unique ID to update already-registered resource set description, handling the presence of any policy_uri property in AS's response; DELETE with a unique ID to delete an already-registered resource set description; and GET on resource_set path to read list of already-registered resource set descriptions. RS links to well-formed scope descriptions and provides well-formed resource set descriptions.RS uses all elements of resource set registration API and scope and resource set description formats correctly
FT-as-rsr-errorreqAS issues errors for resource set registration error conditions, including unsupported_method_type, not_found, and precondition_failed.AS issues resource set registration API errors for error conditions
FT-as-rsr-scope-extreqIf a scope description contains extension properties, the AS proceeds normally in handling the scope description.AS does not produce an error on encountering extension properties in scope description
FT-as-introspectreqAS presents the token introspection endpoint, supporting only the POST method.RS able to use token introspection endpoint
FT-rs-introspectreqRS presents a valid RPT at AS's token introspection endpoint to get token's status.RS gets well-formed RPT status
FT-as-reg-permreqAS presents a permission registration endpoint that enables RS to register permission associated with correct resource owner, resource set, and scopes, and returns securely random permission ticket in response to RS registration of requested permission.AS returns permission ticket that is securely random
FT-rs-reg-permreqRS presents a valid PAT, and valid previously registered resource set and scope information, at AS's permission registration endpoint to register a requested permission that is relevant for the type of access attempted by client.RS registers requested permission

 

Feature tests for "authzapi"

C-AS communication through the authorization API and its various endpoints.

IDreq/optRoleDescriptionSuccess
FT-as-rptreqASAS presents the RPT endpoint and AS issues RPT in response to client's request for an RPT at the correct endpoint with a valid AAT.Client able to get RPT using endpoint
FT-c-rptreqCClient presents valid AAT at AS's RPT endpoint to get RPT.Client gets new or refreshed RPT
FT-c-authz-datareqCClient presents valid AAT, valid RPT, and permission ticket at AS's authorization endpoint to POST request that authorization data be associated with RPT.Client receives back normal success or error message
FT-as-authz-data-denyreqASAS determines that the client should not get authorization data, and returns either an invalid_ticket error, an expired_ticket error, or a not_authorized_permission error.AS returns one of the errors
FT-as-authz-data-givereqASAS associates new authorization data with the RPT that the client presented and responds with success.AS adds authorization data and responds with success
FT-as-need-claimsreqASAS indicates it needs requesting party claims to considering adding permission to "bearer" profile RPT.AS responds to the client with a need_claims error

Feature tests for "access"

C-RS communication through the UMA-protected resource interface for the purpose of attempting and granting or denying access.

IDreq/optRoleDescriptionSuccess
FT-rs-no-rptreqRSRS responds to client not bearing an RPT with HTTP 401 and correct as_uri corresponding to AS protecting the resource to which access was attempted.RS responds with HTTP 401 and as_uri
FT-rs-invalid-rptreqRSRS responds to client bearing an invalid RPT with HTTP 401 and correct as_uri corresponding to AS protecting the resource to which access was attempted.RS responds with HTTP 401 and as_uri
FT-c-rptreqCC requests access to a resource by providing a correctly formed and located RPT. 
FT-rs-insufficient-permreqRSRS responds to client bearing a valid "bearer" profile RPT that has insufficient permissions with HTTP 403, as_uri, and permission ticket corresponding to resource for which access was attempted. NOTE: Conducting this test depends on RS-specific API and scope details.RS responds with HTTP 403, as_uri, and permission ticket
FT-rs-respect-authzreqRSRS limits access to resource that is currently under protection at an AS for which a valid RPT with valid authorization data has not been presented by a client. NOTE: Conducting this test depends on RS-specific API and scope details.RS blocks and grants client's access according to RPT's current status

Feature tests for "claims"

TBS.


  • No labels