Remere Login

A declarative HTML API for User Authentication

Most recent revision 2021-04-22. Available here.

Navigation

Introduction

The Remere Login specification was created to automate the process of users signing into websites, in order to make it easier for users, and make the process more secure. (i.e. Enable password alternatives.) It has the following primary goals.

"Service" and "BiscProfile"

This specification uses the concept of a website "Service". The entire Remere Login process is simply one type of service. (Remere Login defines a general process for how User Authentication will work.) The general idea is that the RP declares that it supports the Remere Login "service", and the browser can call the service when it wants to perform an action. (To login or logout, etc.)

Because the process of defining and invoking "website services" may be useful for other types of services beyond User Authentication, it was generalized and split out from Remere Login into a separate specification, called the Capis specification.

A website can define what services it wants to support, and what settings the browser should use when making a service call. A "service" defines a specific process that HTML pages can use. Each service must have a well-known API and protocol. However, a service is customizable, because a website (or an individual page on a website) can define different settings to use with the service.

The "service settings" are defined in a BiscProfile JSON object. The "service settings" are given to the browser by the RP website by including JSON values in the HTML page. A "BiscProfile" is either published in a Bisc Site Document and linked to from the HTML page, or it is embedded in a ServiceGroup HTML Element in the HTML page. (A ServiceGroup HTML Element contains a BiscGroup JSON object. The BiscGroup contains a list of BiscProfile objects in the "serviceProfileList" property.) Note that the "BiscProfile" is written in JSON, not Javascript. The browser is not required to enable Javascript for the website.

Example of a Service Trigger HTML Element (a Anchor HTML Element) and login selection popup list.
Example HTML login anchor Example HTML login anchor
Note that the "remere" menu item in the browser chrome will change its status depending on the login status of the selected tab. (i.e. If the browser is logged into the website or not.) If the browser is logged in, then the menu item will display a different icon or label, and will display different options in the popup dialog box, etc.

Example HTML. Includes a ServiceGroup HTML Element, and a Service Trigger HTML Element.
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup"
 servicegroup-config='{ "challengeTime": 1599876543210,
  "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK",
  "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"},
  "mediation": "required"}] }'/>
...
<a href="remere://example.com/remereService?op=login" rel="servicetrigger"
 trigger-config='{ "op":"login", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }'>Login</a>

Introduction to the Login Process

The Remere User Authentication process is commonly started when a user clicks on a Service Trigger. The trigger defines what BiscProfile to use, and what Operation to perform. (In the triggerConfig.op property.) The process will connect to the Login Manager (if it has not already done so), and request from it a list of User Logins for the current website. It will display the list of login items to the user, and allow the user to select a login from the list, or create a new one. Upon selection, it will ask the Login Manager to generate a Proof of Identity from the selected User Login and the HTML page's challengeTime. (A Proof of Identity includes a "username" and a list of "Credential Proofs", etc.) Then the process will create a Service Request (an RML Request), encode the Proof of Identity in it, and send the request to the Service Endpoint. The website will perform the requested operation and will return a Service Response (an RML Response). The Remere process will receive the response from the website, finish logging in the user, and will then update the HTML page being displayed.

Remere Login Primary Characteristics

The primary characteristics of the Remere Login specification are:

Remere Login general process overview

Remere Login uses the Capis specification to embed data about Remote Services in HTML. When the RP web page is requested by the browser, the RP creates a set of a BiscGroup. (Written in modified-for-HTML JSON.) The options must include a unique challenge. Using the Capis specification, the RP includes the a BiscGroup in the HTML page, using a special ServiceGroup HTML Element.

The login process is started when the user activates one of the ServiceTriggers. For example, this can be a click on a Anchor HTML Element. First, the browser will perform the Capis Service Invocation Protocol, examine the Trigger Configuration inside the trigger, and depending on the contents, it will then start the Remere User Authentication process. When Remere starts, the browser will need to connect to the user's Login Manager (if it has already not done so). The browser will communicate with the Login Manager, to get a list of Login Items for the current website. Then it will display the list to the user. The user can then select which Login Item to use. Upon selection, the browser will again communicate with the Login Manager to get the proof-of-identity (generated from the User Login that was selected) and then it will send the proof to the RP website (at its Service Endpoint) in a RML Request.

Note that this process does not use an HTML form. The user does not enter any data into a website form. The browser does not send the RP a form submission. Instead, the browser creates and sends a Service Request to the RP's Service Endpoint. This eliminates user data entry, and thus will allow websites to support using longer, more complicated, login keys during the login process, without requiring users to remember or type anything complicated. (Note that a website is a type of relying party. An "RP".)

The Remere-Capis login process is similar to Webauthn, but there are many differences.

Some major differences between Remere (which uses Capis) and Webauthn:

This login process is similar to Webauthn, but there are many differences. Among them are (1) It eliminates forms on websites, (2) It does not use javascript. (Instead, it embeds modified-for-HTML JSON in Service Trigger HTML Element attributes.) It does not require a web page to have javascript enabled. (3) It defines a transport format for the proof-of-identity, the RML Request. (4) The Service Request can contain multiple Credential Proof. (i.e. It supports Multi-factor authentication.) (5) The Service Request can contain an operation ID. A trigger can be used to invoke any of the different operations at the RP. (i.e. Any of the RML Operation List, including "login", "logout", "proveUserPresence", "setActiveCredentials" i.e. "change password".) (6) The embedded modified-for-HTML JSON Trigger Configuration can be used to activate other types of protocols, besides User Authentication.

The primary goals of the Remere Login specification are:

There needs to be a way for HTML to mark which HTML elements are used to perform User Authentication. This is useful for password managers, screen readers, accessibility, (for the blind, etc.). Password managers should not have to guess which HTML elements (which forms) are used for User Authentication.

To meet these primary goals, and all the other design goals, a pair of specifications were created. The Capis specification and Remere Login. (i.e. The login process was split into two different specifications.)

Capis Specification Overview

The Capis specification is a way to specify Remote Services and Service Triggers in HTML files, without using javascript. (It embeds modified-for-HTML JSON in HTML attributes.) It is a general format specification, it does not include any User Authentication API. It can be used to embed any type of Service Trigger.

The Capis specification does a few things. (1) It provides a way for websites (RPs) to embed BiscProfiles and Service Triggers in HTML markup, without using javascript. (It embeds modified-for-HTML JSON in HTML attributes.) (2) It defines the process of how a user can invoke a Protocol Handler by activating a Service Trigger. This is called the Capis Service Invocation Protocol. (3) It provides a way for websites to categorize different types of services. (i.e. Each service specifies a biscProfile.protocolSpec.) (4) It provides an easy way for browsers to support multiple types of services. (A browser can implement a Protocol Handler.)

Capis, by itself, does not do anything. In particular, it does not perform User Authentication. Capis must be used together with a Protocol Handler (implemented in the browser) to perform any actions. (Such as Remere Login, or WebAuthn or some other protocol, to perform User Authentication.)

In the Login process, the delivery of the login values to the website must be done using a protocol and a login value format that the website understands. So the format must either be a standard, or the website must publish some type of BiscProfile or a BiscGroup that contains what protocols it understands. The Remere Login specification defines one such protocol and format (The RML Request). Websites are free to prefer or require other protocols (such as WebAuthn), but this is dependent on browser capabilities. Browsers should support at least the base level protocol. (Note that WebAuthn is another such user authentication protocol. It can be used with or instead of Remere Login.)

The Capis specification includes the ServiceGroup HTML Element, Service Trigger HTML Element, some JSON formats, and a browser protocol, called the Capis Service Invocation Protocol. (The JSON formats include the Trigger Configuration, BiscGroup and the BiscProfile format.)

The Capis specification is a way for websites (i.e. RPs) to define their own Remote Services and embed Service Triggers and BiscProfile values (i.e. Trigger Configuration and a BiscGroup) in HTML markup.

In Capis, the website explicitly declares, in the ServiceGroup HTML Element, how it wants its services to be invoked. The Capis Service Invocation Protocol causes the browser to read the Trigger Configuration, create a callOptions object out of them, and then call CapisControl.invokeServiceAction. The CapisControl.invokeServiceAction function will then invoke the Protocol Handler for the requested service. The handler then performs the requested operation. In general, the handler reads the BiscProfile for the service (The set of these are in the a BiscGroup), then prompts the user appropriately (if necessary), then it creates and sends a Service Request to the Service Endpoint and awaits a Service Response. (Capis is known as a declarative Service Trigger HTML Element API.)

Capis, by itself, does not do anything. Capis must be used together with a Protocol Handler to perform actions. (Such as Remere Login, or WebAuthn to perform User Authentication.)

Capis has both new browser requirements, and new website requirements.

The Capis specification defines the following items.

These abilities allow a website to embed different Service Triggers in its HTML. These can include a "login trigger". This allows a login action to be triggered with a button or link, etc. Since the trigger does not have to be a form.

Remere Login Overview

Remere Login is a way to use Capis to perform User Authentication.

Remere Login is a specification separate from, yet dependent on, the Capis specification. It is a Protocol Handler that does one type of User Authentication. In order to be used in a browser, the browser must implement the Protocol Handler and the RP must implement the Remote Service. (The RP's HTML web pages must include a ServiceGroup HTML Element. It must contain a BiscGroup that describe a Remere Login Remote Service.) The Remere Login Protocol Handler is called by the Capis Service Invocation Protocol if the Service Trigger contains a Remere Login biscProfileId. (When the BiscProfile contained in the bip property specifies a "remere" Service Protocol Id, then the CapisControl.invokeServiceAction API function will call the RemereLogin.performServiceOp function.)

Remere Login defines the following.

Remere Login specifies how the browser can contact the user's Login Manager and present the login options to the user. (By using the LoginManager API.)

(Remere Login is known as a declarative HTML login API.)

Goal Summary

The primary goals are:

See more details in the Design Goals.

No passwords

Passwords are insecure. They should not be given to websites, as storing passwords has proven to be too much for websites to do securely. Instead of passwords, browsers should send websites a single-use "Credential Proof" to prove a user's identity. (Note: This specification sends a Proof Of Identity, A.K.A. a UserId Assertion, to a website. This is is a combination of a "username" and multiple Credential Proof in a single JSON object.) Note that sending a Credential Proof requires that the browser be connected to some type of Login Manager where it can get the data from. (Because the needed data is much longer and more complicated than passwords are, and users should not be required to type it into a web form. i.e. Users must not be required to type the data into a web form. A Credential Proof is created from a Credential Source.)

Instead, users store the longer security keys in a Login Manager (a more advanced version of a Password Manager) and connect it to whatever browser they are using.

Supports digitally signing user data (i.e. form submissions)

The specification supports the digital signing of arbitrary data (i.e. form contents) by the user. This mechanism provides a general means for users to digitally sign contracts or other documents with credentials specific to an RP website. A digital signature allows the RP website to prove, internally or to other entities (the public, etc.), that the user authorized the data. This mechanism can be used to digitally sign documents, create signed statements and comments (prevents editing by a host platform. blog, twitter, etc.), perform verifiable organization voting, etc. (Note that for use outside the RP, the RP website must also have a way to prove that the Credential Verification Rules used to verify the signature were authorized by the user and active during the time when the signature was created.) (See Form Signing and RemereLogin.performServiceOp(biscProfileId, opId, callOptions) and CapisAPI.callOptions.signContents and RML OpId: "signData".)

Comparison to WebAuthn

The first several goals are the same as Webauthn. Do not require users to type anything, Do not use passwords, Use some type of Login Manager. Require browsers to connect to an external Login Manager. But Capis adds several other requirements. (1) Eliminate login forms on websites. (2) Allow the login button in browser chrome. (login integration into the browser chrome.) (3) A Login Manager can be remote, or a program installed on another device. (Users should not be required to buy a separate physical device to store passwords or be required to carry it around with them.) (4) Allow a remote connection to an online Login Manager. (5) Must not require javascript. (Although a Javascript browser API is *also* provided, for more advanced use cases.)

See further RML Comparison To Webauthn

Why prompt the user to enter their password, if the goal is to not have them type anything. Browsers should not be required to enable Javascript for websites. Therefore, the login API shoud not require Javascript.

Remere Login Overview Part 2

The Remere Login specification is designed to make the process of users signing into websites easier and more secure. In order to do this, it contains both new browser requirements, and new website requirements.

It is expected that the required browser functions will be implemented natively in browsers in the future. However, a browser extension may be created that provides some of the required functionality.

The Capis specification defines a trigger process, consisting of multiple steps, called the Capis Service Invocation Protocol. The Remere Login specification defines a specific User Authentication process, known as Remere User Authentication. The Remere specification defines a browser API, that gives browsers a common set of User Authentication functionality that websites can invoke to do the collection of the User Authentication credentials. This allows websites to use the new standard, instead of having to do it themselves. (i.e. Instead of a website being required to display a login form and ask the user to enter their username and password, the website can invoke the new browser API, and the browser will do it in a standard way. The browser will collect the "username and password", or equivalent, and deliver it to the website. The browser may collect it automatically from a password manager, without user intervention.) There is a similar browser API for when a user wants to "logout". Using this process lets browsers know the Remere Login Status of a website, if it is logged in or not. The browser can display a Login Status in the UI, etc. Also, because the process has distinct steps, it allows browser extensions to hook into the process at different locations to customize the process. (i.e. To obtain the credentials from a different source, etc.)

The Remere specification assumes that new commands and options will be presented to the user as part of the browser UI. (i.e. As a menu item displayed in the browser menu bar. Not limited to HTML elements in a web page.) The browser can have several different "login" menu items. (Perhaps displayed in a drop-down list.) The options would include (1) Display a Remere Login Status icon, indicating if the current page is logged in or not. (2) Display the current default "Passbook" (and the Login Manager that it is from). (The browser may have a setting to automatically use the default, unless the user does something to get the full login options.) (3) A list of browser commands. Including "login" and "logout" of the current web page, "logout of all" web pages, "change the default profile" that is currently being used, etc. (4) A list of what Login Managers are connected to the browser, and/or (5) options to connect to a new Login Manager.

This specification does the following, in order to automate the authentication process.

The website (or other entity) that wants to authenticate its users is referred to as the "Relying Party". (i.e. an "RP")

Specification Design Philosophy

This specification was designed to automate the User Authentication process. Its overriding design philosophy is to first streamline the existing sign-in process (remove special cases), and then automate it. Specifically, this includes:

Note that the design eliminates all of a user's custom interactions with RP websites, but it does not eliminate the user interactions with the browser. When the user clicks a special HTML anchor, the browser may pop-up a window and ask the user to make some selection. The benefit is, this user-interaction is isolated to a single party (the browser). This is much better than the user having custom interactions with every website.

Websites need users to login. This means they need proof of user identity and user presence. HOWEVER, websites should not implement their own solution to the problem. Instead, browsers should provide a standard API, and all websites should use it. Thus, instead of users being required to do data entry for EACH website, a user can prove their identity and presence ONCE, to the browser (really, to the Login Manager). The browser can then, for a limited time, be able to sign-in to multiple websites mostly automatically. (Requires a single user click. But no data entry.) Each website may have different requirements (usernames and passwords etc.), but the "Login Manager" has all of that information, and the browser has a standard way to send that data to websites. Once the Login Manager is unlocked, the browser can generate a "proof of identity" for any website that is contained in the Login Manager. And it can send the "proof of identity" to the website along with any other requirements.

Overview

Capis Specification brief overview

The following summarizes the Capis specification. (Also see Summary2.) Remere Login summary

Overview of the Authenticator

This specification requires that users store their User Logins (i.e. usernames and passwords, etc.) in a "User Authenticator". An Authenticator can be a separate physical device, or it can be software installed on a user's mobile phone, or it can be a remote service, accessed over the internet. An Authenticator must support at least one of the standard connection protocols, so that it can communicate with browsers. (i.e. via NFC, Bluetooth, WiFi, USB, or over the internet as a Web Service.) In this way, users can take their Authenticator with them, or access it remotely, and use it with any browser that supports this specification.

In order to login to websites, a user must "connect" their Authenticator to the browser once per browsing session, and prove their identity to the Authenticator. (Using a fingerprint, password, etc.) The act of connecting a browser to the user's Authenticator can be called "signing in to the browser". After connection, a user can login to websites with a single click. Without typing anything. The browser will send the Authenticator a user authentication request for the website, and the Authenticator will create a "proof-of-identity" in response. Then the browser will send the proof-of-identity to the website as part of a login RML Request.

Overview of the changes to HTML

This specification defines a few new HTML attributes to be added to existing HTML elements. These attributes can be used to create a ServiceGroup HTML Element and a few Service Trigger HTML Elements. (Trigger examples are the Anchor HTML Element, and Form HTML Elements. The Form is rarely used.) These attributes allow RPs to embed BiscProfile data within HTML markup. (i.e. Descriptions of Remote Services. User authentication is one such remote service.) RP websites should modify their HTML pages to add a ServiceGroup HTML Element, and then replace a login form with an Anchor HTML Element.

The new attributes are: rel="servicegroup" and the "servicegroup-config" attribute. The "servicegroup-config" attribute contains a BiscGroup. This is usually written as a single modified-for-HTML JSON object. RP websites can use this attribute to give the browser additional data or instructions. Such as user authentication information.

A Capis compliant HTML page MUST have a ServiceGroup HTML Element in it. The purpose is to allow the browser, in the future, to use the hidden HTML element to display the user authentication information in the browser chrome. (i.e. The RP login status and command buttons.) The items do not have to be visible in the HTML page at all. For example, the browser chrome can contain a "login" button, and a "logoutAll" button, etc.

The Service Trigger HTML Elements behave differently than normal. For example, if a Anchor HTML Element is clicked, browsers that understand this specification will perform the Capis Service Invocation Protocol. (i.e. The browser will perform the CapisControl.activateTrigger.) The browser will not use the "href" attribute of the Anchor HTML Elements. The "href" attribute is used exclusively as a "fallback" behavior. Only older browsers that do not understand Capis will use it. (i.e. If the browser does not understand the new attribute rel="servicetrigger".)

Example of the new Service Trigger HTML Elements in a page.
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup"
 servicegroup-config='{ "challengeTime": 1599876543210,
  "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK",
  "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"},
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
  "mediation": "required"}] }'/>
...
<a href="remere://example.com/remereService?op=login" rel="servicetrigger"
 trigger-config='{ "op":"login", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }'>Login</a>

The Bisc Site Document Overview

The RP must publish a special Bisc Site Document document that details the Remote Services that the RP offers. This is a JSON document that describes the RP's public services. In particular, it must include the User Authentication service, and its requirements. See Bisc Site Document Detail.

Capis Service Invocation Flow Overview

The Capis Service Invocation Flow exists so that it can be used by multiple services. It is not limited to User Authentication. (See Remere Login Flow overview for an example of User Authentication.)

In general, the act of making a Remote Service call has four parts. The Capis Service Invocation Protocol has the following steps.

more details

The Service Invocation API (the CapisControl.invokeServiceAction function) will search the Page Configuration for a BiscProfile that matches the biscProfileId. It will search through all the BiscGroup objects. (First the serviceProfileList, then the Bisc Site Document.)

The Trigger Configuration bip property contains the "biscProfileId" before the slash, and the opId after the slash. (The BiscProfile contains the Service Protocol Id in the biscProfile.protocolSpec.)

For example, if the Trigger Configuration is {"op":"login", "bip":"remere_1"}, then the biscProfileId is "remere_1" and the opId is "login". When the trigger is activated, the browser will look up the BiscProfile that has the id "remere_1". (In the Page Configuration.) The browser will then extract the Service Protocol Id in the BiscProfile (the protocolSpec), and lookup the associated protocol_handler.
In this case, (due to the naming convention of "remere_1"), the BiscProfile protocolSpec will likely specify the Service Protocol Id value "remere". The protocol_handler is the RemereLogin.performServiceOp API function. The browser will call the RemereLogin.performServiceOp API to start the "Remere Login flow".

Remere Login Flow Overview

See the "Remere Login Flow Detail" for more detail.

The short version.

The detailed version.

When a "user authentication" opId is started, the browser will try to communicate with the active Login Manager. If there is not an active connection to a Login Manager, then the browser will prompt the user to connect to (or login to) a Login Manager. A connection to a Login Manager can expire or otherwise become invalid. If the user has been inactive for some amount of time, or if the RP requests it, then the Login Manager can require that the user re-authenticate himself (to the Login Manager), before the Login Manager will generate the proof-of-identity. (This optional RP request is one of the primary actions, and is called "proveUserPresence".)

RML Comparison To Webauthn

The Remere Login specification defines a login process and HTML integration for the browser. An RP's Capis integration may use the WebAuthn specification as one of the supported login implementations. The differences between Remere Login and WebAuthn are:

Specification Design Goals

Primary Design Goals

The primary design goals are: The primary goals of this specification are:
  1. Automate user authentication. Allow users to login to websites with a single click.
  2. Users should be able to sign into websites with a few clicks. (No typing. No data entry.)
  3. Eliminate the need for users to remember multiple passwords.
  4. Allow users to "use any browser" and "take their password device, etc. with them".
  5. Standardize the use of better security practices in browsers and websites.
    i.e. Prevent websites from storing raw passwords, and thereby eliminate the possibility of passwords being compromised through website breaches.
  6. Prevent browsers from sending raw passwords to websites. Instead, it uses public keys or hashes. This prevents websites from storing raw passwords.
  1. Users must be able to store their login credentials in a "Login Manager" external to the browser. (A Login Manager can be an online service, or a physical device the user carries, etc.)
  2. Users must be able to connect to their Login Manager with any browser when doing sign-in.
  3. Browsers must be able to connect to an external "Login Manager". This should not require installing a browser extension.
  4. The RP websites must be able to inform browsers about its User Authentication requirements. Including any custom settings.
  5. Browsers must be able to get the User Authentication requirements for the RP website.
  6. Browsers must be able to create and send a proper "login request" to the RP website. Including the sign-in information required by the website. (Using the required format and protocol.)
  7. Browsers must know the "Remere Login Status" at each website. (This means that a login and logout RML Response MUST be sent from the RP website and parsed by the browser.)
  8. Browsers must be aware of each User Authentication RML Request, (i.e. login, logout, etc.) and each corresponding RML Response from the RP website.
  9. Browsers must provide a standard "login prompt" for RP websites to use.
  10. The "login prompt" should not be an HTML form. Login forms should be eliminated. (Could use a special HTML element, etc.)
  11. The "login prompt" must be specific and exclusive. The browser MUST not have to guess which HTML elements and/or forms are used for authentication. It must not have to guess what conditions will trigger the login prompt.
    If the "login prompt" is part of the HTML page, then there must be a standard way for an RP to mark which HTML elements it uses to trigger the login process. (i.e. the "login prompt".) (It must not be like the current way things are done, using a regular, unmarked, HTML form to submit the username and password.)
  12. Activation of the special "login prompt" must cause the browser's internal login function to execute.
  13. The "login prompt" should work without javascript. Therefore, it should probably be a special HTML element. Dedicated to doing login / User Authentication.
  14. Browsers should have a "login function" that causes a "login request" to be sent to the RP website.

Secondary Design Goals

Secondary goals are:
  1. Eliminate sign-in forms on websites. Replace them with links. (Websites should never prompt users to enter sign-in data.)
  2. Work without requiring any Javascript
  3. Support multiple "opId" values. (Such as "login", "logout", and "proveUserPresence")
  4. Support Multi-factor authentication
  5. Browsers should provide a standard way for websites to ask for confirmation of user presence. After sign-in. (i.e. To confirm the user is still there.)
  6. Browsers should provide a "global logout" button. An easy way for a user to "sign-out from the browser".
    One button that will cause the browser to logout from ALL websites that use the credentials of the Login Manager. The browser MUST send a "user has signed-out" notification to all websites that are logged in using the user's credentials.
  7. Be extensible.
About the Capis Service Invocation Protocol
  • The process must not require the use of javascript on RP websites.
  • The process must be customizable. So that RP websites can adjust the process with their own customizations. (different URIs. different protocols, different formats)
  • The process must be extensible. So that it can be automated and extended in the future.
  • An RP website must be able to "declare support" for the standard.
  • The process must have discrete "steps", so that the browser (and browser extensions) can "hook into" or customize the login process.
  • An RP must be able to have confidence that the browser (or some "User Authentication Device") has confirmed the presence of the user. Not just the presence of a device. (Confirm the user by some physical or mental characteristic. Such as having them enter a password into the browser window.)
  • It must be extremely easy for websites to implement. (Eliminate the need for custom scripting.)

User Authenticator detail

A User Authenticator provides cryptographic proof of a user's identity. That is, it creates a proof-of-identity for an RP. It creates this proof from the User Login's credentials. (i.e. The credential secrets. Like a password or private key, etc.)

A Login Manager is a container that stores all of a user's login credentials. (i.e. It stores all the usernames and "Credential Secrets" such as passwords, private keys, etc.) A "Login Manager" is an advanced form of a "Password Manager". It has a different name because it can store other types of login credentials besides passwords. (Such as public/private key pairs, etc.)

An Authenticator needs access to the user's Login credentials, such as passwords, and private keys, to create a proof-of-identity from them. In other words, an Authenticator *requires the use of* a LoginManager. It needs access to the credentials, but it doesn't need to store the credentials itself. It is an additional capability beyond that of a LoginManager. But this functionality is simple enough, that most Login Managers should not have a problem supporting it.

When looking at the LoginManager API, there are 3 required Authenticator functions. collectUserLogins, createUserLogin, createUserLoginProofForRp. (They usually accept the "rpClientData" argument.)

An Authenticator has a few required capabilities. Primarily, it can use cryptography to generate a "proof-of-identity" for an RP. It creates this proof from the User Login's credentials. (i.e. The credential secrets. Like a password or private key, etc.) The proof-of-identity is a type of cryptographic digital signature. It proves that the Authenticator knows the credential "secret", without revealing the secret to the RP.

Second, an Authenticator must support at least one of the standard connection protocols, so that a browser can communicate with it. (i.e. via NFC, Bluetooth, WiFi, USB, or over the internet as a Web Service.) Third, it must support a specific software API. This API allows a browser to ask it to create a proof-of-identity for an RP.

A "proof-of-identity" proves who the user is, without revealing the user's password. The "proof-of-identity" is given to the RP website as part of the login request. The proof-of-identity is cryptographically signed. It also includes a timestamp, and the "challenge" from the website. (A "challenge" is a "cryptographic nonce" value.) In this way, the website can verify that the proof was newly created, and that it uses the correct "challenge" value. (i.e. the one that the RP created.) Because of this, the proof-of-identity will only work for one website. (The one that created the "challenge" value.) Also, a previous proof-of-identity will not work. This specification uses a JSON Web Signature as the proof.

(An Authenticator can contain multiple "accounts", with each account storing the User Logins for a separate person. Although this condition is rare, it is supported.)

RP Requirements for Remere Login

In order to use the new login methods, RP websites must do the following.
  1. Publish a Bisc Site Document. (This details what user authentication the RP supports.)
  2. Set up a Service Endpoint. A URL to receive and process the "RML Requests" from browsers.
    (The endpoint is published in the Bisc Site Document.)
  3. Store Credential Verification Rules for users. (i.e. public keys, password hashes, etc.) An RP must be able to verify the types of user authentication that it lists in the Bisc Site Document.
  4. Create "fallback" pages for older browsers. Copy or move existing login forms, etc. (i.e. the login form, the password reset form, etc.)
  5. Include a ServiceGroup HTML Element.
  6. Change its HTML pages to include a few Service Trigger HTML Elements. (i.e. A ServiceGroup HTML Element and Anchor HTML Element.)
    One of these new attributes must be a "challenge" and contain a very long, unique integer value. (This is a cryptographic nonce value.)
  7. An RP MUST have distinct account ids and user ids, and map between the two. (This is common practice.)

    The mapping may be "one-to-one", "one-to-many" or "many-to-many". A mapping is necessary because, at the very least, a user's UserId can change. (A UserId can become invalidated, compromised, retired, etc.) A "one-to-many" mapping is recommended, as it enables more features. It allows the RP to support Account Sharing. (This allows a user to safely share their account with other people.)

See RP requirements detail.

Browser Requirements for Remere Login

It is anticipated that browsers will be updated to support these requirements natively. But there will also be javascript libraries that will enable it in older browsers.
  1. Able to recognize when one of the new Service Trigger HTML Elements is activated. (When one is clicked on, etc.)
  2. Able to perform the Capis Service Invocation Protocol. (When a Service Trigger HTML Element is activated.)
  3. Able to extract the Trigger Configuration and a BiscGroup. (From Service Trigger HTML Elements.)
  4. Able to retrieve the Bisc Site Document from the RP.
  5. Able to connect with a Login Manager. (i.e. a User Authenticator. An external device or remote service.)
  6. Able to query a Login Manager for a list of User Logins. (For the current website and appId.)
    See LoginManager.collectUserLogins(filterOptions, rapId) and performServiceOp(biscProfileId, "login", callOptions) examples.
  7. Able to show a pop up dialog to the user, that asks them to pick from a list of User Login items.
  8. Able to create a RML Request and encode the login values in it.
  9. Able to send the Service Request to the RP.
  10. Able to generate a QR code from the RP endpoint URL and nonce, and show that to the user. If the user asks for it. "https://domainName/path/file.json?ch=nA8rh3tfe83h37C9B2O5Zw4Yn2pV7M"
    Note: In order to allow out-of-band login, the server must be specially configured. It must index the sessions by the nonce value.
  11. For the Authenticator -- Ability to generate passwords or public keys, etc. for user credentials.
  12. For the Authenticator - Ability to generate a proof-of-identity.

Benefits

Benefits of this specification

It modifies the login process in the following ways.

Main points
Example of a special HTML anchor:
<a href="remere://example.com/remereService?op=login" rel="servicetrigger"
 trigger-config='{ "op":"login", "bip":"remere_1" }'>Login</a>

More Benefits 2

As corollaries, or additional support to the above, this specification also:

The Capis Service Invocation Protocol will cause the browser to retrieve the Bisc Site Document (via HTTPS), then display to the user a list of User Logins that match the Remote Service requirements. The user can choose the User Login of their choice, or choose to create a new login. New logins can be created automatically. (new, secure, public/private key pairs are generated.)

The browser will send the website an "Authentication Service Request". The request includes a login proof, and is signed by the appropriate private keys. The request is a JSON Web Signature (JWS). The JWS can also contain credential attestation, for any newly generated public keys / credentials. (If attestation is a requirement of the RP website.)

The list of newly created formats include:

Overview Old

This specification adds behavior to browsers and RPs (e.g. websites) to let users sign in with a few clicks. It eliminates manual sign-in forms on websites.

Specification Summary

This specification does the following:

  1. Defines the Capis Service Invocation Protocol.
  2. Defines the ServiceGroup HTML Element.
  3. Defines a few new Service Trigger HTML Elements for the Capis Service Invocation Protocol. These are used by an RP to augment a few HTML elements. These attributes do the following. 1. Mark the HTML elements that are used as triggers to do sign-in with an HTML tag. And 2. Contain a BiscGroup. (The HTML tag vastly simplifies the login process. The browser doesn't have to guess which HTML elements are used to do sign-in. i.e. Which forms submit a username and password, etc. It doesn't have to inspect form inputs or examine javascript for clues, etc.)
  4. It defines a standard way for an RP to declare what Remote Services it supports. The services are published in an "Bisc Site Document". The service definitions include the "Service Endpoints" and communication protocols used.
  5. It defines a standard format for the RML Requests that a browser sends to the RP. This includes a requested opId, and a "proof of identity", which includes a UserId and a set of user credentials. The credentials can be a mix of different types. (The ability to send multiple credentials, of different types, allows an RP to support Multi-Credential Authentication and multi-factor authentication.)
  6. It defines a standard Capis Service Invocation Protocol multi-step process for browsers to follow. It starts when a Service Trigger HTML Element is clicked on by the user.
  7. Remere Login. The API defines several functions, including "login", "logout", "proveUserPresence", and "setActiveCredentials" (i.e. "change password").
    This provides an easy, standard way for browser extensions, etc. to hook into the Capis Service Invocation Protocol. Thus, the user experience can be customized easily. It can modify or preempt certain actions, etc. For example, during user authentication, the browser can present additional options, such as allowing the user to connect to an "User Authentication Device" or to an online "Login Manager". It can use either of these sources to create proof of the user and their login credentials.
  8. It defines a standard way for an RP to declare a custom behavior for an HTML element. The Capis Trigger Behavior will cause the contained triggerConfig.op property to be performed. (The triggerConfig.op value should contain a opId that is one of the RML Operation List. i.e. "login", "logout", "proveUserPresence", etc.) This explicitly tells the browser what the purpose of the element is. (i.e. which opId to perform.) This allows the browser to add custom behavior based on the opId. (It may color anchors that have a "op":"login" and "bip":"remere_1" differently. etc.)
  9. It defines an optional Javascript API that browsers can implement.

Term Definitions

Relying Party (RP)
An entity that wants to authenticate a user. i.e. The system or service being logged into. For example, when a user logs into a website, the website is the relying party. (An RP "relies" on an authentication system to verify the identity of the user.)
Relying Party Identifier (rpId)
A unique identifier for a Relying Party entity. It is based on the RP's "domain name". Example: "login.example.com" It is not a URL, even though it may look like one. It MUST not include a scheme, port or username.
Multi-Credential Authentication
When an RP requires Proof of multiple credentials in order to authenticate a user. Each credential can be of any type. (i.e. password, private key signature, fingerprint, PIN, etc.) (See Multi-Credential detail.)
Multi-Factor Authentication
When an RP requires two or more "factors" to verify a user's identity. (i.e. CredentialProof of different types.) The three types of authentication factors are something you know, something you have, and something you are. Something you know can be something like a password or PIN. Something you have can be a mobile phone or a special USB key. And something you are can be something like your fingerprint or other biometric identifier. (See Multi-Factor detail.)
Source Application
The Application or Relying Party that a User Login was created to login to.
Source Application Identifier (sapId)
The unique identifier for a Source Application. (The Application or Relying Party that a User Login was created to login to.) A sapId may be a GUID, such as an application ID. (In Android or iOS, etc.) In a browser, the sapId is a Relying Party Identifier (rpId). (An rpId is a domain name, or something similar to a domain name.) In browsers, the default is to use the sapId of the current domain. This is often a subdomain, not the root domain. Example: "www.example.com" or "login.example.com". An RP can override the sapId to use (when creating a User Login) by setting the "biscProfile.sapIdSpec" property.
Source Application Identifier 2 (sapId)
The sapId is the id under which a Login Manager stores the User Logins for an RP, or organization. An RP tells the browser which Source Application to use (to login) by setting the "biscProfile.sapIdSpec" property. By default, a User Login is only usable by a web page from the SAME domain as the sapId. (i.e. A webpage at login.example.com cannot use a User Login for "www.example.com") However, this can be a problem with subdomains. However, a larger organization may set up multiple RPs to use the same sapId. (Known as SSO. Single Sign On.) Access to a sapId is validated, so that only an "authorized" RP can access User Logins that use that sapId.
By default, the sapId is created from the RP's origin. However, a Relying Party can override this behavior, and set the sapId in the Bisc Site Document or a BiscGroup. A sapId MAY include an optional path. This lets user accounts at an RP maintain their own client logins if desired. (See "biscProfile.sapIdSpec".)
Requesting Application Identifier (rapId)
The unique identifier for the Application or Relying Party that is performing a user authentication operation. (i.e. The Application that is attempting to login, or to create a new User Login.) The rapId is used by CAPIS as an access limiter. A Requesting Application may attempt to use or create User Logins that use a sapId different from its own rapId. CAPIS creates a request, which includes the rapId, and gives it to the Login Manager. The Login Manager may approve or deny the request, depending on the rapId.
Foreign RP
Any RP that is not creator of the User Login. (The UserId and the associated User Credentials). See allowedRpIdRules and allowedRapIdList.
User Identifier (A.K.A. UserId)
A string of characters that uniquely identifies a user to an RP. It is almost the same as a "username" (as in a "username and password"), except that it does not have to resemble a name. This is because it is generally not meant to be displayed to, or remembered by, users. It is often specified by the RP, not chosen by the user. (See UserLogin Creation Methods.) The two main types of UserId are Single-site UserId and Multi-site UserId. QIF is a format for how identifiers should be written. Also see RML Response assignedUserId.
Examples: "little_bo_peep12345", "p93w43m7", "qi:A:H:1:M8h2Dz0Wyv_lViQ4Nr0J"
Register an identifier with an RP
Having an RP associate a user with an identifier. This may be the same as User Login creation. Or the RP may change the UserId of the user. The RP "assigns" the identifier to the user, or allows the user to choose their own identifier. If the identifier is a Locked Id, then the RP must not allow it, unless the user can unlock the ID. Because that would allow someone who does not own the Multi-site UserId to create a login using the UserId. (This is a security risk). A "locked" ID is RESERVED. See UserId registration.
User Login (See LoginItem)
The data needed for a user to login to an RP. (i.e. To authenticate a user to an RP.) This generally consists of (1) The RP identifier or application identifier. (i.e. The Source Application, sapId.) (2) A UserId. (3) Some set of "secrets" known only to the user. (i.e. Credential Sources. Such as private keys or passwords.) (4) A set of "secret verification data", stored by the RP. (i.e. Credential Verification Rules. This provides a way for the RP to verify that the user has the secrets.) (Note: A "username and password" is a simple case of a User Login, where the password serves as both the "secret" and the "secret verification data".) Stored User Login data may also contain some additional information for administration purposes. (Such as a lipId.) See User Login Detail.
LoginItem
Any of the items inside a Login Manager, that are stored in relation to a User Login. Typically these are the stored User Login data, and Passbooks. A Login Manager and RP may contain multiple LoginItems, with the two storing slightly different information. The RP does not need to store the RP id (for itself). The RP does need to store the "user secret verification data" (i.e. Credential Verification Rules).
LoginItem Permanent ID (i.e. a "lipId")
A unique identifier assigned to each LoginItem in a Login Manager. Example: "u34". The lipId does not change if the UserId is changed, or if the User Login is moved to a different Passbook. Both User Logins and Passbooks have a lipId.
Leaky User Login
A User Login that reveals some of its credential source secrets through bad Credential Verification Rules. (i.e. It has at least one "leaky" Credential Verification Rule.) A "username and password" is an example. The RP typically stores the password in order to validate login attempts. However, having the RP store the (unencrypted) password is unsafe. Anyone with access to the RP can copy the secret and can impersonate the user.
Single-site User Identifier
A type of UserId that only identifies a user at a single RP. At a different RP, the same UserId can be registered to a different user. It is the opposite of a Locked Id. A Single-site UserId can be written in QIF format using one of the "A:A:" types.
Examples: "little_bo_peep12345" or "qi:A:A:2:M4j-q:XSAErLq"
Multi-site User Identifier
A type of UserId that can identify a single user to multiple RP. (i.e. To all RP.) Each distinct type of Multi-site UserId must have an associated LIAV Method. The RPs use the method to determine if a connected user is authorized to use a claimed identifier. (i.e. A Multi-site UserId is a type of Locked Id.) A common example is an email address. (i.e. A Federated UserId.) It identifies a resource at an organization. And the organization provides a service to the resource.
The identifier contains or references some sort of proof, or lock, etc. that can only be unlocked by the creator or authorized user. Multi-site UserIds are the opposite of a Single-site User Identifier. They are "foreign" to every RP. (Other than its Backer. If it has one.) See Multi-Site UserId detail for more information. (1) Self-contained and (2) Federated UserId.
Examples: "someone@example.com" and "qi:A:F1:2:ACMA_org:M4j-q:XSAErLq"
Locked Identifier (AKA Verified Access Identifier)
A type of identifier that references an "Identifier Lock". The lock is a type of test, usually a type of "input verification method", known as a LIAV Method. The lock provides a way for an entity (i.e. a user or device) to prove (to other parties) that it is authorized to use the identifier. The Identifier Lock can be Self-contained, Certified or Hosted by an organization. (i.e. The lock is hosted on the internet.) Note that a Locked Identifier is just a text string. Despite the name "Locked Identifier", there is no technical enforcement that third parties require proof from the Identifier Lock.

An email address is an example of a Locked Identifier. (i.e. user@example.com) In this case, the "unlock method" is sending email. (The email is addressed to the identifier, and sent to the identifier host, at the specified domain.) A user can prove they have access to the identifier by reading the email that was sent. Note that an email address is not an optimal identifier format, because it does not contain text that directly specifies the "Identifier Lock Id". (It does not include the word "email", etc.) Instead, the Identifier Lock Id is determined by the format the identifier is in.

A Locked Id MUST be written in a standardized format, so that it can be recognized as a Locked Id. (And so that the "Identifier Lock Id" can be determined.) The Locked Id SHOULD contain text that specifies the lock (i.e. the Identifier Lock Id). However, the lock may be specified in some other way.

A Locked Id can also specify a namespace. A namepace is used to specify a standard the Locked Id follows. A standard can define a particular URL to use with the Locked Identifier. For example, the URL to use at the contained domain name, and any required arguments. Example "A:webfinger:1:carol@example.com" (The "A" is the namespace. The "webfinger:1" is the Identifier Lock Id. The "example.com" is the Backer Id) The "A" namespace defines url="example.com/.well-known/webfinger?resource=acct%3Acarol%40example.com" as the URL. The URL is used to retrieve a document that contains the LIAV Method.

For example, an email address cannot specify a Identifier Lock Id. So, all email addresses that are used as a Locked Identifier use the same Identifier Lock Id. (i.e. The Unlock Method is sending email.) However, it is possible to use a Locked Identifier that CONTAINS an email address. Example "goodlock:46:mary4092@example.com". (The "46" specifies an "email" Identifier Lock Id.)

Systems SHOULD not allow a Locked ID to be used unless the user can prove it can unlock the ID.

Correct use of Locked Ids require compliant behavior from systems. For example, an RP must not register a Locked Id to any of its users, unless the user can prove that they can unlock the ID. Because of this requirement, Locked Ids MUST be distinguishable from other types of identifier used by the system, and the LIAV Method used by the Locked Id must be discernible. The system must be able to (1) tell if an identifier is a "Locked Identifier", and (2) verify if a user can unlock it. Using the QIF format is one way to meet these requirements. Locked Identifiers are either Self-contained or Hosted by an organization. If a Locked Identifier is used to identify a single user to multiple RP, it is a Multi-site UserId.

The User Verification process

A "user verifier" (i.e. an RP or other third-party, etc.) must be able to verify if an entity (i.e. a user) is authorized to use the locked identifier. To do this, the user must create an "identifier authorization request" document. The document is then tested that it will "unlock the ID", by calling the LIAV Method and passing the request document in as an argument. If the document passes the test, then the user is authorized to use the identifier.

The request document may be used in one of a few ways. (1) It can be given to the "user verifier", and the verifier then calls the LIAV Method. Or, (2) the user may call the LIAV Method and then give the result to the user verifier. This last case is more involved, as the result must be cryptographically signed, or encrypted, etc. in order to prove to the user verifier that it is a result from the LIAV Method. This method must be used if the request document contains a secret. (Such as a password.)

If the Locked Identifier is hosted, then the host must provide this "unlock verification". This generally is done in one of four ways. First, the host can perform the verification itself. It accepts some sort of "documents or user supplied information", such as a password, and returns some sort of success or error value. Second, the host can receive a secret message. If the user can access the secret, then they have proved access. Third, the verifier can be given the "verification method". Then the verifier can verify the documents itself. The "verification method" can be some sort of algorithm or public keys, etc. Fourth, the verifier can be given the "encryption key". The verifier can then encrypt a secret message. If the user can decrypt the message, then they have proved access. The host can limit any of these methods to only certain verifiers. If the identifier is used as a Federated UserId, then this service may be known as an Identity Provider. Or the host can provide something different.

Examples:
  • "goodlock:45:mary4092" // "goodlock" specifies the namespace, and/or the Backer organization. "45" specifies the Identifier Lock Id.
  • "qi:A:H:1:M8h2Dz0Wyv_lViQ4Nr0TN5BfJ" // Type "A:H:1" contains a base64url encoded JWK public key.
  • "qi:A:F2:1:example.com:M4j-q" // Type "A:F2:1" contains a domain name and a base64url userNum.
Identifier Lock
A set of requirements or an LIAV Method that is referenced within a Locked Identifier. This functions as a type of "user authorization test". Only users that are authorized to use the identifier can unlock it.

In general, a lock can be designed for either "private access" or "public verification". If it is used for "access", then unlocking the lock can "grant access" to a restricted resource. This can be secret information, etc. If the lock is used for "public verification", then it is actually for use by an unknown entity (i.e. a third-party, or "the public") to verify if a user can unlock the identifier. A Locked Id is used for public verification. Third parties can challenge a user, and then verify that the Identifier Unlock Input (some documents provided by the user) contains the challenge value, and will unlock the identifier. The Identifier Unlock Input is verified with the LIAV Method. If the Identifier Unlock Input satisfies the test, then the user is authorized to use the identifier.

Each Identifier Lock is specified by a unique Identifier Lock Id. Each Identifier Lock Id has an associated LIAV Method.

Some other notes. A lock algorithm may include a reference to an online location, a document or a service, etc. (e.g. A Federated UserId commonly requires a Backer VM.) The document can contain public keys, or the service can issue a certificate, etc. that can be used to verify the user. When a locked identifier is used as a public identifier, an RP must not register a Locked Id to any of its users, unless the user can unlock the ID.

See Identifier Use Requirements.
Identifier Lock Id
A text string that identifies the Identifier Lock used in a Locked Id. The Lock Id also identifies the Unlock Method. Note that multiple "Lock Id" values may denote the same Unlock Method. Also note that the Unlock Method may impose additional requirements depending on the contents of the Identifier (i.e. On the payload contents). (For these cases, the LIAV Method will assemble or otherwise determine the actual lock requirements.)
Examples:
Identifier Unlock Input
A document, etc. provided by the user, that is used to unlock a Locked Id. It is usually given by a user to a third party (i.e. an RP) in order to authenticate the user. The third party will verify that the input will unlock the Locked Identifier. It usually contains a challenge value, provided by the third party.
LIAV Method (Unlock Method)
An algorithm or protocol, etc. that can verify if an entity (i.e. a user, device, etc.) has authorized access to an identifier. In general, it will verify if an "identifier authorization request" document (e.g. text entered by a user, etc.) will "unlock" the locked ID. (i.e. If it is a valid use code, authorization, etc. for the Locked Id.) (i.e. If it will unlock the Locked Id.) The method is known as a "LIAV Method". Each Identifier Lock will have an associated LIAV Method. It is a way of proving if the user meets the lock requirements that are referenced from within the identifier. This will verify if the user is authorized to use the identifier.

The entity performing the algorithm is known as the "unlock verifier". It may be an RP, a third party, an "authorization verifier", etc.

The LIAV Method usually verifies if some documents created by the user are valid, if they pass the lock's test or meet its requirements. The documents should also pass the test presented by the verifier. (An alternate method is that the user provide a secret, such as a password, to the LIAV Method to prove their authorization. However, this method may reveal the secret to the verifier.)

In order to work, the verifier generally requires two things. (1) The LIAV Method for the Identifier Lock Id. (2) All documents or services required by the LIAV Method. Note that the LIAV Method of the identifier is generally determined by the Identifier Lock Id. The requirement to determine the Identifier Lock Id may require that the identifier be in a standard, recognizable format. The LIAV Method is commonly defined by the "standards organization" that defined the Identifier Lock Id.

In some cases the LIAV Method may require extra documents. Such as for a Federated UserId. In this case, the verifier may need to verify that the backer documents were issued by the backer. So it may need to get the public keys for the Backer via a Backer VM.

The Locked Identifier should include a Identifier Lock Id. The id determines how the Identifier Lock is put together, and what pieces it is composed of. Some pieces can be: (1) the Identifier Lock Id, (2) the LIAV Method, and (3) the "triggerId". The triggerId allows the same lock to be used by multiple users. The triggerId specifies the user of the lock. It is one of the arguments given to the LIAV Method.

In the QIF format, the combination of the "namespace", "idClass" and "subClass" specifies the "type" of the Locked Identifier. Use this to determine the LIAV Method. (Ex: "A:F1:1" specifies a Federated UV Method.)

Examples:
  • "qi:A:H:1:M8h2Dz0Wyv_lViQ4Nr0TN5BfJ" // Type "A:H:1" contains a base64url encoded JWK public key.
  • "qi:A:F1:1:ACMA_org:M4j-q" // Type "A:F1:1" contains a type-C PermanentBackerId and a base64url userNum.
  • "qi:A:F2:1:example.com:M4j-q" // Type "A:F2:1" contains a domain name and a base64url userNum.
Identifier Unlock Proof
A document (obtained from a service, etc.) that contains proof that an input document (i.e. text entered by a user, etc.) is a valid key for the Locked Id. (i.e. That the input document will "unlock" the Locked Id.) That is, the input document meets the requirements of the identifier. This is also known as "Unlocking the Identifier". The proof must be verifiable to a third party. The proof is obtained by calling the LIAV Method for the Locked Id and passing the input document in as an argument. This proves that the input document passes the "user authorization test" of the Locked Id, and the creator of the input document is therefore authorized to use the identifier.
Self-contained Locked Identifier
A type of Locked Id that contains its lock inside itself, internal to the identifier. For example, the lock can be an encoded public key. In this case, the public key can be used as the "verification method", so the verifier can check itself that the user can unlock the ID. These types of Locked Id do not have a "host". They are written in QIF format using one of the "A:H:" types.
Example: "qi:A:H:1:M8h2Dz0Wyv_lViQ4Nr0TN5BfJ" // Type "A:H:1" contains a base64url encoded JWK public key.
Certified Locked Identifier
A Locked Identifier that is unlocked by a certificate, provided by a Backer. Traditionally, the Backer will publish a set of public keys. It can also create an Identity Certificate based on a user request. The certificate is used as the Identifier Unlock Proof and is given to multiple RP. An RP can use the public keys to verify the certificate was created by the Backer.
Hosted Locked Identifier
A type of Locked Id where the Identifier Lock is available on the internet. It relies on a Host Organization to implement (i.e. to host) the Identifier Lock. The Host Organization may be a single host or a network or federation. It may consist of a single Identity Provider or a network of them. (For example, a Federated UserId uses a Host Organization that is a federation.) A Hosted Locked Identifier does NOT have to contain the Host Id internally. The Host Id may be determined separately. If the Locked Identifier contains the host ID internally, then it is a Backed Identifier.

Because the Identifier Lock is hosted, the identifier must somehow be associated with the host. However, the identifier does not necessarily have to contain the host id internally. The host id may be acquired indirectly. For example, the identification system (the RP being logged into) may store the host ID for a user ID separate from the Locked Id. Or the user may provide the host Id during login. Or the host Id may be a federation of identity providers, etc. If the identifier contains the host ID itself, then it is a Backed Identifier. (In this case, the "host id" is the Backer Organization.)

For example: Some websites allow a user to "Login using Google" or "Login using Facebook". These options use a Hosted Locked Identifier where the identifier does NOT contain the Host ID. The Host is either Google or Facebook. Those organizations host the Identifier Lock. But the userId can be an unrelated email address. (The email address does not have to contain either the "facebook.com" or "gmail.com" string, etc.)

A Backed Locked Identifier that is used as a user identifier is a Federated UserId. An email address is an example, it references a "user account" at a domain name (i.e. the host). The "lock" or test is if the user can receive email at the address.
Examples of Locked Identifiers. When in QIF format, it should probably use a type similar to "A:F1:1" or "A:F2:1".
  • "little_bo_peep12345" // An identifier without a host id. (Not recommended as a Locked Identifier.)
  • "user123@example.com" // An email address. The domain name is the host id.
  • "qi:A:F1:1:ACMA_org:M4j-q" // Type "A:F1:1" contains a type-C PermanentBackerId and a base64url userNum.
  • "qi:A:F2:1:example.com:M4j-q" // Type "A:F2:1" contains a domain name and a base64url userNum.
Backed Identifier
An identifier issued by an organization, that identifies an item, etc, that the organization recognizes. The identifier contains at least two things, the Backer ID of the Backer Organization that issued it, and a "registration id" of the item or event, etc. The "registration id" identifies a particular resource, account, user, or transaction, etc. at the Backer Organization. An email address is an example of a Backed Identifier.
Example: "user123@example.com" // An email address is a Backed Identifier, where the domain name is the Backer Id.
A "Provable" Backed Identifier is a Backed Identifier for which there exists some standardized way to prove an entity is authorized by the Backer Organization to access the identifier. (i.e. There exists a standardized Identifier Authorization Service for it.) A Provable Backed Identifier is a type of Locked Id. An email address is an example of a Provable Backed Identifier.
Backer Organization
An organization that creates Backed Identifiers. Every Backer Organization is identified by a unique ID, called a Backer ID. Every Backed Identifier contains the ID of the backer organization that created it. A domain name is an example of a Backer ID. An email address is an example of a Backed Identifier. (someone@example.com)
Backer Document Verification Method
A document or service provided by a Backer or a delegated third-party, such as a Identity Provider, that can be used to verify documents were issued by the Backer. The document or service may also provide public keys, which can be used to verify signed documents were issued by the Backer.
Backer Id
The identifier of a Backer Organization, which creates Backed Identifiers. Every Backed Identifier contains the ID of the backer organization that created it. A domain name is an example of a Backer ID.
Example: "user123@example.com" // An email address is a Backed Identifier, where the domain name is the Backer Id.
A Backer ID must be assigned by a standard system, to ensure that all Backer Ids are unique. A Backer ID may be a domain name or something similar. It may be a permanent PermanentBackerId, assigned by a different standard. All Backed Identifiers issued by a Backer must be in a standard format. This is so that RPs that receive one of the Backed Identifiers, can recognize the item as a Backed Identifier, and extract the Backer ID from it.
Permanent Backer Id
A permanent identifier for a Backer Organization. It must be assigned by some sort of standards organization. It is a way to create permanent Backed Identifiers. (These Backed Identifier do not use a domain name as the Backer Id. Therefore, they do not have the problems of domain names. Domain names are temporary.)
Example: "user123@@ACMA_org" // A Permanent Backed Identifier. Not a regular email address.
Example: The standards organization that controls namespace-C defines its own list of Permanent Backer Ids. These are called type-C Permanent Backer Ids. Example: "qi:A:F1:1:ACMA_org:M4j-q"
The standards organization should publish a single document that contains all the Backer Ids that it has assigned (along with the Identifier Authorization Service associated with each Backer Id). Each entry in the document (the Backer Id and associated service) is permanent and cannot be changed. However, new entries can be added. (Note: The Identifier Authorization Service is the same thing as the Federated UV Method for each Backer Id.)
Identifier Authorization Service
A service that determines if a requestor is authorized by a Backer Organization to use a Backed Identifier. Data from the service (typically the response) is given to a third party as proof that the requestor is authorized by the Backer Organization to use the Backed Identifier. The service is an implementation of an LIAV Method, implemented by the Backer Organization.
For example, the service may receive an "identifier authorization request" document, and issue a response containing if the request was valid. In this case, the request must contain an appropriate Backed Identifier and the required proof for it. The service response must contain proof (digital signature, etc.) of authorization by the Backer Organization that issued the identifier.
Note that email verification is another example of this service. A Backed Identifier authorization verifier (e.g. An identity verifier) can send email to the Backed Identifier (i.e. to the email address), containing a secret code. The "requestor" reads the secret code from the email and submits it to the verifier, thereby verifying that they have access to the Backed Identifier.
Identifier Authorization Provider
An entity that provides the Identifier Authorization Service for a Backed Identifier. The service receives an "identifier authorization request" document, and determines if the document is valid. (The request must contain an appropriate Backed Identifier and the required proof for it.) The response from the service is typically given to a third party as proof that the requestor is authorized by the Backer to use the identifier.
The provider must be authorized by the Backer Organization. The Backer Organization may authorize multiple providers, or it may provide the authorization service itself, in which case it is the provider. The identifier may be for an account, resource, transaction, user, or group, etc. An Identity Provider is a special case of the more general Identifier Authorization Provider.
Identifier Authorization Verifier
A service or algorithm that verifies if a user, etc. is authorized by a Backer Organization to use a Backed Identifier. For example: when a user tries to sign up (register) at an RP using a Multi-site UserId, then an RP must verify if the user is authorized by the Backer Organization to use the identifier. (Note: an Authorization Verifier will only work on a Backed Identifier. An identity verifier is more general than an Authorization Verifier. It will work on other types of identifiers. And proof-of-identity.)
Federated User Identifier
A unique identifier, used to represent an external entity, or "user". All Federated User Identifiers have a "provider". The "Federated Identity Provider" is a single organization that is responsible for authenticating a user to members of the federation. Therefore, each "Federated User Identifier" must be "linked" or associated with its "provider".

A Federated User Identifier is a type of Locked Id that uses an Identity Provider to implement its lock. (i.e. To meet the Locked Id requirements.) The identifier may or may not be a type of Backed Identifier. (i.e. The identifier may or may not contain a provider ID.) The provider may be provided separately. If the Federated User Identifier contains a unique ID specifying the provider, then it is a type of Backed Identifier. Where the "provider" is the Backer Organization. The Identity Provider may be the same as the Backer Organization.

In order to work, the verifier generally requires two things. (1) The LIAV Method for the Identifier Lock Id. (i.e. The Federated UV Method.) (2) All documents or services required by the LIAV Method. Note that the LIAV Method of the identifier is generally determined by the Identifier Lock Id. The requirement to determine the Identifier Lock Id may require that the identifier be in a standard, recognizable format. The LIAV Method is commonly defined by the "standards organization" that defined the Identifier Lock Id.

In some cases the LIAV Method may require extra documents. Such as for a Federated UserId. In this case, the verifier may need to verify that the backer documents were issued by the backer. So it may need to get the public keys for the Backer via a Backer VM. See Federated UserId detail.

The Locked Identifier should include a Identifier Lock Id. The id determines how the Identifier Lock is put together, and what pieces it is composed of. Some pieces can be: (1) the Identifier Lock Id, (2) the LIAV Method, and (3) the "triggerId". The triggerId allows the same lock to be used by multiple users. The triggerId specifies the user of the lock. It is one of the arguments given to the LIAV Method. The triggerId is the "registration id" specifying the user to the provider. (4) The provider.

In the QIF format, the combination of the "namespace", "idClass" and "subClass" specifies the "type" of the Locked Identifier. Use this to determine the LIAV Method. (Ex: "A:F1:1" specifies a Federated UV Method.)

Examples:
  • "user123@example.com" // An email address. The domain name is the host id.
  • "qi:A:F1:1:ACMA_org:M4j-q" // Type "A:F1:1" contains a type-C PermanentBackerId and a base64url userNum.
  • "qi:A:F2:1:example.com:M4j-q" // Type "A:F2:1" contains a domain name and a base64url userNum.
Federated UserId detail
A Federated User Id is a type of Locked Id that uses a Backer Organization to implement its lock. It is a type of Backed Identifier.

In order to work, the verifier generally requires three things. (1) The Identifier Lock Id. (2) The LIAV Method for the Identifier Lock Id. (i.e. The Federated UV Method.) (3) All documents or services required by the LIAV Method. The requirement to determine the Identifier Lock Id may require that the identifier be in a standard, recognizable format. The LIAV Method is commonly defined by the "standards organization" that defined the Identifier Lock Id. In some cases the LIAV Method may require extra documents. Such as for a Federated UserId. In this case, the verifier may need to verify that the backer documents were issued by the backer. So it may need to get the public keys for the Backer via a Backer VM. See Federated UserId detail.

The Federated UV Method implements the LIAV Method required by a Locked Id. It is the standard way for the RP to verify if the user currently connected to it is actually actually authorized to use the claimed UserId.

A Federated UV Method commonly involves validating documents issued by a third party. The party is either the Backer, or an Identity Provider working for the Backer, etc. (The document may be some sort of UserId certificate, etc.) Therefore, a Federated UV Method commonly requires the use of a Backer VM to validate the documents. The Backer VM must be "authorized" by the Backer but it may be provided by a separate entity. For example, a combination User Authentication Service may provide user verification for Federated UserIds from several different Backers.

In order to use the Backer VM, it must be "findable" by all RPs. All RPs must know the URL and any other information needed to use the Backer VM. Typically the method is published in one of three ways. (1) The Backer domain name publishes the information. (2) The standards organization for the type of UserId publishes the information. (3) The UserId type and method are well known. (e.g. Like an email address.)

All three options require the UserIds of that type to be in a recognizable format. The UserIds must either contain an explicit "type ID" for the type of Federated UserId they are, or they must be in a format where their "type ID" can be inferred. (i.e. An email address format will cause the email address "type ID" to be used. etc.) The QIF format makes this easy as it contains an explicit "type ID" for the UserId. In the QIF format, the combination of the "namespace", "idClass" and "subClass" specify the Federated UV Method. (Ex: "A:F1:1")

In order to login to an RP using a Federated User Id, a few things are needed. First, the RP must support that type of UserId.

During a login attempt, an RP will extract the "type ID" and the "Backer Id" from inside a Federated UserId. (Note that the "type ID" may be inferred from the format of the UserId. For example, an email address format will use an email address "type ID".) Then the RP must execute the Federated UV Method for the type ID, and have it validate the documents provided by the user during the login attempt. The "UV Method" algorithm may have a step that requires using the Backer VM for the Backer of the ID. If this is required, then the Federated UV Method will specify how the Backer VM must be "found".

For example, an email address is a type of Federated UserId, but it may not actually "work correctly". In more detail, the Federated UV Method to use for an email address EXISTS, it directs a special email be sent to the user. However, this may not be desirable. Sending an email to the address may not work correctly, and it also requires user interaction. (The user must click on a link in their email.) There is no standard way for an RP to find what Backer VM the domain name in the email address supports. (1) Not all domain names are listed in a standard (global) index of User Authentication Services. And (2) there is no standard way for an RP to query the domain name in the email address to find what Backer VM it supports. (i.e. There is no standard url for either the Backer VM method, or to query the domain for the Backer VM url.)

Any website may turn its user accounts into Federated UserIds. It only needs to provide (and publish) a Backer VM that RPs can use to prove if a user is registered at the website. (i.e. owns a UserId at the website.)

If RPs allow Federated UserIds to login, it is recommended that they ALSO require Credential Verification Rules (such as passwords or public keys) IN ADDITION TO the proof from the Federated UserId's Federated UV Method. This prevents existing accounts at RPs from being hijacked if a Federated UserId is compromised. Only during user signup (i.e. account creation at an RP) SHOULD the proof from the Federated UV Method be used by itself. This is used to ensure that the requested Federated UserId is actually owned by the new user.

Typically, a Federated UserId is written in QIF format, as the QIF "type" will clearly denote how the Federated UV Method issues identity proof.

Federated Unlock Verification Method
An algorithm by which an RP can verify if a user has unlocked a Federated UserId. That is, if the user meets the lock requirements that are referenced from within the identifier. The method usually verifies if some documents presented by the user are valid. (This method is a Federated UserId implementation of the LIAV Method.)

The Federated LIAV Method always involves a third party, or documents from a third party. (i.e. The Backer, or an Identity Provider, etc.) (Maybe the IdP works for all the UserIds that use a certain Backer, etc.) The Method may be some sort of "unlockable access" or UserId certificate, etc.

The user typically must know some sort of "secret" belonging to the UserId. (A password, cryptographic signature, etc.) With a Federated UserId, the user does not submit the proof to the RP. Instead, he submits it, and the claimed UserId, to a third party. The Backer, Identifier Authorization Provider or an Identity Provider that works for the type of UserId, etc. The service will examine the proof and, if valid, will create some kind of document that states that the user is valid. This document is typically some kind of digitally signed statement, such as a UserId certificate. The document is a part of the proof of identity. (It may consist of other documents as well.) The document is delivered to the browser, which sends it to the RP. The RP then has to validate the document.

The RP must trust the third-party. Or it will not matter what documents the RP receives from the third-party.

Typically, a service will only support a very limited set of identifiers. (For example, identifiers that contain the "Backer Id" of only one or two particular Backers.)

In order for RP to support Federated UserId, the RP must be able to execute the Federated UV Method for that type of UserId. Typically the method requires a Backer VM. The Backer VM is published in one of three ways. (1) The Backer domain name hosts a standard document or lookup service. (2) A standards organization published the standard document or lookup service. Or (3) The account type is well known. (e.g. Like an email address.) All three options require the "type" of the Federated UserId. The UserId must either contain an explicit "type ID" for the type of Federated UserId it is, or it must be in a format where the "type ID" can be inferred. (e.g. Like an email address.)

In the QIF format, the combination of the "namespace", "idClass" and "subClass" specifies what LIAV Method to use. This specifies the Federated UV Method. (Ex: "A:F1:1")

Another way of getting the type is if the Backer Id is written in a format of a PermanentBackerId Standards Organization.

timestamp-identifier
A combination of a timestamp and a small integer, both encoded in base64url. Together, it provides a unique identifier, even if there are multiple identifiers created in the same millisecond. It is composed of a Unix timestamp integer, encoded in base64url, and a small integer, also encoded in base64url. The integer is likely a counter of the number of that type of identifier, that were previously created in the same millisecond.
Example: "qi:A:F2:2:example.com:M4j-q:XSAErLq" // Type "A:F2:2" contains a domain name, a base64url userNum, and a timestamp-id.
The base64url string "M4j-q" = (integer) 216,154,026
The base64url string "XSAErLq" = (integer) 1599876543210 = The number of milliseconds since Jan 1, 1970. Compare to challengeTime.
Quence Identifier Format (QIF)
A specification defining a format for how a universal identifier should be written. It makes identifiers that are universally unique, and are therefore usable at multiple RPs. This includes user identifiers (a UserId), and Locked Ids. It also includes permanent user identifiers. It also includes a way to specify Single-site User Identifiers, etc.

It adds meta-information to identifiers. It requires every conforming identifier to start with a "format-prefix" followed by "type information". The "type information" specifies what "standard" the identifier follows, what payload format the identifier uses, what Identifier Lock Id the ID uses, and what LIAV Method RPs should use to verify it.

The format is composed of five sections, separated by colon characters. "qi:NID:idClass:subClass:payload". The sections are format-prefix, namespace_id, idClass, subClass and payload. (Note that the payload MAY contain additional colon characters.) The namespace_id specifies the standard that the identifier follows. (i.e. the standards organization) Each namespace defines its own types. (The types are otherwise known as "rules" and "formats".) The idClass and subClass specify the Identifier Lock Id that the Id uses. (And it also specifies the LIAV Method used by the Identifier Lock.) The combination of the namespace_id, idClass and subClass specify the Identifier Lock Id. The subClass specifies the "class" of identifier that the Backer Organization created. It can be used to specify the rules that the payload contents should follow, etc. This includes the order and encoding of any items in the payload.

The combination of the namespace_id, idClass and subClass specifies what LIAV Method should be used. (Ex: "A:F1:1") For example, the "A:F1:1" type specifies a Federated UserId type and a particular Federated UV Method to use, and the method specifies the Backer VM to use. The format allows various characteristics of the identifier to be determined. The format allows RPs to determine what Identifier Use Requirements each identifier requires.

"NID" stands for "namespace identifier". The namespace_id may include only alphanumeric, underscore and hyphen characters. It has a minimum length of 1 character.

When users want to use their own UserId value (create a login or setUserId. [registerUserLogin, setUserId]), the RP needs to easily determine the type of the UserId, and if it can perform the required operations. (e.g. An RP must not register a Locked Id to any of its users, unless the user can unlock the ID.)

There are three main categories of UserId. "Single-site", "Self-contained", "Federated UserId".

The "A:A:" type specifies a Single-site UserId, while all the other types specify a Multi-site UserId. This special type allows a single database, etc. to contain both Single-site UserIds and Locked Ids.

Examples:
  • "qi:A:A:1:M4j-q" // Type "A:A:1" contains a base64url userNum.
  • "qi:A:A:2:M4j-q:XSAErLq" // Type "A:A:2" contains a base64url timestamp-id.
  • "qi:A:A:3:1234567890" // Type "A:A:3" contains a decimal integer.
  • "qi:A:A:9:little_bo_peep12345" // Type "A:A:9" denotes a "basic character string".
  • "qi:A:H:1:M8h2Dz0Wyv_lViQ4Nr0TN5BfJ" // Type "A:H:1" contains a base64url encoded JWK public key.
  • "qi:A:H:2:K8h3_TfXr6ZtLq7d1m8k" // Type "A:H:2" contains a base64url encoded COSE_Key public key.
  • "qi:A:H:3:P83_f82hdgT6B9NqL0Dz" // Type "A:H:3" contains a base64url encoded SHA-256 hash of the user's id.
  • "qi:A:F1:1:ACMA_org:M4j-q" // Type "A:F1:1" contains a type-C PermanentBackerId and a base64url userNum.
  • "qi:A:F1:2:ACMA_org:M4j-q:XSAErLq" // Type "A:F1:2" contains a type-C PermanentBackerId, a base64url userNum and a timestamp-id.
  • "qi:A:F2:1:example.com:M4j-q" // Type "A:F2:1" contains a domain name and a base64url userNum.
  • "qi:A:F2:2:example.com:M4j-q:XSAErLq" // Type "A:F2:2" contains a domain name, a base64url userNum, and a timestamp-id.
  • "qi:A:F2:3:example.com:M4j-q" // Type "A:F2:3" uses "ua protocol F3". It is authenticated via a different protocol than "A:F2:1".
  • "qi:A:email:1:joe@example.com" // Type "A:email:1". Payload is an email address.
  • "qi:A:webfinger:1:joe:example.com" // Type "A:webfinger:1". Payload is a user account and domain name.
  • "qi:A:IndieAuth:1:example.com/asmith" // Type "A:IndieAuth:1". Payload is a domain name and page.
  • "qi:A:A:4:f987b543" // Type "A:A:4" contains a hexadecimal integer.
  • "qi:A:F1:4:ACMA_org:f987b543" // Type "A:F:4" contains a hexadecimal integer and a type-C PermanentBackerId.
  • "qi:A:F2:4:example.com:f987b543" // Type "A:F2:4" contains a hexadecimal integer and domain name.
The payload is the contents of the identifier. The idClass must follow the rules of the namespace. The payload must follow the rules of the subClass. (See QIF Detail.)

All QIF UserIds are reserved at RPs. An RP MUST NOT allow the creation of an account tied to a QIF UserId, without first verifying that the user has proved ownership of the UserId. This prevents the creation of accounts using someone else's UserId.

Identifier Use Requirements
The requirements an RP must meet for it to support the use of a type of identifier. (For example, for an RP to support User Authentication using the specified type of identifier.) There are three main categories. "Single-site", "Self-contained" and "Federated UserId". The "Single-site" type requires the RP to store some set of "Credential Verification Rules". (The RP can choose the number of CVR and what types to support.) The "Self-contained" type requires the RP to support the CVR type(s) contained in the identifier. The "Federated UserId" type requires the RP to remotely connect to a federated server for user authentication. (i.e. It uses a Backer VM.)

Note: With "Self-contained" and "federated" the RP can always require its own CVRs *in addition to, or instead of* those required by the UserId. When using the CVR belonging to the Locked Id to authenticate a user, these types complicate the "password reset" problem. This is because the RP does not control those CVR, and therefore cannot change them. Also, the RP must guard against unauthorized "registration" of Locked Id IDs.

UserId Registration (A.K.A. User Registration.)
A type of record at an RP that assigns a UserId to a user. The record contains the UserId and some way of verifying the user in the future. (i.e. Some set of Credential Verification Rules.) Creating a UserId registration is the same as User Login creation. (i.e. See registerUserLogin.) The UserId in a registration can be a Single-site UserId or a Locked Id. (i.e. It can be created by the RP, or it can be created externally to the RP, and claimed by the user.)

User Login creation may not be the same as "creating an account" at the RP. (Because some RPs may require an additional step to "create an account".) It identifies a user to the RP, and allows the user to "login" to the RP again at a later date, but it may not necessarily create a separate "service account" at the RP. This is because an RP may allow multiple UserIds to share a single "service account". An RP can allow multiple users to access a common account. This is done with each user being assigned a unique UserId. (A UserId may identify a person or a device, etc.) An RP can create its own UserIds (i.e. a Single-site UserId) or allow a user to register a foreign UserId (i.e. a Locked Id). When attempting to register a Locked Id at an RP, the RP must ensure that the user can unlock the ID.

QIF Type Specifier / User Identifier Type
The "type" of a QIF formatted UserId is the combination of its namespace_id, idClass and subClass values. For example, the type of "qi:A:A:2:M4j-q:XSAErLq" is "A:A:2".
Multi-site User Login
Another name for a Multi-Site UserId. A single User Login used to identify a user at multiple RPs. (i.e. It is a single Locked Id and the associated unlock mechanism, private key, etc.) Any Multi-Site UserId, such as an email address or a "Federated UserId" etc., can be used as a Multi-site User Login. (As long as it is used at multiple RP.)
Important Note: This specification does NOT implement a Multi-site User Login, as that would result in reduced user privacy. If the same User_ID were used at multiple RPs, that would make it easy to track a user at different RPs. RP websites could collude together, or they could sell advertising statistics based on User IDs. RPs or advertising agencies would be able to easily track user activity, or correlate a user's behavior at different RPs, based on the UserId. This specification uses *site-specific* user identifiers (a different UserId at each RP) specifically to make it more difficult to track a user at different RPs.
Passbook
A way of organizing User Login Information into groups, in order to simplify the Login System for users and hide a lot of the internal complexity. A Passbook is a collection of User Logins, that together represent a single "online identity". A single Passbook can be used all over the internet, at each and every RP that exists. A Passbook provides a consistent "identity name" that can be displayed to users across different RP. They allow the Login System to hide the internal "username" stored for each online account. Using Passbooks allows users to only have to remember a few Passbook names, instead of hundreds of "usernames". See Passbook Detail.
Passbook Detail

Passbooks are a way of organizing User Login Information into groups, in order to simplify the Login System for users and hide a lot of the internal complexity. A Passbook is a collection of User Logins, that together represent a single "online identity". A single Passbook can be used all over the internet, at each and every website that exists. Passbooks provide a consistent "identity name" that can be displayed to users across different websites. They allow the Login System to hide the internal "username" stored for each online account. Using Passbooks allows users to only have to remember a few Passbook names, instead of hundreds of "usernames".

A person typically needs only one or two Passbooks, no matter how many online accounts they have at different websites. A user only needs another Passbook if they want more than one account at some websites, and they want to organize those additional accounts together in a separate group. (i.e. The new group would be a different "online identity".)

Internally, a Passbook contains a collection of User Logins, usually only one User Login for each website. (Note: A User Login is the login information for an account at a website. It contains things like a "username" and "password", etc.) The detailed information of each User Login (i.e. the "username", etc.) is mostly unnecessary to users, and should usually be hidden. A Passbook provides an "identity name" that can be displayed to users instead of the internal "username".

During login to a website, the Login System will display a list of all the valid User Logins available for the website. Each list item will display the "identity name" of the Passbook that contains the User Login. Prior to Passbooks, the list items would have to display the internal "username" stored for the account at the website. This resulted in users having to remember hundreds of "usernames".

A Passbook is a facade. It is designed to look like a single "online identity" to users. It is a way to give users the benefit of using a single "online identity" everywhere online, while not sacrificing user privacy. A Passbook looks like it contains an internal Locked Id", but it doesn't. Instead, it contains individual User Logins. It does this so that it can give each RP a different UserId. (So that the same UserId is not used at multiple RP.) This is done to preserve user privacy and prevent user tracking.

Passbook information is NEVER given to any website. (i.e. the "identity name", etc.) Passbooks are a user convenience. (For display to users.) They are only used internally to the browser and the Login Manager that stores them. User Logins can be moved between Passbooks. So they can be reorganized later. Passbooks preserve user privacy and prevent user tracking.

A Passbook should usually contain only one User Login for each website. Because that makes the display simpler. (Each additional User Login needs to be modified with a number, or disambiguation name.) User Logins can be moved between Passbooks. So they can be reorganized later.

Passbooks make the login process much easier, because the User Login list only needs to display the name of the *Passbook* that the User Login is contained in. The individual User Logins usually do not have a name. (i.e. The user can select which *Passbook* they want to use. The user does not need to know anything about the User Logins that the Passbook contains.)

Passbooks work better when they contain only one User Login for each website. Because it allows the list displayed to the user during login to be simpler. If a Passbook contains more than one User Login for a website, then that makes the list slightly more complicated, and logging into that website slightly more difficult.

If a Passbook contains multiple User Logins for the same website, that will cause nearly "duplicate entries" in the "existing User Login" list. (i.e. Multiple entries in the list will have the same Passbook name.) To prevent confusion, each of the "duplicate entries" is assigned an individual name or id number to help tell them apart, and the "duplicate entries" in the list will display the extra name. This adds another thing that users must remember.

User Tracking and Online Privacy

It would be easier for users to use the same Locked Id everywhere online. However, doing that would result in severely reduced user privacy. Because doing that would make it very easy to track user activity at multiple RPs. Currently, RP websites sell advertising by installing third party scripts on their websites, and they sell their user data to marketing companies. If users were represented by the same ID at different websites, then that would make it easy for data to be aggregated together and be used to track user activity between multiple websites.

Websites could collude together to aggregate data and track users. Websites could sell advertising statistics based on User IDs. RPs or advertising agencies would be able to easily track user activity, or correlate a user's behavior at different RPs, based on the UserId.

In order to preserve user privacy, this specification uses *site-specific* user identifiers (a different UserId at each RP) specifically to make it more difficult to track a user at different RPs. (These are likely Single-site UserIds.)

Passbook implementation

A Passbook is a special kind of group of User Logins. It contains a "Map" or "associative array" that has one "slot" for each RP. Each "slot" contains contains all the information for that RP, including one or more User Logins.

When logging into a website, the system will find the UserLogin(s) for the website that is being logged into. If there is more than one such User Login, then the system may ask the user to choose between them.

A single Passbook should not be shared between multiple users. Each user should have their own Passbook. (A user may have multiple Passbooks.) A Passbook typically contains a "name", some "master keys" (backup keys for User Logins) and a map of RP domain names (which contain the User Logins).

A Passbook has a name and an id, and possibly some other information. The Passbook ID is used in the browser to identify which Passbook is to be used. No Passbook information is ever given to any RP. A User Login is retrieved from inside the Passbook and that is used to create a "proof of identity" that is sent to the RP. A Passbook is stored in a Login Manager (or in a User Authenticator or a browser). The Passbook id is kept secret from RP websites. If websites were given a "Passbook id" as part of an identifier, then it would tell the website that the user has multiple accounts at the website, and which Passbook the user selected to login with.

If users need multiple Passbooks, then each Passbook will likely be assigned a user role. (One for each of: Work, Personal, Family, etc.)

Passbooks greatly simplify using User Logins for users. They reduce the login options that are displayed. Passbooks, and User Logins hide allow the system to hide all individual UserIds, and instead only display the Passbook ID to the user. (This allows the actual UserId values to never be seen by the user.) This greatly simplifies things for users. For example, when logging into an RP, the system does NOT have to display to the user a list of UserIds registered for the RP. This would likely have to display to the user a list of long, 65 character alpha-numeric strings with little significance. Instead of this confusing mess, the system only displays the Login Passbooks that contain a UserId registered for the RP. As a second example, regardless of what RP the user wants to log into, the same set of Passbooks can be displayed to users. (If a Passbook contains a User Login for the current RP, then the Passbook is displayed as a login option. Otherwise the Passbook is displayed as a "create account" option.) The user selects which Passbook to login with, and the system automatically uses the contained UserId for the current RP. (This allows the actual UserId values to never be seen by the user.)

Passbooks work better with only one User Login per slot. Slots with multiple items increase the complexity when using a Passbook. For this reason, it is recommended that, most of the time, users should only store one User Login per RP domain name. This maximizes the benefits of Passbook. However, the Passbook are capable of holding multiple User Logins per RP. This allow users to store two or more User Logins for certain RPs that merit the additional complexity.

Login Manager
A piece of software that stores user authentication data (A.K.A. User Logins), necessary to login to RPs. It stores UserIds, passwords, public and private keys and any other secrets needed to login to RPs. (i.e. It stores "credential sources".) It is a more advanced version of a "password manager", because it stores more than passwords. (It can also be called a "credential manager", etc.) It allows the User Login data to be viewed and/or edited, etc. A Login Manager can easily also work as a User Authenticator. To do so, it must be able to generate a "proof of identity" and must support the connection protocols required by a Login Manager, so that a browser can connect to it. (i.e. NFC, Bluetooth, WiFi, USB, or as a Web Service.) A Login Manager can be located on a physical device such as a "Security Key", on the internet as a Web Service, or on the user's local machine, or mobile phone etc. Typically, all "credential sources" should be stored in a Login Manager, as it is more secure. And Login Managers are usually either portable or usable remotely. See LoginManager API.
User Authenticator
A software or computing device designed to generate proof of a user's identity. It must support connection protocols so that it can be connected to via a browser. (i.e. NFC, Bluetooth, WiFi, USB, or as a Web Service.) It works by receiving a request from a browser, for an RP, and returns a "proof of identity" for use at the RP. Generating a cryptographic "proof" allows it to keep any credential sources (such as private keys) secret. A User Authenticator may also work as a Login Manager, if it provides sufficient User Login and LoginItem editing capabilities. When looking at the LoginManager API, there are 3 required Authenticator functions. collectUserLogins, createUserLogin, createUserLoginProofForRp. (They usually accept the "rpClientData" argument.) See User Authenticator Detail.
User Authentication Device
A physical computing device that stores or generates user identity credentials. It is a type of User Authenticator. It may connect to a computer though a physical connection, or wireless communication protocol. Some examples are a USB key, or a chip on a keyring using Bluetooth, etc. A mobile phone may be used as an authentication device. i.e. as a digital key to unlock features in a different device, such as a computer, TV set, etc.
User Credential
Data given to an RP to provide proof that a user is who he claims to be. (Generically, a credential is data one entity presents to another in order to authenticate the former to the latter [RFC4949].) A User Credential must include the claimed user identifier, and some sort of proof. Some examples of a credential are a "username and password", a "username and digital signature" (i.e. the signature of a private key ), a Credential Proof, or a federated credential. The Remere Login specification recommends using User Credentials that are a Credential Proof. (That are the result of a one-way cryptographic function.)
Federated Credential
A credential that uses an "identity provider". See Federated UserId.
Authentication Assertion
Another name for a RML Request that uses the rml.opId "login" opIdReq. (Copied from triggerConfig.op.)
Credential Source
The secret data that is used to create a Credential Proof. It is commonly a password or private key, etc. Typically, a Credential Proof is created from a "credential source" in response to a challenge from an RP. A Credential Proof is time-stamped and is single-use. In contrast, a credential source can be used multiple times. A User Login can contain multiple credential sources. A Credential Source is created from rml.opId "registerUserLogin" and "setActiveCredentials".
Credential Proof
A set of values, created from a Credential Source, that is given to a recipient to prove that the sender has possession (or ownership) of the Credential Source. The purpose is to prove possession of the CredSource, without revealing the CredSource to the recipient. The recipient typically stores some data (a CVR) related to the credential, used to prove the validity of the CredProof. But it does not know or store the CredSource. (The CredProof is given by the browser to the RP to prove that the user has possession of a Credential Source.) A CredProof is typically the result of a one-way cryptographic operation on a Credential Source using some unique input. (Such as a nonce value or the current time.) A CredProof is (hopefully) better than a password for a couple reasons. (1) The proof cannot be used to obtain the Credential Source. (2) A good proof algorithm will create a single-use value. (The proof must be re-created each time.) It is not valid if stored and re-used at a later date.

If a recipient can store multiple Credential Verification Rules, then each Credential Proof sent to the recipient must be labeled with the identifier for the CredSource it is for. (Each Credential Verification Rule contains an Id for the CredSource it is for.)

Single-use credentials are common in most computer systems that use public key signatures. These credentials are designed to be proof that the user has access to the specific "credential source". (i.e. The CredSource referred to in the Credential Verification Rule.) These types of credentials can also be called a "credential assertion".
Credential ID
A string of characters that uniquely identifies a Credential Source that belongs to a User Login. Example: "cd2". A credential id is also used to identify the Credential Verification Rule that matches the Credential Source, and every Credential Proof that is created from the Credential Source. (For example, Credentials are contained inside an Authentication Assertion, and sent from the browser to the RP.) A Credential Id is typically permanent, and never reused, even if the Credential Source is "deleted". (Because a Credential Id is stored by the RP, to identify a Credential Verification Rule. i.e. a public key, etc.) A Login Item exists in a Login Manager or User Authenticator. A Login Item is uniquely identified by a LoginItem Permanent ID, "lipId". The combination of a lipId and a credential id is also guaranteed unique within a Login Manager.

The Credential ID (possibly with some additions) is used several times in the RML Request to identify the Credential Verification Rule for a particular User account. In the credentialReg."cid_r" property of the credRegSec section. In the credentialProof."cid_p" property, of the "credentialProofList" section. In the "kid" value of the signature header.

Credential Verification Rule (CVR)
Data or algorithm used to determine if a credential is valid or not. It is a test, or a required condition, to determine if the credential was created from the appropriate Credential Source. (Note that in this specification, a credential is single-use. It is created from a Credential Source, which is kept secret. It is usually some type of digital signature.) There must be an associated CVR for each and every Credential Source. For example, a CVR may be, or contain any number of, a public key, a password, a certificate, an algorithm, a database record, an API call to another website, etc. In order to be useful, CVR values must be known. They can be public, or they can be stored by a verification entity (such as an RP).
CVR values are used during "User Authentication". A CVR value is usually a part of the User Authentication Credentials stored by the RP. (Or it can be public, etc.) A CVR is usually the opposite of a "credential". A CVR is a required condition, while a "credential" is proof of a condition. (However, in the case of a "password", both could be the same value.) See Remere User Authentication.
During a login attempt, an RP typically requires that a "proof of identity" must satisfy some subset of the CVR values in order to be valid.
"Leaky" Credential Verification Rule
A Credential Verification Rule that reveals credential source secrets. (i.e. A CVR that can be used to determine the secret "credential source" that it verifies.) In contrast, a "no-leak" CVR can only be used to verify a "proof", and cannot be used to determine the "credential source". A leaky CVR means there is a problem with the one-way function used to create the "proof" from the "credential source".

A regular "password" is an example of a CVR that "leaks". In order to use a "password", an RP must know the secret "credential source" (i.e. the password itself is the source). A public-key is an example of a "no-leak" CVR. In this case, the RP only knows the "public key", which is NOT the "secret". The "secret" is a private key.

Multi-Site UserId Credential Verification Rule
The Credential Verification Rules that are "tied to" a Multi-Site UserId. (i.e. A type of Locked Id.) They are applicable to all RPs. They must be available to and usable by all RPs.
For Example, with a Federated UserId, they are commonly published in a "UserId Certificate" document, that is signed by the "Backer". They can also be published at the "Backer" domain name, or the UserId certificate containing them can be delivered to the RP by the user during the authentication process. The Self-contained type contains the CVR itself. (i.e. in the payload.)
All compliant RPs must verify all "Multi-Site UserId CVR" before using them. Before allowing a user to use a UserId to "sign-up" or "register" himself. When a user tries to sign-up, or "register" using a Locked Id, all compliant RPs MUST require that the user unlock the ID. i.e. Provide valid proof of user-verification of the UserId. The RP must (1) recognize that the UserId is "a Multi-Site UserId", (2) obtain the "Multi-Site UserId CVR" for the UserId, and (3) validate that the proof the user submitted satisfies the Credential Verification method.
Credential Verification Method
A process by which a credential can be proven to be valid or not. Each credential must have an associated method by which its validity can be verified. Usually, credentials of the same "type" share the same verification method (e.g. public-key, password, federated), and each credential only has a small Credential Verification Rule to test the results of the method against. However, in advanced cases, an RP may allow a credential to define its own Credential Verification Method.
User Authentication Credentials
The collection of all data or algorithms stored by an RP to potentially authenticate a user. It includes all Credential Verification Rules, as well as all backup keys, stored by the RP for a UserId. (See triggerConfig.op= "setActiveCredentials".)
Capis specification
This specification. See Capis definition and Capis Specification Detail. It includes the ServiceGroup HTML Element and Service Trigger HTML Elements.
Remote Service
A service offered by a host over the internet. Usually offered by the RP. The service requirements are specified in a BiscProfile. An RP typically publishes a list of the services it offers in the Bisc Site Document, or in the a BiscGroup in an HTML page. The document contains a list of BiscProfiles, describing the service's abilities, requirements and Service Endpoints. "User Authentication" is one type of service that can be offered. See Remere Login. The service receives an Service Request (such as a RML Request)
Remote Service Operation
An operation offered by a Remote Service. A Remote Service can provide any number of operations. Example: See RML Operation List.
BiscProfile
A text article or document that specifies the capabilities and requirements of a Remote Service. It is usually written in JSON, or in modified-for-HTML JSON. BiscProfiles are usually defined together in a BiscGroup, as biscProfileItem objects in its serviceProfileList. See BiscProfile detail and RML BiscProfile.
Service Request
A communication from the browser, or other agent, to a Service Endpoint, asking the RP to perform a Remote Service. For an example implementation, see RML Request.
Service Response
A return communication from the RP, to the requestor. In response to a Service Request. For an example implementation, see RML Response.
Service Endpoint
A URI (at an RP) that has a Remote Service listening to it. It listens for a Service Request and will perform the requested operation. A Service Endpoint is specified in a BiscProfile. (e.g. See endpointBlock.) Endpoints typically receive HTTP POST requests and return an HTTP response. The response typically contains a single JSON object, a JSON document, that contains either return values (such as a success code) or an error object. That describes an error. For example, see RML Response Detail.
Protocol Handler
An executable program, or browser extension, etc. that performs tasks required by the specified protocol. In general, it takes some type of arguments and returns some result. Or modifies a specified resource with the output. The Capis specification, and browsers in general, employ Protocol Handlers to perform the tasks required by various protocols. See API ProtocolHandler.
Bisc Site Document (biscSiteDocument for an RP)
A JSON document published by an RP that describes the RP and its public services using Capis specification format. It is a BiscGroup. The document includes a list of BiscProfiles, these identify the public Remote Services the RP offers. A BiscProfile specifies the abilities and requirements of a Remote Service. The list can include login services. See Bisc Site Document Detail. (The RML BiscProfile contains the "sapId", etc.)
modified-for-HTML JSON ("mofh-JSON")
A slightly modified JSON format for writing JSON inside of an HTML attribute. Has an alternate format that allows property names and string values to be enclosed in caret quotes instead of double quotes. This was added for convenience, because HTML attribute values can be double quoted, and that interferes with standard JSON quoting. See mofh-JSON Detail. See the ServiceGroup HTML Element "servicegroup-config" attribute.
Example: <a href="remere://example.com/remereService?op=login" rel="servicetrigger" trigger-config='{ "op":"login", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }'>Login</a>
Service Trigger
An element in a computer program, used to invoke a service, particularly a Remote Service. It is commonly an HTML element, such as an anchor, button or form, but it can also be a menu item or other UI element in the browser chrome. (The trigger is usually a UI element.) For example, an HTML form is commonly used as a trigger. Submitting the form sends data to the RP, and receives a response. (In other words, it invokes the "service" at the RP.)
Service Trigger HTML Element
Any HTML Element that can be "activated" and contains a Trigger Configuration, so that it can be used as a Service Trigger. Examples: Anchor HTML Element, Form HTML Element. See ServiceGroup HTML Element.
These HTML elements differ from regular HTML elements (anchors, buttons and forms) in that: (1) They are MARKED as a Service Trigger. (rel="servicetrigger") (2) They must contain a Trigger Configuration. (It must contain at least the "op" property, and the bip property. Which contains the "biscProfileId" of the service.)
Example Service Trigger HTML Element HTML Element: <a href="remere://example.com/remereService?op=login" rel="servicetrigger" trigger-config='{ "op":"login", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }'>Login</a>
login form (Traditional)
A regular HTML form requesting the username and password in order to login the user. The submission of this form is commonly used as a Service Trigger.
ServiceGroup HTML Element
A Link HTML Element (or other element) that contains a BiscGroup. In HTML, this element has the special attributes "servicegroup-config" and rel="servicegroup". See Link HTML Element detail. See Service Trigger HTML Element. See BiscGroup Detail.
Example ServiceGroup HTML Element:
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup" servicegroup-config='{ "challengeTime": 1599876543210, "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK", "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"}, "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"}, "mediation": "required"}] }'/>
Link HTML Element
A Link HTML Element with the special attributes "servicegroup-config" and rel="servicegroup". It is a ServiceGroup HTML Element. See Link HTML Element detail.
Anchor HTML Element
An Anchor HTML Element with the special attributes "trigger-config" and rel="servicetrigger". It is a Service Trigger HTML Element. See Anchor HTML Element detail.
Form HTML Element
A Form HTML Element with the special attributes "trigger-config" and rel="servicetrigger". It is a Service Trigger HTML Element. See Form HTML Element detail.
Capis Configuration Options
A collection of JSON-like data values published by an RP to configure a browser's behavior at the RP. They are an alternative to an HTML page using Javascript to control how the browser behaves. The options are commonly embedded within HTML markup as a single modified-for-HTML JSON object in the "servicegroup-config" attribute of a ServiceGroup HTML Element. Or in a Bisc Site Document. The options give the browser data or instructions about Remote Services without using javascript. This makes creating Capis enabled HTML easier, and Capis will work without requiring the browser to enable javascript for the RP. The options currently come in two types, a BiscGroup and Trigger Configuration. See Capis Configuration Options Detail.
Example: <a href="remere://example.com/remereService?op=login" rel="servicetrigger" trigger-config='{ "op":"login", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }'>Login</a>
Trigger Configuration
The set of Capis Configuration Options inside a Service Trigger. (This is usually a Service Trigger HTML Element HTML element. Such as a Anchor HTML Element.) These are the contents of the trigger-config attribute. It is usually a single modified-for-HTML JSON object. The config object contains the arguments to call a Remote Service with. (To send to the Protocol Handler.) See Trigger Configuration detail.
Example: <a href="remere://example.com/remereService?op=login" rel="servicetrigger" trigger-config='{ "op":"login", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }'>Login</a>
BiscGroup
A set of Capis Configuration Options that describes an RP (a website) and what Remote Services the RP offers. It includes a list of BiscProfile objects. (In the internal serviceProfileList.) It is written in JSON or in modified-for-HTML JSON. A BiscGroup can be located inside a ServiceGroup HTML Element "servicegroup-config" attribute, or in a Bisc Site Document. It specifies how the client is to invoke the services. The client is typically a browser. See BiscGroup Detail.
Service Arguments
The arguments to call a Remote Service with. (To send to the Protocol Handler.) Also known as the CapisControl.invokeServiceAction callOptions argument. They are often read from Trigger Configuration.
CapisAPI.callOptions
The "callOptions" argument supplied to the CapisControl.invokeServiceAction function. This argument customizes what Service Request is created. It is a JSON object. It is commonly created from the Trigger Configuration of the Service Trigger HTML element that was activated. (e.g. A Anchor HTML Element.) Note that a Service Trigger HTML element does not need to be activated. The API can be called directly, and the "callOptions" can be specified by the caller.
biscProfileId
A text string that identifies a BiscProfile. The value specified in the BiscProfile "id" value.
Service Protocol Id
A text string that identifies the protocol to be used by a BiscProfile. (By Capis and by a Remote Service.) The Service Protocol Id is specified in the BiscProfile "protocolSpec" value.
BiscGroup Id
A text string that identifies a BiscGroup. The BiscGroup Id is specified in the BiscGroup.id value. The default value of BiscGroup.id is "sg_n". Where "n" is the index of the group in the HTML. (Starts with 1.) Example: "sg_1"
CapisAPI.opId
A supplied argument when making a Service Request. The argument to the CapisControl.invokeServiceAction function.
RML Request
A communication from the browser to the Service Endpoint, asking the RP to perform a user authentication service, such as "login". It is an implementation of a Service Request. It consists of a single JSON object. It contains a requested user authentication opIdReq and a "proof of identity", along with any other necessary data. See RML Request Detail.
RML Response
A communication from the RP to the browser, in response to a RML Request. It consists of a single JSON object. It is an implementation of a Service Response. See RML Response Detail.
RML BiscProfile
A JSON object format that describes a Remere Login Remote Service. It is an implementation, or subtype, of the BiscProfile. See RML BiscProfile Detail.
Remere Login Status
The status of the Remere Login User Authentication at an RP. The RemereLogin.getLoginStatus API call returns this value. There are 4 values. "logged_in", "logged_out", "pending_login", "pending_logout".
The browser maintains a "Login Status" record for each known Capis sapId item. This lets the browser perform the RemereLogin.logoutAll() function. The "login" and "logout" opId functions work together to update the "Login Status" for the current sapId. The "login" function updates the "Login Status" after every login attempt, with the success/fail result. (It either adds a "Login Status" record, or updates the existing record.) The record contains the lipId, the domain (origin) and the "login status" value.
Proof of Identity
A set of data that proves a user is who he claims to be. It contains a "claimed" UserId and a set of Credential Proofs showing that the user knows the "secrets" for the claimed UserId. (Credential Proofs such as cryptographic signatures or passwords.) (i.e. A secret can be a Credential Source, or a private key, password, etc.) A Proof-of-Identity may also contain a challenge from the RP. One type of Proof Of Identity is a UserId Assertion. (A UserId Assertion uses private key Credential Sources.)
More details.

This specification uses a UserId Assertion and a UserId certificate as the component parts of the "proof-of-identity". The JSON Web Signature is the UserId Assertion. It is sent from a browser to an RP in an "RML Request".

A "proof of identity" contains a UserId, an array of "Credential Proofs", a creation date, an expiration date, and the "audience" that it is intended for. (Note that all of the "credentials" included in a "proof of identity" must be for the same UserId.) The ability to contain multiple credentials, each of a different type, allows a single "proof-of-identity" to be used for Multi-Credential Authentication and multi-factor authentication. An RP stores some set of Credential Verification Rules for each UserId. The RP can decide which rules it requires, under which circumstances. A "proof-of-identity" contains a set of credentials. Each of the credentials must specify the "id" of which rule it is for. In order to login, the "proof of identity" must have a credential for each of the required rules. (Usually, the RP requires all the rules to be proven, so the proof should have one credential for each of the rules.)

Nonce value
A very long, unique value, only used once. It is used to verify that a cryptographic operation occurred. The BiscGroup.challenge is a nonce.
Capis Trigger Behavior
The new behavior defined for Service Trigger HTML Elements. (The Link, Anchor and Form.) These HTML elements will perform the CapisControl.activateTrigger. The activateTrigger function will in turn call the CapisControl.invokeServiceAction function on the "op" and other Trigger Configuration, defined in the "trigger-config" HTML attribute. (For example, in a Anchor HTML Element.) If the browser understands this specification, then a Anchor HTML Element (i.e. An HTML element marked with the rel="servicetrigger" attribute) will perform the CapisControl.activateTrigger, and then perform the Capis opId. It will not load the URL contained in the "href" attribute. The opId has a defined format, however, there are no defined values in Capis. (Note that Remere Login has defined several opId values.)
User Authentication (Generic)
The process by which a user's identity is verified. The process by which a user "signs in" to a website. For Example: The RP web page typically contains a Service Trigger, which the user activates. (Clicks an anchor, or fills out a login form and submits it.) Remere User Authentication is an example of one such process.
Remere User Authentication
The User Authentication process defined by the Remere Login protocol. By which a user's identity is verified using Capis. It relies on the Capis Service Invocation Protocol to invoke Remere. See Remere Login Flow overview.
Capis Service Invocation Protocol
Details the steps Capis-compliant browsers should implement when a Service Trigger HTML Element is activated. Defined by the Capis specification. See Capis Spec. A detailed overview of the process is provided in the Capis Service Invocation Flow.
User Identity Verification
The process by which a user's identity is verified. The process by which a "proof of identity" is verified. The user claims a UserId and provides a "proof of identity". The RP then verifies the user's claims are valid. If the proof is valid, then it proves that the user is who they claim to be. Verification ensures the proof is valid, was not faked or tampered with, and meets all the requirements of the RP. In particular, an RP can require multiple factors of authentication. See User Authentication Detail.
Multi-User Account Access, (A.K.A. "Account Sharing" and "Account User Access Control")
The ability for multiple UserIds to access the same account at an RP. The ability for an account to grant access to multiple authorized users. This feature allows an account owner to "share" their account with other users, without giving the others the owner's login details. (i.e. the owner's username and password, etc.) The other users are assigned an account_permission_role. The other UserIds can be people, or can be authorized devices or services. This ability is usually implemented by an account maintaining a list of approved UserId, and each UserId is assigned its own account_permission_role. This ability usually requires the RP to use a "one-to-many" UserId to account_id mapping. See RP Requirements.

This ability also provides an easy way for an RP to support Multiple-account Access. Since a single UserId can be listed as an authorized user on multiple accounts at the RP. (For example, a user can have their own account at the RP, and can also be listed as an authorized user on other accounts.) If a single UserId can access multiple accounts, then the RP may allow the user, after logging in, to decide which account he wants to access.

More

Because each user has their own UserId, it allows the RP to manage and track how much each user uses the account.

RPs MAY allow accounts to impose additional credential requirements on its authorized users. But this is uncommon. Typically, the UserId does not need any additional User Credentials to access the different accounts at the RP. (i.e. One set of credentials to login to the RP, other passwords or public keys for different accounts, etc.)

This ability also allows the same user to register at the RP with multiple UserId. The user can access their account with any UserId that is authorized. (i.e. This allows a user to change his UserId or to maintain multiple UserId.)

Multiple-Account Access
The ability for a single UserId to access multiple accounts at an RP. After a user logs into the RP, they can somehow select which account to access. This ability does not necessarily require the RP to use a one-to-many UserId to account_id mapping. (But it is an easy way to implement it.) See RP Requirements.

An easy way to implement this feature is to first support Account User Access Control. (i.e. Account Sharing.) Then, have each of the accessible accounts include the specified UserId as an authorized user. (And give the UserId an account_permission_role.) See grant access.

The RP must provide some way to allow users to select which account they want to use. Typically, this is done in one of the following ways. (1) During login. The user can include an account_id in the login request. (2) Immediately after login. The RP displays a list of what accounts the user has access to, and the user must pick one. (3) Allow switching at any time. The RP adds a link (or similar) to the HTML page, providing a way for the user to view the list of accessible accounts and select the one they want to access. (4) Multiple accounts at the same time. The RP provides an interface that allows a user to view or make changes to multiple accounts at the same time.

Authorized User
A UserId that is allowed to access an account at an RP. Typically, each account either has a single authorized user (i.e. the "owner" of the account), or has a list of authorized users. Each of the authorized users is also assigned an account_permission_role, which defines what features of the account the user can access. See Account User Access Control. Each authorized user is a UserId, and has its own Credential Verification Rules that it uses to log into the RP. (i.e. Some set of passwords or public keys, etc.) Once a UserId has logged into the RP, the RP can then allow it access to the accounts that it is authorized to access.
Attestation
A statement that a party has confirmed or authenticated that a process or output works correctly and meets the necessary requirements. When describing credentials, an attestation is a signed statement, backed by the device manufacturer, etc. stating that the User Authenticator and its process has been certified. That the authenticator has created the item (the credential) in the appropriate manner. (According to the standard.) Attestation is a promise (a guarantee) that the Authenticator, and the data that it emits, follows a standard. Attestation is also a way of identifying the creator of an Authenticator, and specifying the Authenticator's capabilities. (An RP may use the attestation data to restrict what Authenticators it will accept.)
Typically, a Login Manager is created in such a manner that it can only create credentials (key pairs, etc.) in a certain manner. The authenticator contains two special attestation items, put in the software or on the device during manufacture, by the creator (the device manufacturer, etc.). The two special items are, an attestation key pair, and an Attestation Certificate. The certificate contains the attestation public key, and is signed by the device manufacturer. Both of these attestation items are typically NOT unique. The same items are inside a large number of other authenticators of the same class. (Typically tens of thousands.) At registration time, a Login Manager is instructed to create a new key pair (for an RP website). The authenticator creates the new key pair, then it takes the newly generated public key and "signs" it with the special attestation private key. The Authenticator creates a result object (it may be a JSON object), puts in it the new public key, the signature, and the Attestation Certificate, then sends it back to the caller. The two attestation items provide proof that the newly generated public key was created in a certified manner. That it follows a certain standard.
JSON Web Signature
A JSON object that contains a "payload" string and a "signatures" array. (i.e. The array must contain one or more public key signatures.) This specification uses the "standard JWS format" and does not use the "compact format". The payload is the base64url encoded version of some original data. (Typically another JSON object.) Each "signature" can use a different signature algorithm and key. A "signature object" has three properties, a "header" JSON object, a "protected" header string, and a "signature" base64url encoded byte string. The "protected" header specifies the cryptographic algorithm. The "header" specifies the key id. (See the JSON Web Signature RFC.)
Example: JWS = {"payload":"mJh48Q...", "signatures": [{"protected":"eyJhb...", "header": {}, "signature":"cC4h..."}, {}] };
Remere Login
A Service Protocol Id and Remote Service that performs User Authentication. It integrates into the browser using the Capis specification. The browser must implement the Protocol Handler and the RP must implement the Remote Service. See Remere Login Overview.
Capis (A way to describe Website Services and Configuration Options)
Name for the specification that embeds site BiscProfile options in HTML using modified-for-HTML JSON. Not an abbreviation. It used to mean "Common Architecture for Publishing Internet Service configuration options". (SISCOJH Site Service Configuration Options in JSON and HTML. Pronounced "sis-cojh".) It is a way for websites to publish what services they offer, and how to connect to the services, inside of HTML markup. It is HTML attributes that contain JSON. and a browser API to act on it. See Capis Spec. The JSON includes a list of "BiscProfiles". Capis is a way to specify website services and protocol data in HTML files, without using javascript. (It's JSON.) Remere Login is a way to use Capis to perform User Authentication. Capis defines the Capis Service Invocation Protocol, ServiceGroup HTML Element, Service Trigger HTML Elements and CapisControl API. The primary example of a Remote Service is for "User Authentication". It is called Remere Login.
Remere Login (Alternate)
The "Common Architecture for Publishing Internet Services" Login Specification. May change to something else. CAPDA. Common Authentication Protocol and Data Format. This is the name of the standard defining one type of authentication communication between the browser and the RP. The names and behavior of the configuration options, request options, the definition of the "support document" and having the "authentication request" deliver a single JSON item, these are all a part of Capis.
Note that the changes to HTML are a part of the Capis specification, and NOT a part of Remere Login. The two are separate specifications. Capis can be used with an alternative to Remere Login to communicate between the browser and the RP. (Capis includes the HTML idea of a ServiceGroup HTML Element. i.e. The "servicegroup-config" attribute that contains a BiscGroup. And that the web browser can automatically get a separate document from the RP describing how it does authentication. All communication and passing data between the browser and the RP are defined by a different specification. The "Web browser and HTML extensions to support the passing of authentication data between the browser and the RP". This is "WESPAD".
Camis
Abbreviation for "Common Architecture for Managing Integrated Services". Or for "Camix Services Architecture". Pronounced "kam-suh". (Alternate name is "CAMUA", "Common Architecture for User Authentication"). Pronounced "kam-ew-a". Includes the format for the RML Request.
Identity Provider
A service that provides a "user identity". That is, a UserId Certificate. The certificate is used with a Locked Id. Usually a person "signs into" the identity provider in order to receive a "UserId certificate". The user can then present the certificate to any RP as part of the User Authentication process. (The user must also present the appropriate credential(s) showing they have possession of the private keys that correspond to the public keys contained in the certificate.)
User Identifier Certificate
A digitally signed statement that contains a "Federated UserId" and a set of public keys, and binds them together. (i.e. It is a UserId binding document".) It is a signed claim from the certificate Issuer, stating that the UserId proved "ownership" of the public keys. (i.e. That the UserId knows the set of private keys that correspond to the public keys.) Therefore, an entity that claims the UserId must be able to use the private keys. A UserId Certificate is different from a regular "Public Key Certificate" in that it uses a UserId as the "owner", instead of an organization, domain name, email address, etc. A UserId Certificate should be issued by the Backer of the UserId, or by an "identity provider" that is delegated by the Backer. (Note: if possible, a UserId Certificate may also contain other types of "Credential Verification Rules" beyond public keys.) See UserId Certificate Detail.
Certificate Issuer
The entity that signed a certificate. (It can be a Public Key certificate or a UserId certificate, etc.) The issuer is supposed to verify the contents of the certificate before signing it. Users of the certificate must be able to get a sig verification keys for each signature in the certificate (if there is more than one), in order to verify the certificate. These are the public keys that were used to sign the certificate. Therefore, the public keys that were used by the issuer to sign the certificate are usually either published publicly or available from the issuer upon request. I.e. From a Backer VM.
User Identifier Assertion
A digitally signed statement that claims that the issuer of the assertion (i.e. the user or browser) is authorized to use a UserId. It provides proof that the issuer has possession of, or access to, the set of secrets (i.e. private keys) that are used in the UserId. A UserId Assertion contains the UserId, a nonce value, the date, etc. and a set of signatures of the private keys. The private keys used to sign the assertion must match the public keys that are associated with the UserId. These public keys may be stored locally by the RP (i.e. as Credential Verification Rules), or they may be bound to the UserId in a UserId certificate or other secondary document. The RML Request contains a UserId Assertion. (i.e. It contains one in the "JWS" property.) See UserId Assertion Detail.
Signature Verification Key
A public key that can be used to verify a cryptographic signature. In this specification, this is primarily used to verify two types of signatures. (1) A signature in a UserId Assertion, and (2) A signature in a UserId certificate. (The public key for the certificate was created by the Issuer of the certificate.) A signature verification key is similar to a Credential Verification Rule, except that a CVR does not have to be a public key. (It can be a password, algorithm, etc.)
WebAuthn
A specification that automates users logging into websites. It differs from Remere Login in that it requires Javascript and forms, custom coding, and that users carry around a separate physical User Authentication Device with them. See RML Comparison To Webauthn and RP requirements.

HTML Examples:

See the "Bisc Site Document Detail" for an example of the Bisc Site Document. It may declare support for additional verification types. (BiscProfile.credentialReg.credentialReg.ruleTypes)

The ServiceGroup HTML Element uses the attributes rel="servicegroup" and "servicegroup-config". A ServiceGroup HTML Element MUST contain a "challengeTime" and "challenge" property.

Examples of ServiceGroup HTML Element:
<head> <link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup" servicegroup-config='{ "challengeTime": 1599876543210, "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK", "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"}, "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"}, "mediation": "required"}] }'/> </head>
Examples of Anchor HTML Element:
<a href="remere://example.com/remereService?op=login" rel="servicetrigger" trigger-config='{ "op":"login", "bip":"remere_1" }'>Login</a> ... <a href="remere://example.com/remereService?op=logout" rel="servicetrigger" trigger-config='{ "op":"logout", "bip":"remere_1" }'>Log OUT</a> ... <a href="remere://example.com/remereService?op=proveUserPresence" rel="servicetrigger" trigger-config='{ "op":"proveUserPresence", "bip":"remere_1" }'>Confirm your presence</a>
Examples of Form HTML Element:

Example 1: Sign a form. This form collects user info before asking the browser to sign the form.
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup" servicegroup-config='{ "challengeTime": 1599876543210, "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK", "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"}, "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"}, "mediation": "required"}] }'/> ... <form action="remere://example.com/remereService?op=signForm" rel="servicetrigger" trigger-config='{ "op":"", "bip":"remere_1signData" }' onsubmit="return validateForm(event)"> // User supplied data. <input type="text" name="first_name" placeholder="Enter your first name" /> <input type="text" name="user_email" placeholder="Enter your email address" /> <input type="submit" value="Sign and Submit the Form" /> </form>

Use of a Form HTML Element is only necessary for certain unusual tasks. Mainly this is limited to signData. Usually, forms are NOT needed for User Login creation, as the user DOES NOT need to provide a new "username" to use with the account.

Forms can also be used to do authentication (login, password changes, etc.). This may be useful for some situations. The RP may want to do things with the UserId before the "authentication request" is sent to the RP. Perhaps the RP wants to help the user pick out which UserId to login with, validate the UserId format, etc. Maybe the RP wants to force the user to select from a list of only certain supported UserIds. When doing any of these things, custom javascript on the RP web page may be required.

Capis Specification Summary

  1. An RP can publish a "Bisc Site Document". This document describes the Remote Services the RP offers, and their URI and abilities. This includes what types of authentication the RP supports. It also explicitly declares if the RP supports the Remere Login protocol.
  2. Defines the ServiceGroup HTML Element.
  3. Defines a few new Service Trigger HTML Elements. (HTML anchors, links, forms and anchors can be augmented with some new HTML attributes. Such as type="application/json" rel="servicegroup", rel="servicetrigger", servicegroup-config="...")
  4. One of the new HTML attributes is the ServiceGroup HTML Element "servicegroup-config" attribute. It contains BiscGroup. In particular, the "triggerConfig.op" property specifies the operation to be performed by the RP.
  5. The "onSuccess.itemN.redirectUri" configuration property will redirect the browser after authentication is performed.
  6. The Anchor and Form Service Trigger HTML Element do not use their "href" and "action" attributes, respectively. Instead, they will perform the Capis Service Invocation Protocol. They will fetch the "Bisc Site Document", create a "service request" (that includes a "proof of identity"), and send it to the "Service Endpoint". They do not send it to the URI in the "href" or "action" attribute.
  7. Because the "href" attributes of Anchor HTML Elements (and the "action" attributes of Form HTML Elements) are not used, they can be set to a special "fallback" URI. If a browser follows the URI, it means the browser does not support the Capis specification.
  8. The Service Trigger HTML Elements have a special activateTrigger behavior.
  9. The RML Request is a JSON object. It can contain multiple request properties. It also contains the "user_identity" ("request_object.crProofSection"), that contains the credentialProofList. (Which contains the various "credentialProof" objects.)
  10. The browser sends the Service Request to the "Service Endpoint" in whatever manner the RP designated in the BiscProfile. (i.e. In the Bisc Site Document.) Usually the method is an HTTP POST. (The default name of the HTTP parameter is capis_request.)
  11. The defaultValues.biscSiteDocUri of the Bisc Site Document is a "well-known" URI. (Example: "https://RP_example.com:port/.well-known/capisBiscSiteDoc.json".)
  12. An HTML page MUST contain a special "ServiceGroup HTML Element", which defines the a BiscGroup. These apply to the entire HTML document. The options can include the "biscSiteDocUri" and similar properties and the "href" attribute. These determine which "Remote Service" is used.
  13. Service Triggers (i.e. Service Trigger HTML Elements that are not a ServiceGroup HTML Element) can specify their own Trigger Configuration. These options are used as the CapisControl.invokeServiceAction callOptions argument.
  14. Browsers can have special behavior for Service Trigger HTML Elements. The browser can display them in a special color. When a user hovers the mouse over an anchor, the browser can display the available RP options. The browser can be set to use a "default" identity on a regular click, and only bring up a menu when using a right-click (or shift-click). Using a right-click, etc. would display a dialog asking the user which passbook to use, or which identity to log in as. A left-click would log in using the "default" identity.
A Capis Relying Party must implement the following:
  1. Publish a Bisc Site Document.
    An RP must explicitly declare, in the form of a document hosted on their domain, that they support Capis. This document must contain a list of BiscProfiles. The services should define the various user identifier types and Credential Verification Rule etc. that the RP supports.
  2. Create an Endpoint.
    An RP must have a working endpoint, declared in the Bisc Site Document. A user's browser must be able to interact with the RP's endpoint at the time that the user is signing into a website to prove their identity to the RP and establish a session. (The path to the endpoint is given in the "endpoint.sUri" property of the RML BiscProfile.)
  3. Include a ServiceGroup HTML Element in the HTML page.
  4. Include some Service Trigger HTML Elements in the HTML page.
    The RP must notify the browser, by including some changes in the HTML page. These changes can be the inclusion of the new HTML attributes, or the use of the Javascript API.
A Capis primary identity authority (IDP) must implement the following:
  1. A declaration of support: An IdP must explicitly declare that they support the Capis spec, by publishing a document hosted on their domain. The contents of this document may include paths to supporting resources, as well as a path to public keys which allows for the verification of assertions generated using certificates that the primary has issued.
  2. Authentication page: A user must be able to interact with their IdP at the time that they are signing into a website to prove their identity to the IdP and establish a session.
  3. Provisioning page: A web page must be provided which is capable of provisioning a user that is authenticated to the IdP with a certificate.

RP Requirements Detail

This specification requires that all compliant RP websites use "account ids" that are distinct from user identifiers. In other words, an RP website must not use a UserId as an account_id. For example, it must not use a "username" as an account id, it must not use a Capis UserId as an account_id, etc. This enables a UserId to change, without changing the account_id, and (with an additional requirement) it enables a single UserId to access multiple accounts at the RP.

The term "UserId" refers to a string of characters that uniquely identifies a user to an RP website.

This specification requires that all RP websites have a mapping from a UserId to an account_id. (i.e. A database table, or similar, that maps from one to the other.) This is a basic requirement whenever an RP website uses UserIds and account_ids that are different from each other. When a user logs in, the user provides their UserId, then the system uses the UserId to look up the account_id. RP websites could use a simple "one-to-one" mapping or a more complicated "one-to-many" mapping between UserIds and account_ids. A "one-to-one" mapping can only hold one account for a single UserId. A "one-to-many" mapping can hold multiple accounts for a single UserId. The "one-to-many mapping can be used to allow a single user to access multiple accounts. It is common for a mapping from UserId to account_id to also contain other user information. If it does, then it can be called a "User Table". (A "User Table" is a database table that stores user information. It keeps user information separate from account information.)

All RP websites must have a mapping from UserId to account_id. A mapping is necessary because, at the very least, a user's UserId can change. (A UserId can become invalidated, compromised, retired, etc.) The one-to-many mapping is strongly encouraged. The "one-to-many" mapping is necessary for the RP to implement the "Account Sharing" feature. (i.e. the "grantAccess" opId and the "grant_user_access" request option.) The simpler "one-to-one" mapping, cannot support the "Account Sharing" feature.

  • It can not support "grant_user_access". The website will have no way for account owners to add additional "authorized users" to the account. So a user cannot have the system create an invitation for someone else to join the account. This may be acceptable for certain RP websites. For example, small blog websites. These websites have no reason for them to allow multiple users to use a single account.
  • A single UserId cannot access multiple accounts. (Because the system is not capable of storing multiple account_ids for a single UserId.)
  • Multiple users can still access a single account. However, it is NOT possible for any of these UserIds to access any account OTHER than the single account. (Because the system is not capable of storing multiple account_ids for a single UserId.) In order to do this, the system would add an entry to the User Table, where the new UserId would map to the same account as the original UserId.
  • A user can still change their UserId. (Add an additional UserId, then remove the original UserId.)
An extra, optional feature is "grantAccess" grant_user_access. An RP website can implement this whenever they get around to it. (It requires a more advanced *User Table*.)

This specification already requires that a UserId and account_id be different. This is because users must be allowed to to change their UserId. (A UserId can be lost, compromised, etc.) If the UserId were used as the account_id, then when a UserId is changed, then the account_id would also change. This is a very bad idea. And would have many complications and edge cases. Because of this, using a UserId as the account_id is not advised. It is a basic requirement that the account_id be independent of any UserId.

RP websites should already be using a mapping, from a "username" to an account_id. At least, this is the way that usernames should currently work at the RP website. (This assumes that the website implemented usernames correctly, and it did not use the "username" as the account_id.) Usernames are just another type of UserId. The username to account_id mapping could be either one-to-one or one-to-many, both will work. However, using the one-to-many mapping is strongly encouraged, as it will allow Account Sharing. Note that it is possible for RP websites to use both usernames and Capis UserIds concurrently. They are just two different types of UserId, mapping to the same account. Therefore, a Capis UserId database table can be used as a drop-in replacement, or an addition to, a username and password setup.

In order for an RP website to implement "grant_user_access", it must do the following.
  • Update the User Table to support a "one-to-many" relationship between UserIds and account_ids.
  • Implement some sort of *account switching* in its web pages. So that users can access the different accounts they have access to.
  • Provide a way for account owners to add additional "authorized users". Probably allow them to create invitation codes.
  • Provide a way for users to be added to an existing account. i.e. A way for users to use an invitation code and be added as an "authorized user" to an existing account.

    This could be done by user IDs that are unknown to the website (and have no account), or by user IDs that already have access to an account at the website. (They could be the owner, or an "authorized user" of the account.)

How to upgrade the User Table.
  • The *User Table* must be made "one-to-many", instead of one-to-one. A single UserId can be used to access multiple accounts.
  • The "User Table" needs to hold all the information about the UserId. For example, it needs to hold the public key, the backup key, and all status codes. (if the UserId is locked or compromised. etc.) Therefore, the UserId information must be moved from the account table to the User Table.
  • The User Table must have a *permission level* or *account_permission_role* for each UserId and account_id combination. Possible levels could include: owner, full, read-only, restricted1, restricted2, none.

Some Ideas for Possible Remere Login Additional Features

Features
  • Temporary access on any computer. The Login Manager can temporarily authenticate a computer for 2 hours. (login and passwords will expire after 2 hours)
  • Automated public key change (i.e. Automated password change for a website.)
  • Can enable multi-factor login
  • Can mark a device as "trusted", and use single login (Not multi-factor login)
  • A
  • A

For Automatic public key change, the changed password (private key) is encrypted locally (on the user's computer) before syncing with the user's password manager, never allowing the password manager to access the raw data. Just like all other data on the user's Password Manager account.

Can mark a device as "trusted". A random, unique identifier is created for that device. It is then encrypted using Windows "crypt protect data" functions. It encrypts it based on the user's credentials. So that another user of the device cannot decrypt it. A hash of the ID is stored in the Password Manager server database. During login, the ID is decrypted on the device, a hash is created, and sent to the login server.

For mobile devices, a randomly generated id is stored in secure phone storage.

Remere Login User Authentication Flow - Detailed walkthrough

Here are the detailed steps. (For example, in order for a user to sign-in.)

  1. The browser will retrieve the "Bisc Site Document" for the website. (via HTTPS)
    In the document is the list of BiscProfiles. The browser will find the appropriate one. This BiscProfile describes what types of authentication the website supports, i.e. what it needs to automatically log the user into the website. The ServiceProfile should provide as much information as possible, in order to narrow the choice of the user's credentials.
  2. The browser starts the Proof Creation Algorithm in an attempt to create a "proof of identity". See API function RemereLogin.buildServiceRequest(biscProfileId, opId, callOptions).
    The browser tries to create a "proof of identity" that meets the requirements of the RP's RML BiscProfile. This process uses the internal API. This process is done mostly automatically, but the browser may require the user to (1) select which UserId to use, and/or (2) login to the identity provider. (If the UserId is a "Locked Id" then it uses a "Multi-Site UserId Credential Verification Rule". This may exist in an "UserId certificate". If the "UserId certificate" stored in the browser has expired, then the user must login to the IdP.) Note that the "proof creation" process may fail, particularly if the browser does not have credentials of a type required by the website.
  3. The browser decides which User Login to use.
    The browser may have a user setting telling it which User Login to use in which situation. Or, the User Login to use can be obtained from the data that was stored locally (in cookies, in local storage, in the password manager) after a previous registration or User Login import, etc. Or it can be determined by other means such as prompting the user which ID to use. This step is encapsulated in the API step RemereLogin.buildServiceRequest.
  4. The browser creates a RML Request.
    A RML Request typically contains a single JSON object. The browser puts all the data to be sent to the RP into the object. The "request_object" contains various request properties. These include: the "proof of identity" (a.k.a. the payload"), the user_id_certificate_chain, and the credRegSec, which details desired changes to the Credential Verification Rule stored by the RP. It also includes whatever else is needed to perform the opId. is sometimes needed. (For example, a Set Active Credentials (i.e. public key change request) needs a new public key, "credRegSec", object. etc.)
    The browser extracts the Trigger Configuration, from the Service Trigger (i.e. from the HTML anchor that the user clicked). It then creates the CapisControl.invokeServiceAction callOptions argument from the values. It also copies some of the values into the RML Request. (For example, the "triggerConfig.op" and "onSuccess.itemN.redirectUri" configuration properties are put into the RML Request as "payload.opIdReq" and "payload.redirectUri" properties, respectively.)
    From the a BiscGroup, the "challenge" property is copied into the "payload.challenge" field in the RML Request.
  5. The browser sends the RML Request to the Service Endpoint.
    All the request data is combined into a single JSON object. (A RML Request "request_object") This includes all request options and the "proof of identity". The request is sent to the "Service Endpoint" in whatever manner the RP designated in the Bisc Site Document. See RML Request Detail.
  6. The RP website receives the RML Request. (i.e. the HTTP POST)
    The RP reads the "service request" and attempts to verify the "proof of identity". If it is valid, the website performs the requested opId. (e.g. logs the user in.) It sends a RML Response (via HTTP) to the browser stating what happened. (If the opId succeeded or failed.) If the proof is not valid, the RP can return an error. Otherwise the RP can return a success code. In addition to the "success code", the RP can return a redirectUri, or it can direct the browser to refresh the current page or part of the page. (So that the op:"login" anchor becomes a op:"logout" anchor. etc.) The RP can simply return a simple "success" status by itself, without any extra data. The simple "success" status will cause the browser to do the default behavior, to refresh the current page.
  7. The browser receives the RML Response.
    If it is a "success" response, the browser usually just refreshes the page. This will cause the page to refresh, and to display any previously restricted material. If the response was "failure", then the browser will display the HTML document delivered with the response. (The document returned with a "failure" code should be an HTML document containing some error message to the user.)

The triggerOp property Detail

Capis opId Detail

RP services can perform various operations. The Operation to be performed by the Service is specified in the Operation Identifier. (The "opId".) Each protocol defines it's own List of valid Operation Identifiers. (See RML Operation List.)

The "bip" property contains the "biscProfileId" before the slash, and the opId after the slash. (The BiscProfile contains the biscProfile.protocolSpec Protocol ID.)

For example, if the opId is "login", then the biscProfileId is "remere_1", and the opId is "login". (The use of "remere_1" likely means the Service Protocol Id of the BiscProfile is "remere".)
The service method may be one of the RML Operation List values.
Example Anchor:
<a href="remere://example.com/remereService?op=login" rel="servicetrigger" trigger-config='{ "op":"login", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }'>Login</a>

RML OpId Detail

A Remere Login Service "Operation Id" is an action that the browser requests the RP to perform. The Method value is specified by the browser and sent to the Service Endpoint in the RML Request. In other words, the Method is the operation that the browser asks the RP to perform. The currently spported values are listed in the RML Operation List.

The opId value is usually specified in the "triggerConfig.op" property. This is in the "trigger-config" attribute of an Service Trigger HTML Element. (Either a Anchor HTML Element or a Form HTML Element.) The opId value is sent to the RP in the RML Request. (The opId value is copied into the opIdReq property.)

Example ServiceGroup HTML Element:
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup"
 servicegroup-config='{ "challengeTime": 1599876543210,
  "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK",
  "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"},
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
  "mediation": "required"}] }'/>
...
<a href="remere://example.com/remereService?op=setActiveCredentials" rel="servicetrigger"
 trigger-config='{ "op":"setActiveCredentials", "bip":"remere_1" }'>Set Active Credentials</a>

RML Operation List

The list of User Authentication opId values:

These values can be sent to the RP in the RML Request opIdReq property. The value is typically specified in the "triggerConfig.op" property. (In the "trigger-config" attribute of an Service Trigger HTML Element. Usually either Anchor HTML Element or Form HTML Element.)

RML OpId: Value "login"

When used in the triggerConfig.op, this value tells the Remere Login Protocol Handler to log the user in. The handler will EITHER create a login package and a proof of identity and send it to the RP, or it will create a new User Login.

Example Anchor:
<a href="remere://example.com/remereService?op=login" rel="servicetrigger" trigger-config='{ "op":"login", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }'>Login</a>

The browser will select a UserId to login with, and send a proof of identity to the RP in the RML Request. The request tells the RP to login the user with the supplied information.

The RML Request.opIdReq value will be EITHER "login" or "registerUserLogin".

RML OpId: Value "logout"

When used in the triggerConfig.op, this value tells the Remere Login Protocol Handler to log the user out. The handler will create a logout package and send it to the RP.

Example Anchor:
<a href="remere://example.com/remereService?op=logout" rel="servicetrigger" trigger-config='{ "op":"logout", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }'>Logout</a>

The RML Request.opIdReq value will be "logout".

The RP should tear down the user's session or redirect the user. The RP needs to at least refresh the page to remove sensitive information.

RML OpId: Value "loginToggle"

When used in the triggerConfig.op, this value tells the Remere Login Protocol Handler to perform a login toggle operation. If currently logged out, then it will send a "login" request and a proof of identity to the RP. Otherwise it will send a "logout" command.

Example Anchor:
<a href="remere://example.com/remereService?op=loginToggle" rel="servicetrigger" trigger-config='{ "op":"loginToggle", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }'>Login</a>

The RML Request.opIdReq value will be EITHER "login" or "logout".

If currently logged out, then the browser will select a UserId to login with, and send a proof of identity to the RP in the service request. The request tells the RP to login the user with the supplied information.

RML OpId: Value "proveUserPresence"

When used in the triggerConfig.op, this value tells the Remere Login Protocol Handler to perform a "user-presence" operation. Will send proof of user presence to the RP. (force authentication)

Example Anchor:
<a href="remere://example.com/remereService?op=proveUserPresence" rel="servicetrigger" trigger-config='{ "op":"proveUserPresence", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }'>Confirm your presence to see the next page</a>

The RML Request.opIdReq value will be "proveUserPresence".

Tells the browser to send proof of user presence to the RP. Similar to a login. The proof requires user interaction. (force authentication)

This is to prove to the RP that the user is currently using the computer or device. (The user has to touch something or type something.) This takes the place of an RP asking the user to type in their password again, before displaying sensitive information such as credit card numbers. The RP can require proof of user presence at any time.

The "proveUserPresence" value in the RML Request.opIdReq property tells the RP to confirm the "proof of user-presence" results and then to re-authenticate the user. (forced authentication)

The RP may require that user presence be checked before displaying sensitive information. (Before allowing credit card numbers to be changed, etc.) To force the user to confirm their presence, the RP can omit the sensitive data on the page, until the user presence is proved, and then refresh the page or a part of the page.

Proof of user presence is generated by the browser, or by an "authentication device". Such as a Login Manager. This has the device authenticate the user presence through some sort of signature or biometric, etc. The proof contains a timestamp when the user presence was generated. The same proof of user presence can be used at multiple RPs. An RP should generally accept a proof of user presence if the timestamp is less than 2 minutes old.

Possible methods of checking for user presence

A list of all possible ways to prove user presence.

RML OpId: Value "registerUserLogin"

When used in the triggerConfig.op, this value tells the Remere Login Protocol Handler to create a new User Login. The handler will create a "User Login creation" package and send it to the RP.

The RML Request.opIdReq value will be "registerUserLogin". (This command is alternately known as "sign-up". From "login/sign-up".)

The request may contain the new "User Login" information. (The RP can supply a username, or the browser can create one.)

Example Anchor:
<a href="remere://example.com/remereService?op=registerUserLogin" rel="servicetrigger" trigger-config='{ "op":"registerUserLogin", "bip":"remere_1" }'>Sign Up/Register</a>

IMPORTANT: The "registerUserLogin" triggerConfig.op value should generally not be used in HTML pages. The "registerUserLogin" value should generally only be used in the opIdReq property of a RML Request. In HTML pages, it is almost always a better idea to use the "login" value. This is because using the "login" triggerConfig.op value can cause EITHER the "login" or the "registerUserLogin" value in the opIdReq property of the RML Request. Using a "login" triggerConfig.op value leaves the decision of which action to perform up to the browser and/or the user. (Using "registerUserLogin" in an HTML page removes the choice of "login" or "registerUserLogin" from the popup shown to the user.)

Warning. It is usually better to use "login" rather than the "registerUserLogin" value in the HTML triggerConfig.op. (i.e. "login") Because it gives the browser and/or the user the opportunity to *decide* what to do. It can *either* perform a login or create a new User Login. For example, the browser can check if the Login Manager has no stored credentials for the RP, and the user can choose to use one of the existing user logins, instead of simply creating a new User Login.

The "registerUserLogin" value in the RML Request.opIdReq property tells the RP to create a new account for the user, with the supplied information. (Tells it to create a new account using the supplied UserId and the Credential Verification Rule.) (In the future, the user should be able to login with the supplied UserId and appropriate credentials.)

The "userLoginCreation.userIdTypes" property of a service limits what type of identifier can be used to create an account. (e.g. "single_site_userId", "qi:A:H:9:ri", etc.) The property is in the "BiscProfile".

See the full Login Method List.

In order to create an account, the browser must use one of the biscProfile.userLoginCreation createMethods.

RML OpId: Value "placeHold"

When used in the triggerConfig.op, this value tells the Remere Login Protocol Handler to disable the user's account at the RP. (For security) The handler will create a "placeHold" package and send it to the RP.

Example Anchor:
<a href="remere://example.com/remereService?op=placeHold" rel="servicetrigger" trigger-config='{ "op":"placeHold", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }'>Place Hold</a>

The RML Request.opIdReq value will be "placeHold".

Tells the browser to send a "placeHold" request to the RP. Tells the RP to disable logins by the user id. The RP should not allow a login from the UserId until the hold has been removed. ("releaseHold") This can be activated when the user suspects that their password (etc.) has been compromised. Note that this only disables the UserId, it does not necessarily lock or disable the account. (There can be other UserIds that can log into the account.)

RML OpId: Value "releaseHold"

When used in the triggerConfig.op, this value tells the Remere Login Protocol Handler to re-enable the user's account at the RP. The handler will create a "releaseHold" package and send it to the RP.

Example Anchor:
<a href="remere://example.com/remereService?op=releaseHold" rel="servicetrigger" trigger-config='{ "op":"releaseHold", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }'>Remove Hold</a>

The RML Request.opIdReq value will be "releaseHold".

Tells the browser to send an "releaseHold" request to the RP. Tells the RP to remove the hold on the UserId. This requires sending the RP a special code, that is checked against the "backup_credentials ("bkcr")" stored by the RP.

RML OpId: Value "signData"

When used in the triggerConfig.op, this value tells the Remere Login Protocol Handler to sign the form. Only valid when used on an HTML form. The handler will create a "signed-form" package and send it to the RP.

The RML Request.opIdReq value will be "signData". It tells the RP to receive a signed form. (It indicates that the sent value is a signed form.) (See Form Signing)

RML OpId: Value "setActiveCredentials"

Also known as Set User Credential Verification Rules.

When used in the triggerConfig.op, this value tells the Remere Login Protocol Handler to change the user's login credentials. (i.e. passwords or public keys, etc.) The handler will create a "setActiveCredentials" package and send it to the RP.

Example Anchor:
<a href="remere://example.com/remereService?op=setActiveCredentials" rel="servicetrigger" trigger-config='{ "op":"setActiveCredentials", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }'>Set Active Credentials</a>

The RML Request.opIdReq value will be "setActiveCredentials".

This function lets the user change their password or public key. It is analogous to "change user password". If the user's private key is compromised, has a weakness, etc. the Credential Verification Rule can be changed.

The browser will create a RML Request that asks the RP to make changes to the Credential Verification Rules that it stores for the user. The command can add (register) new Credential Verification Data and select which existing CVR are active. (From an existing list.) The request contains a "credRegSec" section. The "credRegSec" section contains two lists, "existing" and "new". The first is a list of ids of existing Credential Verification Rules that should be de-activated (or deleted). The second is a list of new Credential Verification Rules that should be added.

Each of the items in the crList of "new CVR" must have a credentialReg."value (val_r)".

The "setActiveCredentials" opId cannot be used to set the UserId. It can only change the Credential Verification Rule. In order to change the UserId, use "setUserId" opId.

Example RML Request JSON object:
let payload_unencoded = { "requestFormat": "remereRequestFormat 0.1", "protocolId": "remere", "opIdReq": "setActiveCredentials", "sub": "remere_1/setActiveCredentials", "iat": 1503971280, // issuedAt timestamp "exp": 1533064012, // expiresAt timestamp "aud": "RP_example.com", // the audience "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK", // nonce value "cht": 1533064012, // challengeTimestamp "uid": { "rawForLogin": "qi:A:A:2:M4j-q:XSAErLq", // The QIF UserId "usk": "q3jC9-h" }, "user_auth_method": "stored_cred", "redirectUri": "/some/path/page.html", "useCount": 42,
/* The user_id_certificate_chain is absent when using the "stored_cred" uauth_method. // user_id_certificate_chain "uic_chain": [ {"uic.format":"JWS", "uic.csvm":"YY", "ucv": { "payload":"82h7vb...", "signatures": [...] }} ], */
// crProofSection. "crProofSection": { "uid": { "raw2": "qi:A:H:2:xxxxxxxx", // The QIF UserId }, "uapCounter": 42, "cpl": [ { "cid_p": "cd2", "typ_p": "pubkey", "fmt_p": "TBD-CPF", // "format": "TBD-CPF" (not necessary. The default is "TBD-CPF".) "val_p": "mmmm" // base64url encoded JWT or signature. } ] }, // "credRegSec" credentialRegSection. Required for "registerUserLogin" and "setActiveCredentials" opIdReq. "credRegSec": { "backup_credentials": [ { "cid_r": "cd-3", "typ_r": "pubkey", "fmt_r": "JWK", "alg_COSE": -7, "val_r": { ... } } ], "crList": [ { "cid_r": "cd10", "typ_r": "pubkey", "fmt_r": "JWK", "alg_COSE": -7, "val_r": { "kty": "EC", "kid": "cd10", // "kid" is REQUIRED. Same as the "cid_r". "crv": "P-256", "ext":true, "key_ops": ["verify"], "x": "5sy3ogiqTrlC_FF7aOdCq7cNFsN2nbrH4xQmNCCBtso", "y": "ctK7P_LU-SQPf-ejkmC1JYzm7S5N0B6ZX5rwOQWzuv8" } } ] } };

When using "setActiveCredentials", the UserId sent in both the tokens must match the existing UserId stored by the server (the RP).

Note: The credentialProof."value" value (usually a JWT) and the "signatures" are verified by using the Credential Verification Rule (CVR) stored at the RP. (i.e. the stored_cred.) (i.e. The service request is signed with the existing CVR.)

Some of the known Credential Verification Rule (CVR) are a public key fingerprint, or storing the entire public key.

The RP can create a "User Login" with one or more CVR. It doesn't matter whether the account uses a "Locked Id" or a "Single-site UserId". (Such as the username in a regular username and password.) Both types of accounts can potentially have CVR.) Or an account can be created without any CVR at all. In this case, such an account must use a Locked Id. As without a CVR, the "proof of ownership" of the Locked Id is the only way a user can authenticate themselves and login to the account. See the full "Login Method List".

Depending on what abilities the RP offers, a user can:
Example BiscProfile:
serviceItemStart{
  "id": "remere_1",
  "protocolSpec": "remere",
  "endpointBlock": {
    "id":"endpoint_1", "sUri":"/_remere/requestServiceOp.json", "supportedFormats": ["JWS"]
  },
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
  "userLoginCreation": {
    "userIdTypes": ["single_site_userId", "qi:A:H:9:ri"],
    "createMethods": ["assigned_ulc", "claim_ms_ulc"]
  },
  "credentialReg": {
    "passwordTypes": [{"name":"password_s1", "maxLength":14, "storageQuantity":"1"}],
    "publicKeyTypes": [{"name":"pubkey_s1", "JWA_alg":"ES256", "storageQuantity":"1"}]
    // Note that "publicKeyTypes": [{"name":"pubkey_s1", "JWA_alg":"ES256", "storageQuantity":"1"}] is the default.
  },
  "supported": {
    "userAuthScheme": {"methods":["stored_cred", "only_MSUID"]},
    "supported.uic.csvm": ["basic1", "basic2"]
  },
  "requirement_section": {}
}serviceItemEnd
The HTML anchor:
<a href="remere://example.com/remereService?op=setActiveCredentials" rel="servicetrigger" trigger-config='{ "op":"setActiveCredentials", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }'>Change your public key</a>
Example RML Request JSON object:
let payload_unencoded = { "requestFormat": "remereRequestFormat 0.1", "protocolId": "remere", "opIdReq": "setActiveCredentials", "sub": "remere_1/setActiveCredentials", "iat": 1503971280, // issuedAt timestamp "exp": 1533064012, // expiresAt timestamp "aud": "RP_example.com", // the audience "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK", // nonce value "cht": 1533064012, // challengeTimestamp "uid": { "rawForLogin": "qi:A:A:2:M4j-q:XSAErLq", // The QIF UserId "usk": "q3jC9-h" }, "user_auth_method": "stored_cred", "redirectUri": "/some/path/page.html", "useCount": 42,
/* The user_id_certificate_chain is absent when using the "stored_cred" uauth_method. // user_id_certificate_chain "uic_chain": [ {"uic.format":"JWS", "uic.csvm":"YY", "ucv": { "payload":"82h7vb...", "signatures": [...] }} ], */
// crProofSection. "crProofSection": { "uid": { "raw2": "qi:A:H:2:xxxxxxxx", // The QIF UserId }, "uapCounter": 42, "cpl": [ { "cid_p": "cd2", "typ_p": "pubkey", "fmt_p": "TBD-CPF", // "format": "TBD-CPF" (not necessary. The default is "TBD-CPF".) "val_p": "mmmm" // base64url encoded JWT or signature. } ] }, // "credRegSec" credentialRegSection. Required for "registerUserLogin" and "setActiveCredentials" opIdReq. "credRegSec": { "backup_credentials": [ { "cid_r": "cd-3", "typ_r": "pubkey", "fmt_r": "JWK", "alg_COSE": -7, "val_r": { ... } } ], "crList": [ { "cid_r": "cd10", "typ_r": "pubkey", "fmt_r": "JWK", "alg_COSE": -7, "val_r": { "kty": "EC", "kid": "cd10", // "kid" is REQUIRED. Same as the "cid_r". "crv": "P-256", "ext":true, "key_ops": ["verify"], "x": "5sy3ogiqTrlC_FF7aOdCq7cNFsN2nbrH4xQmNCCBtso", "y": "ctK7P_LU-SQPf-ejkmC1JYzm7S5N0B6ZX5rwOQWzuv8" } } ] } }; let RML Request = { "JWS": { "payload": BASE64URL(UTF8(payload_unencoded)), "signatures": [ { "protected": "eyJhbGciOiJFUzI1NiJ9", // protected_header = {"alg":"ES256", "sct":192} "header": { "kid": "cd1", "kid2": "e9bc097a-ce51-4036-9562-d2ade882db0d" // "kid": "userIdPK" // "userIdPK" means the public key is in "uid". }, "signature": "DtEhU3ljbEg8L38VWAfUAqOyKAM6-Xx-F4Ga" } ] } }

The JWT must be signed with the "current" public key.

Note that changing the "Credential Verification Rule" uses the same URL as the site login. This is intentional, so that automated tools can change the user's public key (or other CVR) on multiple sites easily. A browser can remember the URLs used to login to RPs previously. The "remembered RP endpoints" can be called sequentially. With the old CVR and the new CVR in order to replace the CVR stored for the Locked Id at every RP.

RML OpId: Value "setUserId"

Sets the UserId value. When used in the triggerConfig.op, this value tells the Remere Login Protocol Handler to change the UserId. (Done in a single operation.) The handler will create a "setUserId" package and send it to the RP.

Example Anchor:
<a href="remere://example.com/remereService?op=setUserId" rel="servicetrigger" trigger-config='{ "op":"setUserId", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }'>Change UserId</a>

The RML Request.opIdReq value will be "setUserId". The request will also contain a "credRegSec" section. It will contain the user's selected option to create the new user id. It includes the Credential Verification Rules for the new UserId.

This function lets the user change their UserId. It is analogous to "change username". This command can be used if the UserId is ever compromised, stolen, copied, etc.

The user can also change their UserId the long way. By adding a new UserId to the account, as an authorized user. Then changing the "owner" of the account to the new UserId. And then removing the original UserId.

RML OpId: Value "grantAccess"

When used in the triggerConfig.op, this value tells the Remere Login Protocol Handler to grant another UserId access to the user's account at the RP. The handler will create a "grantAccess" package and send it to the RP. It must include a (different) UserId for use with the account. And an account_permission_role.

Example Anchor:
<a href="remere://example.com/remereService?op=grantAccess" rel="servicetrigger" trigger-config='{ "op":"grantAccess", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }'>Grant Access</a>

Important Note! RPs commonly do not provide Service Trigger HTML Elements that use the "grantAccess" opId. However, this does not mean that the RP does not support the "grantAccess" opId. The Remere Login Protocol Handler in a user's browser can be used to create a "grantAccess" RML Request even if the RP does not provide such a Service Trigger.

The RML Request.opIdReq value will be "grantAccess". The request will contain a "grant_user_access" property.

This is how the RP implements the "Account Sharing" feature. Upon activation, the browser creates a RML Request that contains the "grant_user_access" property, and sends it to the RP.

The RML Request tells the RP to give the specified UserId certain access rights to the account. Account owners MUST have an AUTOMATED way of ADDING a UserId to their account, in order to change their own UserId. (Because a UserId or a "User Login" may be compromised.)

Grants or changes the level of account access given to another UserId. The other UserId may be a person or a service. Non-person users can be called "robot" users. The new UserId may be an account the user has at a different RP. Such as an aggregator account, etc.

The "grantAccess" command allows a User to add and remove authorized UserId from their account at the RP. However, it goes one step further. In addition to adding and removing UserId, it also assigns an "account_permission_role" to each authorized UserId. The basic account_permission_roles should exist at every RP. These are "owner", "full" and "none". RPs can optionally implement other account_permission_roles.

The account_permission_roles are, from highest to lowest, owner, full, manager, read-only, restricted2, restricted1, none. Users with higher account_permission_roles cannot be modified by users with lower account_permission_roles. (A user with "full" access cannot be modified by a user with "manager" access, or any lower access.)

The highest account_permission_role is "owner". An "owner" has complete, unrestricted access to everything, and can make any changes. A user with "full" access has almost the same account permissions as an owner (i.e. the account_permission_role), except that he cannot make changes to "owners". A "full" user has full account access and can add, remove and modify most authorized users, but cannot make any changes to users that have "owner" access. A user with "account-only" access can read and change all account settings, (including billing information) but cannot add, remove or modify users. In comparison, a user with "full" account access can also modify other user accounts (but not "owners").

The "none" account_permission_role is used to turn off the account access of a user ID, without removing the user ID from the account. Example: temporarily suspend access of a child, student, employee, or group member, etc. (This can be done as a type of punishment or as a response to a perceived security threat.) The "none" level is also the default level for all pending "authorized users". That is, when an "invitation code" is used by a user ID to add themselves as an "authorized user" to an existing account, those user IDs should have (1) a "pending" status, and (2) an account_permission_role of "none". A manager must explicitly change the account_permission_role of "pending" user IDs. By default they are "none".

The "account_permission_role" to give the other UserId must be specified. For example: (none, limited, read-only, manager, full) Only the "none" and "full" levels are required. The highest account_permission_role is "full". The "full" level is even higher than any "manager" account_permission_role, as "full" access only gives the UserId **access**, it usually does not include the ability to change account access of other UserIds. The "full" account_permission_role may be assigned when the account owner wants to change their UserId, and wants to grant the new "UserId" full account control.

A UserId cannot grant another UserId greater access than it has itself. Additionally, an RP can choose to restrict the "grantAccess" ability to only certain users. An RP can limit it to only a manager of the account (or even to an "owner"). So only a manager of an account can change the access rights of any other UserId.

An RP only needs to implement 2 parts of the "grantAccess" API. The account_permission_roles "owner" and "none". In other words, granting a UserId all account access, and revoking all account access from a UserId. All other account_permission_roles are optional.

OLD SPECIFICATION. These are the two abilities needed to change the account owner's UserId. (The account owner can grant the new UserId access, then login as the new UserId and revoke the old UserId access.) The account owner MUST have an AUTOMATED way of changing their UserId. So that the owner does not have to log in to every RP website to change their UserId. Instead, a script can be run to set the UserId at every RP. However, the RP SHOULD "lock" this feature and mandate additional verification. For example, it can send the account owner an email to verify that they want to grant "owner" access to the other UserIds. An RP may choose to implement additional account_permission_roles other than "owner" and "none", or it may implement such levels through some other interface. (For example, the RP can require the owner to use an HTML page, etc. to grant account access.)

An account MUST have at least one "owner". The "grantAccess" command must NOT reduce access of a UserId if that UserId is the only "owner" on the account. Such an attempt will result in an error.

Works with the "account_permission_role" option. Can choose to grant a UserId less than "owner" access.

For example: a mother may give "read-only access" to her music account to her daughter. Such access SHOULD not allow the daughter to access credit card information or make any purchases. If the daughter performs "grantAccess", nothing will happen to the mother's account, because the daughter does not have the ability to "grantAccess" to the mother's account to other UserIds.

The "new UserId" cannot be the same as the current UserId. This command can be locked for safety purposes. It may need an email verification, etc. This is also the first step in changing the UserId of the account owner. (The username the owner logs in as at the RP.)

Changes to the HTML specification. Detail

This specification defines a few changes to the HTML specification. It adds a few new HTML attributes to existing HTML elements.

List of changed HTML Elements.

These elements allow RPs to embed BiscGroup data (about Remote Services) within HTML markup. (User authentication is one such service.) RP websites should modify their HTML pages to use the new ServiceGroup HTML Element and Anchor HTML Element instead of a login form. These HTML elements have a few new HTML attributes. The attributes are rel="servicegroup" and "servicegroup-config". The "servicegroup-config" attribute contains a BiscGroup. This is usually written as a single modified-for-HTML JSON object. RP websites can use this attribute to give the browser additional data or instructions. Such as user authentication information. Note that using the new type of HTML element does not require javascript. The RP does not have to include any javascript code in its web pages, and the browser is not required to have javascript enabled for the RP.

The ServiceGroup HTML Element is the primary means for RPs to communicate user authentication information to browsers within HTML markup. A Capis compliant HTML page MUST have a proper ServiceGroup HTML Element in it. The Anchor HTML Element and Form HTML Elements are secondary means, and are optional. They are designed to be used in conjunction with the ServiceGroup HTML Element. As a result of their secondary nature, there are only a few "trigger-config" properties allowed in an anchor and form. These are the RML TriggerConfig properties. (The Capis Anchor allows the "triggerConfig.op" and the "onSuccess.itemN.redirectUri" properties.)

A Capis compliant HTML page MUST have a ServiceGroup HTML Element in it. The purpose is to allow the browser, in the future, to use the hidden HTML element to display the user authentication information in the browser chrome. (i.e. The RP login status and command buttons.) The items do not have to be visible in the HTML page at all. For example, the browser chrome can contain a "login" button, and a "logoutAll" button, etc. Alternatively, the browser chrome can contain a combined "login/logout" button. It would track the login state at the RP, and change its label and opId between "login" and "logout".

If a browser understands the Capis specification, then the Service Trigger HTML Elements (i.e. Service Trigger HTML Elements) will behave differently than normal. For example, if a Anchor HTML Element is clicked, the browser will not use the "href" attribute. It will not load the URL that it contains. Instead, it will perform the Capis Service Invocation Protocol. (i.e. The browser will call the CapisControl.activateTrigger function. That will perform the operation specified by the triggerConfig.op property.) The "href" attribute is used exclusively as a "fallback" behavior. Only older browsers that do not understand the Capis specification will use it.

The ServiceGroup HTML Element has two special HTML attributes. The attribute "servicegroup-config" contains BiscGroup, and the attribute rel="servicegroup" is the tag that marks the element. It identifies the element's role, and gives it a special behavior.

In order to support older browsers, the HTML pages at the fallback URLs will need to contain traditional login forms, etc. (Similarly, the Form HTML Element uses the "action" attribute as a fallback behavior. The ServiceGroup HTML Element uses its "href" attribute to point to the Bisc Site Document.)

Examples of Service Trigger HTML Elements:
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup"
 servicegroup-config='{ "challengeTime": 1599876543210,
  "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK",
  "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"},
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
  "mediation": "required"}] }'/>
...
<a href="remere://example.com/remereService?op=login" rel="servicetrigger"
 trigger-config='{ "op":"login", "bip":"remere_1" }'>Login</a>
...
<a href="remere://example.com/remereService?op=logout" rel="servicetrigger"
 trigger-config='{ "op":"logout", "bip":"remere_1" }'>Log OUT</a>
...
<a href="remere://example.com/remereService?op=proveUserPresence" rel="servicetrigger"
 trigger-config='{ "op":"proveUserPresence", "bip":"remere_1" }'>Confirm my presence</a>
...
<a href="remere://example.com/remereService?op=setActiveCredentials" rel="servicetrigger"
 trigger-config='{ "op":"", "bip":"remere_1setActiveCredentials" }'>Set Active Credentials</a>
...
<form action="remere://example.com/remereService?op=login" rel="servicetrigger"
 trigger-config='{ "op":"registerUserLogin", "bip":"remere_1" }' onsubmit="return validateForm1()">
...
</form>

Using the (rel="servicetrigger") attribute does two things. It marks the HTML element as performing a Capis Trigger Behavior, and it causes the element to behave differently. The elements will perform a special Capis Trigger Behavior instead of their normal behavior. Clicking on a Anchor HTML Element SHOULD NOT cause the browser to follow the href value. (i.e. To send an HTTP GET command to the "href" URI in the anchor.) Instead, the browser should perform the Capis Service Invocation Protocol. (i.e. Retrieve the Bisc Site Document, and perform the triggerConfig.op property specified in the "servicegroup-config" attribute.) For user authentication, this will send a RML Request (via an HTTP POST) to the "Service Endpoint" specified in the Bisc Site Document.

The Anchor HTML Elements and Form HTML Elements SHOULD NOT use their "href" and "action" attributes, respectively. Because of this, these attributes can instead be used as a trap to detect older browsers that do not support this specification. The URI used in the "href" attribute should link to an error page or a fallback operation at the RP website. (Or some other website the RP trusts to do the fallback operation.) The web service at the linked URI could attempt an alternative login operation, or display an error message to the user. Such an error message may be something like: "Your browser does not support the Capis specification. Please do xyz."

Capis HTML Attributes

This specification defines a few new HTML attributes. They can be applied to the anchor, form and link elements. (To create a ServiceGroup HTML Element.)

List of Capis HTML attributes.

Currently, only the anchor and form HTML elements can be marked as Service Trigger HTML Elements. The Service Trigger HTML Elements use a special value for the "rel" attribute. The ServiceGroup HTML Element element uses rel="servicegroup". The Anchor HTML Element uses rel="servicetrigger". And Form HTML Element element uses rel="servicetrigger".

HTML elements that are "marked" with the special HTML attribute will perform a special behavior, the Capis Trigger Behavior, instead of its normal behavior. These HTML elements DO NOT use their "href" or "action" attributes. (i.e. A Anchor HTML Element will not use the "href" attribute and will not perform a web page redirect. A Form HTML Element will not use the "action" attribute and will not perform a regular form submission.) Developers should set these attributes to an error page or a secondary "fallback" login behavior. This will detect older browsers that do not support Service Trigger HTML Elements.

Examples of Service Trigger HTML Elements:
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup"
 servicegroup-config='{ "challengeTime": 1599876543210,
  "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK",
  "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"},
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
  "mediation": "required"}] }'/>
...
<a href="remere://example.com/remereService?op=login" rel="servicetrigger"
 trigger-config='{ "op":"login", "bip":"remere_1" }'>Login</a>
...
<form action="remere://example.com/remereService?op=login" rel="servicetrigger"
 trigger-config='{ "op":"", "bip":"remere_1registerUserLogin" }' onsubmit="return validateForm1()">
...
</form>

Anchor HTML Element detail

An Anchor HTML Element can be used as a Service Trigger HTML Element. To do this, it needs two things. (1) A (rel="servicetrigger") attribute. And (2) a trigger-config attribute that contains a Trigger Configuration. These attributes are used for the Capis Service Invocation Protocol.

Anchor HTML Element - Attribute: rel="servicetrigger"

rel="servicetrigger"
Used on Anchor HTML Elements. It marks the element as being a Service Trigger HTML Element. It marks the element as performing a Capis Trigger Behavior. This overrides its normal behavior.

Anchor HTML Element - Attribute: href

href="url"

The href attribute is used exclusively as a fallback for older browsers that do not understand Capis. Used on Anchor HTML Elements.

The Service Trigger HTML Elements behave differently than normal. For example, if a Anchor HTML Element is clicked, browsers that understand this specification will perform the Capis Service Invocation Protocol. (i.e. The browser will perform the CapisControl.activateTrigger.) The browser will not use the "href" attribute of the Anchor HTML Elements. The "href" attribute is used exclusively as a "fallback" behavior. Only older browsers that do not understand Capis will use it. (i.e. If the browser does not understand the new attribute rel="servicetrigger".)

It will perform a Capis Trigger Behavior. This overrides its normal behavior.

<a href="remere://example.com/remereService?op=login" rel="servicetrigger"
 trigger-config='{ "op":"login", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }'>Login</a>

Anchor HTML Element - Attribute: trigger-config (longName: "fubar")

Type Object. Required. (A value must be specified.)

Contains Trigger Configuration. (A single modified-for-HTML JSON object.) Used on Anchor HTML Elements.

The "trigger-config" attribute is REQUIRED if the HTML element has the rel="servicetrigger" attribute. Because the anchor MUST contain a Trigger Configuration, which MUST contain the triggerConfig.op property.

The modified-for-HTML JSON format is modified for being used inside an HTML attribute. The difference from standard JSON is that it allows property names and string values to be enclosed with the "caret" character in addition to the double quote character. This format was added for convenience, because HTML attribute values can be double quoted, and that interferes with standard JSON string quoting. (Internally, all caret characters in the attribute value are simply converted into double quote characters. In order to include a caret character, use the percent encoding "%caret;".)

In order to include a double quote mark in a JSON property name or string value, prefix it with a backslash. HTML entity encoding can also be used. Single Quote (') = (&apos;) Double Quote (") = (&quot;) Less than (<) = (&lt;) Greater than (>) = (&gt;)

Example Anchor:
<a href="remere://example.com/remereService?op=login" rel="servicetrigger" trigger-config='{ "op":"login", "bip":"remere_1", "test":"Eat at Lefty&apos;s in \"Smallville\"!", "onSuccess":[{"redirectUri": "/some/path/page.html"}] }'>Login</a>
Example Anchor using caret quote characters:
<a href="remere://example.com/remereService?op=login" rel="servicetrigger" trigger-config="{ ^op^: ^login^, ^bip^:^remere_1^, ^test^:^Eat at Lefty's in \^Smallville\^!^, ^onSuccess^:{^redirectUri^: ^/some/path/page.html^} }">Login</a>

Form HTML Element detail

A Form HTML Element can be used as a Service Trigger HTML Element. To do this, it needs two things. (1) A (rel="servicetrigger") attribute. And (2) a trigger-config attribute that contains a Trigger Configuration. These attributes are used for the Capis Service Invocation Protocol.

Form HTML Element - Attribute: rel="servicetrigger"

rel="servicetrigger"
Used on Form HTML Elements. It marks the element as being a Service Trigger HTML Element. It marks the element as performing a Capis Trigger Behavior. This overrides its normal behavior.

Form HTML Element - Attribute: action

action="url"
Same as the Anchor href attribute. It's used exclusively as a fallback for older browsers that do not understand Capis.
<form action="remere://example.com/remereService?op=signForm" rel="servicetrigger"
 trigger-config='{ "op":"", "bip":"remere_1signData" }'>
  <input type="text" name="first_name" placeholder="Enter your first name" />
  <input type="text" name="user_email" placeholder="Enter your email address" />
  <input type="submit" value="Sign and Submit the Form" />
</form>

Form HTML Element - Attribute: trigger-config

Type Object. Required. (A value must be specified.)

See general-attribute trigger-config

Default Location of the BiscSiteDocument

The default location of the Bisc Site Document is to use the "well-known" URI.

The "well-known" URI of the Bisc Site Document is created by appending "/.well-known/capisBiscSiteDoc.json" to the HTTPS version of the page origin. Example: "https://RP_example.com:port/.well-known/capisBiscSiteDoc.json" (Note that the "well-known" URI uses "https", and can have a port number.)

The default location is used if the "href" attribute of the ServiceGroup HTML Element is missing or invalid.

Note that if a "biscSiteDocUri" is used that does not have a path component, (does not contain anything after the domain name. Not even a "/" character.), then the biscSiteDocUri that is used also appends the "/.well-known/capisBiscSiteDoc.json" string.

See the other Capis Default Values.

User Login Detail

A User Login is the data needed for a user to login to an RP. (i.e. To authenticate a user to an RP.) It is also a name for the stored "user identity" at the RP. (A "user identity" may not be the same as an "account" at the RP, as multiple users may be able to log into a single account. See Account Sharing.) In general, it is the combination of (1) a unique user identifier (i.e. a UserId) at the RP and (2) some means for the user to prove ownership of (or authorized use of) the user identifier.

A User Login has at least five types of components, although some may be omitted. (1) The RP id. (In Remere Login it stores the sapId instead.) (2) A user identifier. (i.e. a UserId) (3) A set of "secrets" known only to the user. (i.e. Credential Sources. Such as private keys or passwords.) (4) A set of "user secret verification data" stored by the RP. (i.e. Credential Verification Rules. A way for the RP to verify the user has the secrets.) (5) A UserId binding document (or a database entry at the RP). This associates the UserId with the "user secret verification data". Special Note, a "username and password" is a simple User Login, where the password serves as both the "secret" and the "user secret verification data". A more advanced version can also add a "backup_credential ("bkcr")" key pair, a "login counter", and a "last use timestamp". (See "User Login").

In order to sign-in, the user generates a "proof of identity" from their secrets, and sends the proof to the RP. The RP receives the proof, retrieves the Credential Verification Rules for the UserId (by using the binding), and then verifies the proof against the CVR.

There is a type of User Login, known as Federated UserId, where the RP uses an intermediary to verify the user. This intermediary is called an identity provider. This type of User Login requires that the RP trust the identity provider. With this type of User Login, the user provides some type of proof to the RP, and the RP checks that the identity provider verifies the proof. (Note that the user proof contains the UserId. Also, the UserId typically contains (or otherwise references) the domain name of the identity provider.) The user proof can be verified in 2 ways. (1) The RP submits the user proof to the identity provider, and lets the identity provider validate the proof. (This gives the UserId to the identity provider, allowing it to track when it is used, and by which RP.) Or (2) the RP can verify the user proof itself, using the identity provider's public keys, etc. (i.e. This requires that the user proof contain digital signature(s). The RP retrieves the set of public keys from the identity provider. It does not give the identity provider the UserId.) In this case, the user proof must include a document that "binds" the UserId to a set of "Credential Verification Rules". And this document must be signed by the identity provider. (It may be indirectly signed, and include a certificate chain. etc.) This document is typically a UserId certificate. It can be minutes old, or months old. It gives the RP the Credential Verification Rules, and then the RP can evaluate if the user provided proof-of-identity meets the requirements of the Credential Verification Rules.

Storing User Logins at an RP.

An RP must store User Logins in order to authenticate its users. An RP may store User Logins either inside individual accounts, or outside of accounts, in a "User Table" (it may give it some other name). The downside to storing User Logins inside accounts is: (1) A user must identify the account they are trying to access before logging in. (2) It does not allow Account Sharing. For maximum effect, the RP will need to store User Login information *outside of* accounts. (in a User Table inside a database, etc.) This is one way of providing two features. It provides a way for an RP to allow multiple users to access the same account, and it provides a way for an RP to allow a single user to access multiple accounts. For both of these features, each user will need their own UserId and Credential Verification Rules. Rather than storing these in multiple locations (in multiple accounts), the User Login can be stored in a location distinct from the accounts.

User_id Binding Method. Binding CVR to User_id

A "binding method" is a means of proving an association between a UserId and a set of Credential Verification Rules (such as public keys). It is a required part of a User Login. A simple example of a "binding method" is an entry in a database at the RP, where the RP stores a UserId and a list of the associated Credential Verification Rules. Another example is a UserId Binding Document.

User_id Binding Document

A small document that contains a UserId and a set of Credential Verification Rules. This associates the two items (the UserId and the various CVR) and "binds" them together. It is an example of a "binding method". In the case of such a "binding document" created by one entity and used by another, the document must contain a cryptographic signature from a reliable source, so that it cannot be faked. An example of this is a "UserId certificate", created by a Backer.

User Identifier Types (UserId Types)

A "user identifier type" is either a "Single-site UserId" or a namespace and type of a Locked Id. For example, "single_site_userId", "qi:A:H:9:ri" or "qi:A:H:9", etc. An RP can choose to trust only QIF identifiers in the "A9" namespace, or only "A9" namespace and a certain subtype (such as "ri"), etc.

An RP declares what types of UserId it supports in the "userLoginCreation.userIdTypes" property. A complete "supported type description" might include the UserId format, only certain issuers of "UserId certificate"s, a communication protocol, etc.

To login to an RP, a user must prove they are who they claim to be. Several ways to do this are: to prove access to a shared secret, such as with a password, or prove possession of a private key, or by proving ownership of a user identifier. It can prove ownership either directly, by cryptography (QIF "qi:A:H:"), or by using a host or backer of the identifier.

Values for an RP "userLoginCreation.userIdTypes".

single_site_userId value:

The "single_site_userId" value means that the RP supports browsers sending a "Single-site UserId" to login. This means that the RP must be capable of storing some kind of Credential Verification Rule (CVR) values for its users. (e.g. a password, or public key, etc.) When the RP receives the "proof of identity", it will validate the proof using the Credential Verification Rule stored for the claimed UserId. The storage of CVR values is required when browsers do not have to send a Locked Id to the RP. Because the RP cannot rely on the lock mechanism inside the Locked Id during the user verification process. (Since it may not exist.)

An RP can add a CVR to any UserId type. For example to single-site, Federated UserId or Self-contained. If the RP (1) accepts Single-site UserIds then it must (2) store Credential Verification Rule for its users.

Multi-Site UserId detail

There are two main types of Locked Id, Self-contained and Federated UserId. The difference is where the lock requirements are stored. A "Self-contained UserId" contains the requirements inside itself. This is usually some sort of cryptographic key or signature. (For an example, see the "A:H:1" QIF type.) A Federated UserId stores the lock requirements online at a third-party. At a Backer, Identifier Authorization Provider or Identity Provider

Multi-Site UserIds require cooperation from RPs. A compliant RP MUST NOT register a Locked Id to any of its users, unless the user can unlock the ID. That proves that the user satisfies the identifier's lock requirements. (i.e. An RP must not allow the creation of an account that uses a Multi-Site UserId, without verifying that the user satisfies that identifier's lock requirements.) This is the primary reason why the "type" of Multi-Site UserIds must be easy to read, and why they must be easy to distinguish from Single-site UserIds. For easy RP compliance. If an RP does not support an identifier's lock method, then the RP must not allow the use of that type of identifier. (Locked Ids could alternately be called "Multi-site UserId" or "requirements UserId", etc.)

In order to make RP compliance easier, Multi-Site UserIds MUST have an easy-to-identify "format" and "type". This makes Multi-Site UserIds easy to distinguish from Single-site UserIds. The "type" clearly identifies what Identifier Lock Id the identifier uses, and the method of user-verification that it uses. The QIF standard is one such format.

During both login and "create account" attempts, the user gives the Multi-site UserId to the RP. The RP will extract the "type ID" from inside the UserId. (If the UserId is a Federated UserId then the RP will also extract the "Backer Id".) Note that the "type ID" may be inferred from the format of the UserId. For example, an email address format will use an email address "type ID".

Then the RP will confirm that the user "owns" the UserId. For a Federated UserId, the RP will execute the Federated UV Method, and have it validate the documents provided by the user during the login attempt. Then the RP must find the Backer VM for the type ID and Backer.

If the UserId is a Self-contained User_id, then the RP will need to parse the UserId into something, or extract data from inside the UserId. (For example, it can be parsed into a public key.) The RP will then use the result to validate the user. The RP uses the "type ID" to determine what to parse the User_id into.

========

A "Federated UserId" uses some type of online host. The UserId must contain a "Backer Id" and a "registration ID". The "Backer Id" represents an organization. The "registration ID" represents the user or resource at the organization. Each Backed UserId must contain a distinct "registration ID".

A Backer must have some way to authenticate its users. It may issue a certificate or require users to login, etc. If the Backer generates a timestamped "proof of login", then all UserIds that use that Backer are "Federated UserIds". A Federated UserId will issue a "user_account" or the UserId requirements that users must meet in order to use the UserId, etc. The UserId itself only needs to contain a "Backer Id" and a "registration id". For Example: an email address is a "Federated UserId". The "domain name" is the "Backer Id", and the "user account name" is the "registration id". The server running the email system (i.e. the "Backer") can be used to verify if a user has access to the UserId.

A "Federated UserId" usually depends on the Backer continuing to behave correctly. Although, a specially designed registration systems can have UserId that only need a working Backer during their creation. But this is unusual.

This category of UserId is (1) universally unique, (2) persistent across all RP (it identifies the same user at all RP), (3) allowed access is provable, (4) its use is restricted at RPs, (5) can only be used by the "owner". RPs are required to obtain proof of ownership from a user before allowing the user to use it.

A Locked Id is capable of being used at multiple websites. However, this does not mean that it MUST be used at multiple websites. For privacy reasons, it might be preferable to use a different Locked Id at each RP website.

RPs must not register a Locked Id to any of its users, unless the user can unlock the ID. i.e. Prove he owns it. In this manner, the UserId is guaranteed to be available at an RP for the owner to use. A single user can have multiple "Locked Id". Each one can be used independently.

A "Locked Id" generally comes in one of two forms. Either the UserId contains the result of some sort of cryptographic "one-way function", (like a "public key"), or it contains the "PermanentBackerId" of the entity that created it. This allows a verifier to identify the Backer of a UserId. (The "host" can also be known as the "issuer" of the UserId.) The verifier can contact the Backer, to request that it provide some sort of additional information about the user that it issued the UserId to. The Backer can give the RP a verification requirement, such as a public key. Or the Backer can verify the user itself, and give to the RP an assertion that the user is the owner of the UserId. (This last option is typically called a "Federated UserId". Where the RP must trust the "assertion" created by the "issuer" of the UserId.)

In order for "Locked Id" to work correctly, their use must be restricted at all RP. A Multi-Site UserId must never be used by anyone other than the "owner". This means that all conforming RP MUST (1) recognize Locked Id and (2) not allow the use of a Locked Id by anyone other than the owner. (i.e. An RP must not register a Locked Id to any of its users, unless the user can unlock the ID.)

In order for a "Locked Id" to work correctly, there MUST be a way for RP to verify a user's claims of owning the UserId. For Federated UserId, there must be a Backer VM for the type of federated UserId. And it must be "findable" by all RPs.

For example, a "universally unique" Federated UserId can be created by combining any "Single-site UserId" with the domain name of the RP where it is used. However, In order for those identifiers to be a Federated UserId, there must be a Backer VM for that type of federated UserId. And it must be "findable" by all RPs. If it is not "findable" by all RPs, then the UserId is not a "working" "Locked Id".

Using a Locked Id skips the hardest part of traditional User Login creation, having the user find (and remember) an unused Single-site UserId. With the traditional means of a username and password, creating an account at an RP requires the user to find an unused username at the RP.

When creating a new account with a Locked Id, the user does not have to "find an available id" at the RP, as the "UserId" is reserved for his exclusive use, at every RP. All RPs must restrict use of a Locked Id to only the party that can provide proof of ownership. Thus, a Locked Id functions as a "reserved username" at all RPs. When using a Locked Id, an account can be created automatically, without user intervention or negotiation with the RP. However, an RP SHOULD NOT automatically create an account for a Locked Id in response to a login RML Request. (i.e. When a user tries to login with a Multi-Site UserId, and the RP has VERIFIED that the user owns the UserId, but the RP does not have an account for that UserId.) Confirmation from the user is required before User Login creation. (To prevent User Login creation due to user error. For example, if the user accidentally selected the wrong User Login to log in with, etc.) See User Login creation.

Multi-Credential Authentication

Multiple Credential Authentication is when an RP requires proof of multiple credentials in order to authenticate a user. Each credential can be of any type. (password, private key signature, fingerprint, PIN, etc.) (See Multi-Credential definition.)

Multiple Credential Authentication allows RPs to combine multiple authentication mechanisms to authenticate a user. Such as fingerprint + PIN. For example, a bank may want to have very strict requirements for logging in. It may want a HOTP code in addition to a regular password. Or a fingerprint in addition to both the HOTP code and password.

Note that multi-factor authentication is a subset of Multiple Credential Authentication. Each "factor" can be transmitted to the RP as a different type of credential. (Also note that 2nd factor authentication, U2F, etc. are forms of Multiple Credential Authentication.)

An RP website can store various Credential Verification Rules to authenticate a user. The RP can require multiple credentials before it will authenticate a user. (These things do not require Multiple Credential Authentication.)

Using "Multiple Credential Authentication", an RP is able to list what credentials it requires. (These credentials can be "authentication factors".) Using "Multiple Credential Authentication", the browser is able to deliver to the RP, in a single request, all the required credentials. This lets RPs create their own security requirements. They can mix different existing standards. (Or even create their own.)

Multiple Credential Authentication is implemented in the RML Request sent from the browser to the RP. The request normally includes both (1) a signatures section (for private key signatures), and (2) a credentialProofList section (for all other types of credential proof). The "set credentials" version of the request also includes a list of Credential Verification Rules, which is used to deliver to the RP the list of Credential Verification Rules that the RP should store. Note that each credential in the list can be of a different type. And new types of credentials can be created. The only requirement is that both the RP and the Login Manager support the new credential type.

An RP can even do more complicated things, like define a set of credentials and require a minimum number of them. For example, it can require that a user provide proof of 3 out of 4 credentials in the set.

Multi-Factor Authentication

Multi-factor authentication is where an RP verifies a user's identity by requiring two or more "factors" of authentication. The three types of authentication factors are something you know, something you have, and something you are. Something you know can be something like a password or PIN. Something you have can be a mobile phone or a special USB key. And something you are can be something like your fingerprint or other biometric identifier.

A prerequisite of "Multi-factor" authentication is Multi-Credential Authentication. (i.e. that a login may require multiple credentials.) In addition to multiple credentials, Multi-factor also requires that a type of credential exist for each type of factor that the RP requires. The user can send proof of all the required "factors" to the RP at the same time, using multiple credentials.

For example, an RP can require the user type in a password, have a USB key, and scan their fingerprint. Proof of all of these "factors" can be sent to the RP using credentials. The USB key can contain a private key or implement a full Login Manager API. (i.e. send a private key signature to the RP.) A Login Manager (or browser) can use cryptography to create a private key out of the password. (i.e. send a private key signature to the RP.) A User Authenticator or browser can scan a fingerprint and send it to the RP.

User Authentication Detail

User Authentication is the process by which a user's identity is verified. It is the process by which a user "signs in" to a website. In order to login to an RP, a user must prove their identity to the RP. Typically, a user submits a "proof of identity" to the RP. This "proof" may be as simple as a username and password. An RP may store a Credential Verification Rule (CVR) in order to authenticate a user. This list of CVR. The RP typically requires that the "proof of identity" must satisfy some subset of the CVR criteria in order to be valid. (e.g. during an attempt to login to the RP.) An algorithm that uses the set of CVR to verify a "proof of identity" is called an "identity verifier".

The CVR can consist of a public key, a password, a certificate, an algorithm, a database record, a website response, etc. See the RP User Authentication Process. An RP usually stores different CVR for each user identity in an internal database record. The RP may allow a user to add, remove, or set the CVR for themselves. (For example, an RP can allow a user to change their password.) See the "setActiveCredentials" opId. For example, an RP may allow a user to turn on and off Multi-factor authentication.

A "Credential Verification Rule" is usually the opposite of a "credential". A "CVR" is a test for a required condition, while a "credential" is proof of a condition. (However, in the case of a "password", both could be the same value.)
Each CVR must have an associated "type" or "Credential Verification Method". This "type", or algorithm, defines how to verify if a "proof of identity" satisfies the CVR requirement. For example, If the CVR is a public key, then the "type" of the CVR denotes what format the key is in, and how to verify if a digital signature was created by the matching private key. An RP must know the "Credential Verification Method" for each type of CVR it supports. An RP can publish what types of Credential Verification Rule it supports in the BiscProfile.credentialReg property.
There are two main types of Credential Verification Rule (CVR). There is "Site-specific" (i.e. Regular) and "multi-site". CVR are only applicable to a single RP. They are usually a type of "password" or "public key" and are usually stored in a database at the RP website. An RP is free to use any type of CVR it wants, and that browsers support. The "Multi-site UserId Credential Verification Rule" are applicable to all RPs. They are not "tied to" or limited to a single RP.

RML Request: Set Credential Verification Rules Detail

The RML Request, sent from the browser to the RP, can contain a list of Credential Verification Rules. (i.e. called the crList.) This list is how the user delivers to the RP the set of Credential Verification Rules that the RP should store for future user authentication.

The RP stores a set of "Credential Verification Rules" for each user. It uses these CVR to verify the credentials sent to it during login. (i.e. during the authentication process.) The user sets what CVR the RP stores by using the "setActiveCredentials" command. (i.e. It performs similar to a "change password" operation on systems that use a username and password.)

The list of CVR is located in the "credRegSec" section of the RML Request. (i.e. In the "credRegSec" object.) This allows the user to set all the CVR in a single request.

Note that each Credential Verification Rule (both stored by the RP, and in the crList) can be of a different credential type. And new types of credentials can be created. The only requirement is that both the RP and the Login Manager support the new credential type. The mix of different types stored by the RP allows it to support Multi-Credential Authentication and Multi-factor authentication.

The RML Request can also contain multiple "credential proofs". This is for user authentication, when a user wants to login. (i.e. It can be used to perform Multi-Credential Authentication.) This is how browsers can send multiple user credential proofs to an RP, all in the same request. The service request has two different sections for proofs, (1) the signatures section, for private key signatures, and (2) the credentialProofList section, for all other types of credential proof.

The "signatures" object can hold the signatures for multiple "public key" type credentials. The credentials can be digital signatures (i.e. public key cryptography) or they can be keys generated from passwords or federated credentials. Note that EACH signature in the "signatures" object has has digitally signed the entire payload of the Service Request. The RML Request values, "opIdReq" or "exp", etc. cannot be changed without generating a new signature. Because of this, signatures are preferred over other types of proof.

The "credentialProofList" section can hold the proof for any credential that is not a public key. It can contain multiple "credentialProof." objects of different types. Use the credentialProof."format (fmt_p)" property to hold the type of proof.

Example RML Request JSON object:
let payload_unencoded = { "requestFormat": "remereRequestFormat 0.1", "protocolId": "remere", "opIdReq": "login", "sub": "remere_1/login", "iat": 1503971280, // issuedAt timestamp "exp": 1533064012, // expiresAt timestamp "aud": "RP_example.com", // the audience "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK", // nonce value "cht": 1533064012, // challengeTimestamp "uid": { "encReqValue": "xxxxxxxx", "rawForLogin": "qi:A:F1:1:ACMA_org:M4j-q", // The QIF UserId "encForLogin": "q3jC9-h" // Use "encForLogin" with "login" opId. }, "user_auth_method": "only_MSUID", "redirectUri": "/some/path/page.html", "useCount": 42,
// user_id_certificate_chain (Not available when using the "stored_cred" uauth_method.) "uic_chain": [ {"uic.format":"JWS", "uic.csvm":"YY", "ucv": { "payload":"82h7vb...", "signatures": [...] }} ],
// crProofSection. "crProofSection": { "uid": { "raw2": "qi:A:H:2:xxxxxxxx", // The QIF UserId }, "uapCounter": 42, "cpl": [ { "cid_p": "cd2", "typ_p": "pubkey", "fmt_p": "TBD-CPF", // "format": "TBD-CPF" (not necessary. The default is "TBD-CPF".) "val_p": "mmmm" // base64url encoded JWT or signature. } ] }, /* "credRegSec" credentialRegSection. Not required for "login" opIdReq. "credRegSec": { "backup_credentials": [ { "cid_r": "cd-3", "typ_r": "pubkey", "fmt_r": "JWK", "alg_COSE": -7, "val_r": { ... } } ], "crList": [ { "cid_r": "cd10", "typ_r": "pubkey", "fmt_r": "JWK", "alg_COSE": -7, "val_r": { "kty": "EC", "kid": "cd10", // "kid" is REQUIRED. Same as the "cid_r". "crv": "P-256", "ext":true, "key_ops": ["verify"], "x": "5sy3ogiqTrlC_FF7aOdCq7cNFsN2nbrH4xQmNCCBtso", "y": "ctK7P_LU-SQPf-ejkmC1JYzm7S5N0B6ZX5rwOQWzuv8" } } ] } */ }; let RML Request = { "JWS": { "payload": BASE64URL(UTF8(payload_unencoded)), "signatures": [ { "protected": "eyJhbGciOiJFUzI1NiJ9", // protected_header = {"alg":"ES256", "sct":192} "header": { "kid": "cd1", "kid2": "e9bc097a-ce51-4036-9562-d2ade882db0d" }, "signature": "DtEhU3ljbEg8L38VWAfUAqOyKAM6-Xx-F4Ga" }, { "protected": "eyJhbGciOiJFUzI1NiJ9", // protected_header = {"alg":"ES256", "sct":13} "header": { "kid": "userIdPK" // "userIdPK" means the public key is in "uid". }, "signature": "MG4mdj-hdfYHqJRnUxKa6e ..." }] } }
The "UserId certificate" JWT. (uid_cert_chain[0]) header and claims:
let payload_unencoded = { "sub2": "remere_1/certificate", "iss": "id_registrar.example.com", // The Backer "iat": 1503971280, "exp": 1533064012, "sub": "qi:A:F1:1:ACMA_org:M4j-q", // The QIF UserId. "uid": { "rawForLogin": "qi:A:F1:1:ACMA_org:M4j-q", // The QIF UserId. "usk": "q3jC9-h" }, "cert_pubKeyList": [ { "kty": "RSA", "kid": "f85762a7f52c8346", "alg": "RS256", "n" : "4b9e34...", "e" : "93bc32..." } ] } let jws_certificate = { "payload": BASE64URL(UTF8(payload_unencoded)), "signatures": [{ "protected": "eyJhbGciOiJSUzI1NiJ9", // protected_header = {"alg":"RS256", "sct":192} "header": { "alg": "RS256", "kid": "bf4a76332a6c8370f48", // "kid" is REQUIRED. ID of the issuer key. // "csvm": "OIDCD" // Get the sig verification key from the issuer via "OIDCD", etc. "csvm": "idr_keystore" // Get the sig verification key from an "Backer keystore". }, "signature": "DtEhU3ljbEg8L38VWAfUAqOyKAM6-Xx-F4Ga" }] }

Capis Configuration Options Detail

Capis Configuration Options are a collection of JSON-like data values published by an RP to configure a browser's behavior at the RP. They are an alternative to an HTML page using Javascript to control how the browser behaves. The options are commonly embedded within HTML markup as a single modified-for-HTML JSON object in the "servicegroup-config" attribute of a ServiceGroup HTML Element. Or in a Bisc Site Document. The options give the browser data or instructions about Remote Services without using javascript. This makes creating Capis enabled HTML easier, and Capis will work without requiring the browser to enable javascript for the RP.

There are two different types of Capis Configuration Options in HTML. First, the a BiscGroup are those configuration options in a ServiceGroup HTML Element. (i.e. In the "servicegroup-config" attribute.) They apply to the entire HTML page. Second, the Trigger Configuration are those configuration options in all Service Trigger HTML elements. They are only applicable to that single HTML element. (For Example, in a Anchor HTML Element "trigger-config" attribute.)

In order for Capis to work, an HTML page MUST contain a ServiceGroup HTML Element. And the BiscGroup MUST contain at least the "challenge" property.

All the options in the "servicegroup-config" attribute of a ServiceGroup HTML Element are written as a single modified-for-HTML JSON object. {name:value, name:value} The object will be used as input to one of the Capis API functions. For Trigger Options, it will be used as a CapisControl.invokeServiceAction callOptions value, and will be passed as input to the Capis Control.invokeServiceAction function.

An RP can put multiple Service Trigger HTML Elements on a single page, and use different configuration options in each one.

Not all configuration options are usable by all Service Trigger HTML Elements. In particular, the "triggerConfig.op" is only valid inside an Service Trigger and is not valid inside a ServiceGroup HTML Element. Similarly, the "challenge" is only valid inside the ServiceGroup HTML Element not valid inside any Service Trigger HTML element.

All configuration options are case-sensitive. Both the property name and the value. Example: "triggerConfig.op":"proveUserPresence", "serviceProfileList", etc.

The names and values of the BiscProfile are defined by the sdSpec that the ServiceProfile uses. (If there is no sdSpec specified, then the default sdSpec for the protocolSpec is used.) Different specifications can define different ServiceProfile properties and values. Note the difference between BiscProfile properties and BiscGroup properties. Also, there are a few special BiscGroup properties. Those that are used before the Bisc Site Document is retrieved. These are biscSiteDocUri, serviceProfileList and challenge.

HTML examples:
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup" servicegroup-config='{ "challengeTime": 1599876543210, "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK", "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"}, "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"}, "mediation": "required"}] }'/> ... <a href="remere://example.com/remereService?op=login" rel="servicetrigger" trigger-config='{ "op":"login", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }'>Login</a> ... <a href="remere://example.com/remereService?op=proveUserPresence" rel="servicetrigger" trigger-config='{ "op":"proveUserPresence", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }'>Confirm my presence</a>
Javascript API examples.
let sgContents = {"challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK", "serviceProfileList": [...]};
remereLogin_api.performServiceOp(biscProfileId, "login", {"op":"login", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }, sgContents);
// TODO "sgContents" is not in CapisAPI.callOptions or remereLogin_api.performServiceOp function.

Page Configuration Detail (pageConfig)

The collection of all the (public) configuration data stored for Capis by the browser. In particular, this includes the "biscGroupList", the "baseRpClientData" object and "rpClientData".

The "pageConfig" object contains all the configuration objects for the current HTML page. The "pageConfig" object includes the "biscGroupList" array. The "biscGroupList" is a list of all the BiscGroup info blocks in the HTML page. (i.e. A list extracted from all the ServiceGroup HTML Element in the HTML page.) Each biscGroup item has a "sgContents" sub-object, which contains the BiscGroup data.

The "baseRpClientData" object contains the merged data from the biscGroupList in the current HTML page.

The "clientProtocolCfg" object contains the "primaryService", "biscProfileIdList" and "svFromDirList" lists.

Capis BiscGroup Detail

A BiscGroup is a set of Capis Configuration Options that describe a group of Remote Services the RP offers, and how the client is to invoke them. The client is typically a browser. Usually these options are a single modified-for-HTML JSON object in the "servicegroup-config" attribute of a ServiceGroup HTML Element. They apply to the entire HTML page.

The BiscGroup settings provide a way for the RP to give the browser data or instructions about Remote Services without using javascript. This makes creating Capis enabled HTML easier, and Capis will work without requiring the browser to enable javascript for the RP.

The BiscGroup typically contains the following. (1) (REQUIRED) A "challenge" property. (A securely generated, long random number.) It must be different each time the page is refreshed. (2) A serviceProfileList. It contains a list of serviceProfileList.biscProfileItem objects. (These objects are a BiscProfile that describe a Remote Service.) A BiscGroup may omit a serviceProfileList only if it "references" a different BiscGroup. i.e. The BiscGroup contains a "biscSiteDocUri" property, or the ServiceGroup HTML Element has an "href" that references an Bisc Site Document. (The other BiscGroup must contain a serviceProfileList.)

The BiscGroup settings can contain properties that are applicable to multiple services. (For Example, the challenge property can apply to multiple services.)

The BiscGroup settings are one of the two types of Capis Configuration Options. The other type of Capis Configuration Options are Trigger Configuration. Trigger Options are contained in an Service Trigger HTML element. (Such as the Anchor HTML Element.) Trigger Options are only applicable to the single Trigger HTML element that contains them. Therefore, they usually contain only configuration options for a single service.

When an RP service is invoked, the CapisControl.invokeServiceAction API function will call the CapisControl.ensurePageConfig function.

The CapisControl.ensurePageConfig function will extract all the BiscGroup objects from the HTML page. The CapisControl.invokeServiceAction function will then look inside the extracted BiscGroup object for the BiscProfile specified by the biscProfileId argument. The invokeServiceAction function will use the BiscProfile for any Remote Service that it may call. Note the protocolSpec that it contains. The browser will use the Trigger Configuration as the CapisControl.invokeServiceAction callOptions argument.

The CapisControl.ensurePageConfig function will do the following. It will find all the ServiceGroup HTML Elements in the HTML page, then it will extract the BiscGroup object from each of them. It will then read and evaluate each BiscGroup object. For each of them, the function will look for the href attribute or the biscSiteDocUri property. It will then retrieve the Bisc Site Document from the RP, using HTTPS. The biscSiteDoc is known as the "remoteBiscGroup". The function will then merge the pageBiscGroup with the remoteBiscGroup. The pageBiscGroup values taking priority.

Example ServiceGroup HTML Element:
<head> <link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup" servicegroup-config='{ "challengeTime": 1599876543210, "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK" }'/> ... <link typeIsNotNeeded="application/json" rel="servicegroup" servicegroup-config='{ "challengeTime": 1599876543210, "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK", "biscSiteDocUri": "https://RP_example.com/some/path/capisBiscSiteDoc.json", // biscSiteDocUri is an alternate to using href "serviceProfileList": [{"id":"remere_2", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"}, "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"}, "mediation": "required"}] }'/> // Specifies alternate BiscProfile for protocol "remere". ... <link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup" servicegroup-config='{ "challengeTime": 1599876543210, "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK", "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"}, "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"}, "mediation": "required"}] }'/> </head>

BiscGroup Detail - List of Properties

BiscGroup Detail: Property "biscGroup.id" (longName: "fubar")

Type string. Default value: "sg_n"

Specifies the id of the "BiscGroup". The default value is of the format "sg_n". Where "n" is the index of the group in the HTML. (Starts with 1.) Example: "sg_1"

Example Bisc Site Document:
{
  "documentId": "4857a8d28f6c",
  "id": "sg_1", // HAS NO EFFECT HERE. Must be in the HTML.
  "sgSpec": "capisSgSpec 0.1",
  "rpInfo": {
    "displayName": "ACME Corporation",
    "smallIcon": "/images/logo.png"
  },
  ...
  "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"},
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
  "mediation": "required"}]
}
Example ServiceGroup HTML Element:
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup" servicegroup-config='{ "id": "sg_1", "challengeTime": 1599876543210, "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK", "sgSpec": "capisSgSpec 0.1", "rpInfo": {"displayName":"ACME Corporation"}, "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"}, "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"}, "mediation": "required"}] }'/>

BiscGroup Detail: Property "biscGroup.sgSpec" (longName: "fubar")

Type string. Default value: "capisSgSpec 0.1"

Specifies the name and version of the specification that the BiscGroup is written in.

Valid values are in the form of "capisSgSpec 0.1". They must contain the word "capisSgSpec". See Capis Default Values.
Example Bisc Site Document:
{
  "documentId": "4857a8d28f6c",
  "sgSpec": "capisSgSpec 0.1",
  "rpInfo": {
    "displayName": "ACME Corporation",
    "smallIcon": "/images/logo.png"
  },
  ...
  "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"},
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
  "mediation": "required"}]
}
Example ServiceGroup HTML Element:
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup" servicegroup-config='{ "challengeTime": 1599876543210, "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK", "sgSpec": "capisSgSpec 0.1", "rpInfo": {"displayName":"ACME Corporation"}, "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"}, "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"}, "mediation": "required"}] }'/>

BiscGroup Detail: Property "biscGroup.biscSiteDocUri" (longName: "fubar")

Type string.

Specifies the URI of the RP Bisc Site Document. Overrides the defaultValues.biscSiteDocUri of the Bisc Site Document. This option may ONLY be used in the ServiceGroup HTML Element.

Example ServiceGroup HTML Element:
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup"
 servicegroup-config='{ "challengeTime": 1599876543210,
  "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK",
  "biscSiteDocUri": "https://RP_example.com/some/path/capisBiscSiteDoc.json",
  "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"},
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
  "mediation": "required"}] }'/>

Use of the "biscSiteDocUri" property is ONLY supported on the ServiceGroup HTML Element. It is NOT supported on anchors and forms. (i.e. It is a BiscGroup.) If a Service Trigger HTML Element anchor or form has a "biscSiteDocUri" value, it will do nothing.

Rules

Allows an RP to put the Bisc Site Document somewhere other than the defaultValues.biscSiteDocUri (i.e. in the "/.well-known" directory.) This is particularly useful if the RP does not have control over the "/.well-known" directory.

Allows different pages on the same website to use a different Bisc Site Document. Allows a single domain name to host multiple RPs. The login anchor for each RP can specify its own Bisc Site Document, at a different URI location.

Note that using a non-standard "biscSiteDocUri" may require that the "audience" in the "proof of identity" be changed too. See the Bisc Site Document biscProfile.sapIdSpec property.

Must start with either "/" or "https:", or it is invalid. If it is invalid, then the browser MUST throw an error.

If the location of the Bisc Site Document is not defined, (If the ServiceGroup HTML Element does not have either the "biscSiteDocUri" property or the "href" attribute), then the defaultValues.biscSiteDocUri is used.

If the ServiceGroup HTML Element has both an "href" attribute and a "biscSiteDocUri" property, the "biscSiteDocUri" property has priority.

When this property is present in an ServiceGroup HTML Element, it overrides the defaultValues.biscSiteDocUri default behavior for all Service Trigger HTML Elements on the page.

The only reason to set this property is to override the default. Perhaps to change the directory, or add a path component, or to remove the port number. (i.e. It doesn't make any sense to set the value to be the base domain name, as that is the default. Example: "https://RP_example.com")

A "biscSiteDocUri" is a url using the https scheme. It identifies a JSON document at the RP. For convenience the address of the JSON document can be written starting with just a slash "/". If it is written like this, then "https" and the domain name (and port) of the RP website are automatically prepended to it.

The second type of URI, is simply a domain name using https. The URI can contain a sub-domain and a port, but it does not contain any path or a trailing slash. If the URI does not contain a path component, then the defaultValues.biscSiteDocUri is automatically appended to the URI. (i.e. "/.well-known/capisBiscSiteDoc.json")

BiscGroup Detail: Property "biscGroup.challengeTime" (longName: "fubar")

Type string. Contains base64url encoded binary data. Required in the ServiceGroup HTML Element.

Specifies the time the challenge was issued by the RP. It is a timestamp value. It is the number of milliseconds since Jan 1, 1970. (i.e. Unix Timestamp.) (See similar use in timestamp-id, and RML Request.issuedAt.)

The challengeTime value is required as part of the Service Request to confirm User Authentication. In order to perform User Authentication, the browser must respond to a challenge with the required credentials, within a short time frame. And include the challengeTime in the proof. For Example: The challengeTime is copied into the RML Request rml.request.cht value in the RML Request. The challengeTime value may be used by the RP to help determine what user, session, etc. made the Service Request, or the freshness or staleness, etc. of the Service Request.

Note that the challengeTime value is not necessarily the same as the time when the HTML page was created. That time may be off by several seconds. And it is not equal to the time that the client (the browser) received the HTTP transmission (containing the HTML page).

Example ServiceGroup HTML Element:
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup"
 servicegroup-config='{ "challengeTime": 1599876543210, // challengeTime timestamp
  "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK",
  "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"},
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
  "mediation": "required"}] }'/>

BiscGroup Detail: Property "biscGroup.challenge" (longName: "fubar")

Type string. Contains base64url encoded binary data. Required in the ServiceGroup HTML Element.

A "cryptographic nonce" value, created by the RP. base64url encoded. It is a securely generated nonsense value. (i.e. It is a long random number.) It is a binary value encoded using base64url. It is a type of "cryptographic nonce" value, used to perform user authentication. This option is REQUIRED in the ServiceGroup HTML Element.

A "nonce" value is simply passed back to the RP. It is a nonsense value used to distinguish a particular client session of an RP. Because it was created by the RP, and is passed back to the RP during authentication, it prevents certain CSS (Cross Site Scripting) attacks.

The "challenge" value, as with all "nonce" values, is to make sure that a cryptographic function is NEWLY performed, in response to a specific prompt. It prevents any previously generated cryptographic message from being used. The RP wants NEW proof that the user has a private key, so the RP generates a "nonce" value, and requires that the value be returned to it, inside the user login request. The User Authenticator creates a RML Request message, includes the challenge in it, signs or encrypts the message with the private key, then sends the message to the RP. The presence of the challenge in the message proves that the signed or encrypted message was NEWLY generated. Therefore, the browser must currently have the private key.

A challenge value is REQUIRED in the ServiceGroup HTML Element.

The "challenge" value is a base64url encoded binary value (i.e. an integer). Therefore, it can only contain alpha-numeric, dash and underscore characters. (0-9, a-z, A-Z, '-', '_')

The RP can institute a time limit on between the page was sent and when the challenge must be answered.
Example ServiceGroup HTML Element:
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup"
 servicegroup-config='{ "challengeTime": 1599876543210,
  "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK",
  "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"},
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
  "mediation": "required"}] }'/>

BiscGroup Detail: Property "biscGroup.protocolHandlerList" (longName: "fubar")

Type Array().

Specifies the list of Protocol Handlers. These may include RP services. Each item contains 2 values. The protocolId and the serviceCas.

Example Bisc Site Document:
{
  "documentId": "4857a8d28f6c",
  "rpInfo": {
    "displayName": "ACME Corporation",
    "smallIcon": "/images/logo.png"
  },
  "protocolHandlerList": [{"protocolId":"remere", "serviceCas":["remere_2"]}],
  ...
  "serviceProfileList": [{"id":"remere_2", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"},
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
  "mediation": "required"}]
}
Example ServiceGroup HTML Element:
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup"
 servicegroup-config='{ "challengeTime": 1599876543210,
  "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK",
  "protocolHandlerList": [{"protocolId":"remere", "serviceCas":["remere_2"]}],
  "serviceProfileList": [{"id":"remere_2", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"},
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
  "mediation": "required"}] }'/>

BiscGroup Detail: Property "biscGroup.rpInfo" (longName: "fubar")

Type Object.
Information with which to identify credentials of the relying party. The properties in the "biscGroup.rpInfo" section override the Bisc Site Document properties with the same name. Also note that the RML BiscProfile biscProfile.loginUseRules may contain an "id" property.
Example Bisc Site Document:
{
  "documentId": "4857a8d28f6c",
  "rpInfo": {
    "displayName": "ACME Corporation",
    "smallIcon": "/images/logo.png"
  },
  ...
}

Defines the information of the RP. Known items are "id", "displayName", "smallIcon".

Example ServiceGroup HTML Element:
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup"
 servicegroup-config='{ "challengeTime": 1599876543210,
  "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK",
  "rpInfo": {
    "displayName": "ACME Corporation",
    "smallIcon": "/images/logo.png"
  },
  "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"},
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
  "mediation": "required"}] }'/>

The "displayName" specifies the display name of the RP.

The "smallIcon" specifies the URI for a custom logo to display to the user in the identity login box.

The "displayName" was previously known as "siteName". The "smallIcon" was previously known as "siteLogo".

BiscGroup Detail: Property "biscGroup.rpInfo.displayName" (longName: "fubar")

Type string. Default value: algorithm(The website domain name and port. -- The origin, without the protocol.)

Specifies the display name of the RP. The properties in the "biscGroup.rpInfo" section override the Bisc Site Document properties with the same name.

Example Bisc Site Document:
{
  "documentId": "4857a8d28f6c",
  "rpInfo": {
    "displayName": "ACME Corporation",
    "smallIcon": "/images/logo.png"
  },
  ...
}
Example ServiceGroup HTML Element:
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup"
 servicegroup-config='{ "challengeTime": 1599876543210,
  "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK",
  "rpInfo": {
    "displayName": "ACME Corporation",
    "smallIcon": "/images/logo.png"
  },
  "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"},
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
  "mediation": "required"}] }'/>

BiscGroup Detail: Property "biscGroup.rpInfo.smallIcon" (longName: "fubar")

Type string.

BiscGroup Detail: Property "biscGroup.serviceProfileList" (longName: "fubar")

Type Array(). Required. (A value must be specified.)

An array of BiscProfile objects. This option is typically used in the ServiceGroup HTML Element.

A BiscGroup may omit a serviceProfileList only if it exists in an HTML page, and it references an RP document. (The document contains the serviceProfileList.)

Example Bisc Site Document:
{
  "documentId": "4857a8d28f6c",
  "rpInfo": {
    "displayName": "ACME Corporation",
    "smallIcon": "/images/logo.png"
  },
  ...
  "serviceProfileList": [...]
}
Example ServiceGroup HTML Element:
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup"
 servicegroup-config='{ "challengeTime": 1599876543210,
  "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK",
  "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"},
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
  "mediation": "required"},
  {"id":"remere_2", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json",
  "supportedFormats": ["JWS"]},
  "protocolFallback": {"uriPattern":"http://example.com/remere_2/$opId.html"} }] }'/>

BiscGroup Detail: Property "biscGroup.serviceProfileList.biscProfileItem" (longName: "fubar")

Type Object.

Defines a BiscProfile. This specifies the set of properties for a Remote Service. At a minimum, it must include three properties. An "id", a "protocolSpec" and an "endpointBlock" (or "endpointList"). A biscProfileItem can be defined in either the ServiceGroup HTML Element, or in the Bisc Site Document. For an example implementation, see RML BiscProfile and the RML ServiceProfile List of properties.

Example ServiceGroup HTML Element:
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup"
 servicegroup-config='{ "challengeTime": 1599876543210,
  "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK",
  "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"},
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
  "mediation": "required"}] }'/>

BiscGroup Detail: Property "biscProfileItem.id" (longName: "fubar")

Type Object.

Defines the identifier of the BiscProfile. See biscProfileId.

Example ServiceGroup HTML Element:
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup"
 servicegroup-config='{ "challengeTime": 1599876543210,
  "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK",
  "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"},
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
  "mediation": "required"}] }'/>

BiscGroup Detail: Property "biscProfileItem.protocolSpec" (longName: "fubar")

Type Object.

Specifies the protocols handled by the BiscProfile.

Example ServiceGroup HTML Element:
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup"
 servicegroup-config='{ "challengeTime": 1599876543210,
  "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK",
  "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"},
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
  "mediation": "required"}] }'/>

Bisc Site Document Detail

A "Bisc Site Document" is a JSON document published by an RP that describes the RP and its public services using the Capis specification format. A "Bisc Site Document" is a BiscGroup with a few extra properties. (Such as the documentId.) The BiscGroup includes a serviceProfileList property, that contains a list of BiscProfiles. These identify the public Remote Services the RP offers. A BiscProfile specifies the abilities and requirements of a Remote Service. The list can include login or other authentication services.

The document must contain (1) a "documentId" value, (2) a "rpInfo" property, and (3) a "serviceProfileList".

The defaultValues.biscSiteDocUri of the "Capis Document" is a "well-known" URI. (Example: "RP_example.com/.well-known/capisBiscSiteDoc.json".)

Each BiscProfile contains (1) The "protocolSpec" of the service (REQUIRED), (2) An "endpointBlock" item. An endpoint must have an address URI (the "endpoint.sUri" is REQUIRED), (3) The other abilities and requirements of the service. (These are listed in the "supported" section.) (4) The "id" of the service.

Example Bisc Site Document:
(Note that comments, denoted by the // characters, are not allowed in JSON, and must be omitted.)
{
  "documentId": "4857a8d28f6c",
  "rpInfo": {
    "displayName": "ACME Corporation",
    "smallIcon": "/images/logo.png"
  },
  "serviceProfileList": [ // Array of "BiscProfile" objects.
    serviceItemStart{
      "id": "remere_1",
      "protocolSpec": "remere", // "protocol" is REQUIRED
      "sdSpec": "remereSdSpec 0.1",
      "sapIdSpec": "example.com/path/svApp.json",
      "endpointBlock": {
        "id": "endpoint_1", "http_method": "POST", // Default http_method is "POST"
        "sUri": "/_remere/requestServiceOp.php", // REQUIRED. Define the endpoint URI.
        "supportedFormats": ["JWS"]
      },
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
      "userLoginCreation": {
        "allowedRpIdRules": {"rpMatch": [{"id":"example2.com", "all-subdomains":"yes"}]},
        "userIdTypes": ["single_site_userId", "qi:A:H:9:ri"],
        "createMethods": ["assigned_ulc", "claim_ms_ulc"]
      },
      "loginUseRules": {
        "altLoginSourceList": [
          {"sapId":"login.example.com/svApp2.json", "colMode":"SSO"},
          {"sapId":"example.com/svApp3.json", "colMode":"SSO"} ]
      },
      "mediation": "silent",
      "userAuthenticationRequirements": {
        "loginConfigurations": [
          { "id": "cfg1", "allow": "always", "credentialInfoList": [
            {"type":"module", "mid":"pubKeyFirst"} ]
          },
          { "id": "cfg2", "allow": "always", "credentialInfoList": [
            {"type":"module", "mid":"passwordCred2"} ]
          }
        ],
        "credentialInfoModules": [
          { "id": "passwordCred2", "allow": "always", "credentialInfoList": [
            { "type":"password", "transport":"raw" } ]
          },
          { "id": "pubKeyFirst": "allow": "always", "credentialInfoList": [
            { "type":"public-key", "alg_COSE": -7 },
            { "type":"public-key", "alg_COSE": -257 } ]
          }
        ]
      },
      "credentialReg": {
      // The types of "Credential Verification Rule" the RP supports.
        "ruleTypes": {"pubkey1":"1"},
        "passwordTypes": [{"name":"password_s1", "maxLength":14, "storageQuantity":"1"}],
        "publicKeyTypes": [{"name":"pubkey_s1", "JWA_alg":"ES256", "storageQuantity":"1"}],
        "required_ruleTypes": {"pubkey1":"1"}       // The RP requires a "public key" authentication.
      },
      "supported": {
        "userAuthScheme": {"methods":["stored_cred", "only_MSUID"]},
        "supported.uic.csvm": ["basic1", "basic2"] // The certificate verification protocols the RP supports.
      },
      "requirement_section": {
      }
    }serviceItemEnd,
    {
      "id": "remere_2", // "id" is REQUIRED
      ...
    }
  ]
}

List of Bisc Site Document Properties

BiscGroup Detail: Property "biscGroup.documentId" (longName: "fubar")

Type string. Optional.

Specifies the id of the document. Each document revision should have its own unique id.

Example Bisc Site Document:
{
  "documentId": "4857a8d28f6c",
  "rpInfo": {
    "displayName": "ACME Corporation",
    "smallIcon": "/images/logo.png"
  },
  ...
  "serviceProfileList": [...]
}

BiscGroup Detail: Property "biscGroup.generate_challenge" (longName: "fubar")

Type string.
Specifies the URL of the generate challenge JSON file. Will generate a "cryptographic nonce" value. base64url encoded.

The Bisc Site Document may contain a "generate_challenge" property, to specify a way to generate a challenge.

Example Bisc Site Document:

json_doc = { ... "generate_challenge":"/_capis/generate_challenge.json", ... }

{
  "documentId": "4857a8d28f6c",
  "generate_challenge": "/_capis/generate_challenge.json",
  ...
  "serviceProfileList": [...]
}

Trigger Configuration Detail

A Trigger Configuration is the set of Capis Configuration Options inside a Service Trigger. (This is usually a Service Trigger HTML Element HTML element. Such as a Anchor HTML Element.) The config data is usually the contents of the trigger-config attribute. It is usually a single modified-for-HTML JSON object. The Trigger Configuration is the set of Service Arguments to call the service with.

When the trigger is activated, the browser (in the CapisControl.activateTrigger function) extracts the entire contents of the trigger-config attribute into a single JSON object, called the CapisControl.invokeServiceAction callOptions. (See CapisControl.extractTriggerAttributeFromHtmlElement.) The callOptions value is passed into the Capis Control.invokeServiceAction function.

The Trigger Options provide a way for the RP to give the browser data or instructions about Remote Services without using javascript. This makes creating Capis enabled HTML easier, and Capis will work without requiring the browser to enable javascript for the RP.

The Trigger Options MUST contain a "triggerConfig.op" property. The opId property is part of the Capis specification. All other properties are defined as part of a different specification, such as the Remere Login Specification.

The Trigger Options are only used when that trigger is activated. They do not apply to the entire HTML page. The Trigger Options are one of the two types of Capis Configuration Options. The other type is a BiscGroup.

There are currently two instances of Service Trigger in HTML. These are the Anchor HTML Element and the Form HTML Element. (The trigger-config attribute.)

HTML examples:
<a href="remere://example.com/remereService?op=login" rel="servicetrigger" trigger-config='{ "op":"login", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }'>Login</a> ... <a href="remere://example.com/remereService?op=proveUserPresence" rel="servicetrigger" trigger-config='{ "op":"proveUserPresence", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }'>Confirm my presence</a> ... <form action="remere://example.com/remereService?op=signForm" rel="servicetrigger" trigger-config='{ "op":"", "bip":"remere_1signData" }'> <input type="text" name="first_name" placeholder="Enter your first name" /> <input type="text" name="user_email" placeholder="Enter your email address" /> <input type="submit" value="Sign and Submit the Form" /> </form>

Capis TriggerConfig: Property "triggerConfig.op" (longName: "fubar")

Type string. Usable by (and required in) a Anchor HTML Element and a Form HTML Elements. (Not usable by a ServiceGroup HTML Element.) Default value: "login"

Specifies the operation to be performed by the Service Trigger. (i.e. When the anchor is clicked or the form is submitted.) This property is not for use in the ServiceGroup HTML Element. Usually the contained opId value is sent to the RP in the RML Request.opIdReq property, and the RP executes the requested operation.

The "bip" property contains the "biscProfileId", and the "op" property contains the opId. (The BiscProfile contains the biscProfile.protocolSpec Protocol ID.) The biscProfileId and opId specify which Remote Service the "op" should invoke. This specification allows a single HTML page to use multiple services and/or multiple methods offered by the services. There must be a way to specify which service an Service Trigger wants to invoke.

The opId value must be one of the RML Operation List. The following are possible values for the "triggerConfig.op" property. "login", "logout", "registerUserLogin", "setActiveCredentials", etc.

Example Anchor:
<a href="remere://example.com/remereService?op=setActiveCredentials" rel="servicetrigger" trigger-config='{ "op":"setActiveCredentials", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }'>Set Active Credentials</a>

Capis TriggerConfig: Property "triggerConfig.bip" (longName: "fubar")

Type string. Usable by (and required in) a Anchor HTML Element and a Form HTML Elements. (Not usable by a ServiceGroup HTML Element.) Default value: "login"

Specifies the operation to be performed by the Service Trigger. (i.e. When the anchor is clicked or the form is submitted.) This property is not for use in the ServiceGroup HTML Element. Usually the contained opId value is sent to the RP in the RML Request.opIdReq property, and the RP executes the requested operation.

The "bip" property contains the "biscProfileId", and the "op" property contains the opId. (The BiscProfile contains the biscProfile.protocolSpec Protocol ID.) The biscProfileId and opId specify which Remote Service the bip should invoke. This specification allows a single HTML page to use multiple services and/or multiple methods offered by the services. There must be a way to specify which service an Service Trigger wants to invoke.

The opId value must be one of the RML Operation List. The following are possible values for the "triggerConfig.op" property. "login", "logout", "registerUserLogin", "setActiveCredentials", etc.

Example Anchor:
<a href="remere://example.com/remereService?op=setActiveCredentials" rel="servicetrigger" trigger-config='{ "op":"setActiveCredentials", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }'>Set Active Credentials</a>

Capis TriggerConfig: Property "triggerConfig.triggerOp" (longName: "fubar")

Type string. Usable by (and required in) a Anchor HTML Element and a Form HTML Elements. (Not usable by a ServiceGroup HTML Element.) Default value: "login"

Specifies the operation to be performed by the Service Trigger. (i.e. When the anchor is clicked or the form is submitted.) This property is not for use in the ServiceGroup HTML Element. Usually the contained opId value is sent to the RP in the RML Request.opIdReq property, and the RP executes the requested operation.

The "bip" property contains the "biscProfileId", and the "op" property contains the opId. (The BiscProfile contains the biscProfile.protocolSpec Protocol ID.) The biscProfileId and opId specify which Remote Service the triggerOp should invoke. This specification allows a single HTML page to use multiple services and/or multiple methods offered by the services. There must be a way to specify which service an Service Trigger wants to invoke.

The opId value must be one of the RML Operation List. The following are possible values for the "triggerConfig.op" property. "login", "logout", "registerUserLogin", "setActiveCredentials", etc.

Example Anchor:
<a href="remere://example.com/remereService?op=setActiveCredentials" rel="servicetrigger" trigger-config='{ "op":"setActiveCredentials", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }'>Set Active Credentials</a>

Capis TriggerConfig: Property "triggerConfig.onSuccess" (longName: "fubar")

Type Array(object). Usable by an anchor or form. (Not usable by a ServiceGroup HTML Element.)

Specifies the things to do on the service response.

Example Anchor:
<a href="remere://example.com/remereService?op=login" rel="servicetrigger" trigger-config='{ "op":"", "bip":"remere_1login", "onSuccess":[{"redirectUri": "/some/path/page.html"}] }'>Login</a> ... <a href="remere://example.com/remereService?op=login" rel="servicetrigger" trigger-config='{ "op":"", "bip":"remere_1login", "onSuccess":[{"redirectUri": "https://example.com/some/path/page.html"}] }'>Login</a>

RML Trigger Config - Detail

The RML Specification extends the Capis specification, and defines its own properties. (The RML "remere" Service Protocol Id)

RML Trigger Config - List of Properties

RML TriggerConfig: Property "triggerConfig.onSuccess.itemN.redirectUri" (longName: "fubar")

Type string. Usable by an anchor or form. (Not usable by a ServiceGroup HTML Element.)

Specifies the URI of the page the browser should load after the success of the authentication operation. Alternate name is "return_to".

Tells the RP where to redirect the current browser tab, once the auth attempt has been successful. It can be another page on the RP website, or elsewhere on the internet. Note that this is a request. The RP does not have to comply with it. In particular, an authentication failure will result in an error page, it will not redirect the user to the redirectUri page.

Example Anchor:
<a href="remere://example.com/remereService?op=login" rel="servicetrigger" trigger-config='{ "op":"", "bip":"remere_1login", "onSuccess":[{"redirectUri": "/some/path/page.html"}] }'>Login</a> ... <a href="remere://example.com/remereService?op=login" rel="servicetrigger" trigger-config='{ "op":"", "bip":"remere_1login", "onSuccess":[{"redirectUri": "https://example.com/some/path/page.html"}] }'>Login</a>

RML TriggerConfig: Property "triggerConfig.ulCreationCfg" (longName: "fubar")

Type Object. Usable by an anchor or form. (Not usable by a ServiceGroup HTML Element.)

Specifies the UserId and related configuration values to request the RP assign to the User Login. This value is primarily used with "requested_ulc User Login Creation Method". This value is primarily used with opId "registerUserLogin", "setUserId" and "login". This value is part of a REQUEST to the RP to assign the specified UserId to the User Login. The RP may or may not comply. This value is primarily used to send a Multi-site UserId to the RP.

The RML BiscProfile userLoginCreation value tells the browser what the RP's rules are. The RML TriggerConfig ulCreationCfg asks the RP to change its default behavior.

When used in the browser with opId="login", the value is only used if the user chooses to create a new User Login. If so, then the uid.clientReqUserId value is sent to the RP with opId="registerUserLogin". When used with "registerUserLogin" and "login", the LoginManager.createUserLogin function is called, and the *original* userId is set to the desired value. However, the RP may decline to use the UserId, and respond with a different UserId value. This will change the userId value in the LoginManager. When used with "setUserId", the value is not stored in the LoginManager at all all, unless and until the RP responds with confirmation that the value was assigned.

Example Anchor:
<a href="remere://example.com/remereService?op=login" rel="servicetrigger" trigger-config='{ "op":"login", "bip":"remere_1", "ulCreationCfg": {"userIdGenMethods": ["st1", "ct1"], "rawUserId": "qi:A:A:2:M4j-q:XSAErLq"}, "onSuccess":[{"redirectUri": "/some/path/page.html"}] }'>Login</a> ... <form ... rel="servicetrigger" trigger-config='{ "op":"signData", "bip":"remere_1", "ulCreationCfg": { "userIdGenMethods": ["st1","ct1"] }, "setTriggerPropByFieldName":["input27"] }'> <input id="input26" type="text" name="user_email" value="john@example.com" placeholder="Enter your email address" /> <input id="input27" type="text" name="ulCreationCfg" value='{ "userIdGenMethods": ["st1","ct1"] }' /> </form>

RML TriggerConfig: Property "triggerConfig.setTriggerPropByFieldName" (longName: "fubar")

Type Array(string). Only usable by a form.

Specifies an array of form input field "id" strings. The input field elements should contain the trigger property values. Only usable by forms. This is typically only used for testing and debugging implementations.

For each id in the array, the form input HTML element with that id is found, the property name is read from the "name" attribute, and the property value is read from the "value" attribute, then the triggerConfig property with that name is set.

In the future, setting sub-properties might be implemented. In this case, the name of the field would contain a period, separating the target property from a sub-property. (Example: name="ulCreationCfg.rawUserId")

Example Anchor:
<form href="remere://example.com/remereService?op=login" rel="servicetrigger" trigger-config='{ "op":"login", "bip":"remere_1", "setTriggerPropByFieldName": ["input27","input28"], "onSuccess":[{"redirectUri": "/some/path/page.html"}] }'> ... <input id="input27" type="text" name="triggerOp" value="remere_1/login" /> <input id="input28" type="text" name="ulCreationCfg" placeholder="{ Enter JSON. }"/> <input type="submit" value="Submit" /> </form>
Example implementation code.
// example implementation
function CCI_extractTriggerAttributeFromHtmlElement(htmlElement) {
  var extractionInfo = {};
  ...
  extractionInfo.jsonContents = jsonContents;
  extractionInfo.srcMetadata = metaData;
  let extractedData;
  if (htmlElement.nodeName == "FORM") {
    let fieldIdList = jsonContents["setTriggerPropByFieldName"];
    if (fieldIdList === undefined) {
	} else if (Array.isArray(fieldIdList) == false) {
      throw new Error("extractionInfo.setTriggerPropByFieldName must be an array. (Or undefined)");
	} else {
      extractedData = CCI_extractFieldDataFromForm(htmlElement, fieldIdList);
    }
    // OVERWRITE any existing jsonData values with the same name.
    Object.assign(jsonContents, extractedData);
  }
  return extractionInfo;
}

/**
 * Extract the form field values.
 * OVERWRITE any existing jsonData values with the same name.
 * For each form field, use the field name as the property name,
 * and perform a JSON.parse() on the field value.
 * @param {Object} formElement; The form to extract fields from.
 * @param {Array} fieldIdList; The list of fields to extract.
 * @return {Object} result; The set of extracted values. (name-value pairs)
 */
function CCI_extractFieldDataFromForm(formElement, fieldIdList) {
  let extractedData = {};
    let fieldIdList2;
    if (fieldIdList === undefined) {
      // skip if fieldIdList is undefined.
    } else if (Array.isArray(fieldIdList)) {
      fieldIdList.forEach(function(fieldId,index,array) {
        // Create a special query selector. That fixes the colon and backslash characters.
        let fieldId_qs = fieldId.replace(/\\/g, "\\\\"); // escape the backslash char.
        fieldId_qs = fieldId_qs.replace(/:/g, "\\:"); // escape the colon char.
        let fieldElement = formElement.querySelector("#" + fieldId_qs);
        if (fieldElement == null) {
          throw new Error("Form is missing field with id=" + fieldId);
          // fieldElement = {};
        }
        let fieldName = fieldElement.name;
        let fieldValue = fieldElement.value;
        if (fieldName === undefined || fieldName == "") {
          throw new Error("Form field has missing or empty 'name' attribute. Field id=" + fieldId);
        } else if (fieldValue === undefined || fieldValue == "") {
          // skip any field without a value.
        } else {
          // JSON.parse() would *almost* work for all fieldValue types, but ...
          // WARNING. If fieldValue is a string, it is NOT quoted like JSON requires. (i.e. "some text")
          // WARNING. If there are any spaces at the front of the fieldValue, then it is a STRING!
          let isStringType = false;
          let ch1 = fieldValue.charAt(0);
          if (fieldValue == "true") {}
          else if (fieldValue == "false") {}
          else if (ch1 == "{") {} // }
          else if (ch1 == "[") {} // ]
          else if (ch1 == "\"" || ch1 == "'") {} // A quoted string, use JSON.parse().
          else { isStringType = true; }
          if (isStringType) { jsonValue = fieldValue; } // Do not use JSON.parse() on an unquoted string.
          else {
           try { jsonValue = JSON.parse(fieldValue); }
           catch(e) { throw new Error("Invalid JSON value in form field with name=" + fieldName + ". value=" + fieldValue); }
          }
          extractedData[fieldName] = jsonValue;
        }
      });
    } else {
      throw new Error("fieldIdList must be an array. (Or undefined)");
    }
  return extractedData;
}

Capis Default Values

The "Capis Default Values" are used when the BiscGroup in the HTML page does not specify a value. The configuration options that have "specification defaults" are the biscSiteDocUri and similar properties.

  1. The default value of the href attribute of the ServiceGroup HTML Element Element. (The value is the defaultValues.biscSiteDocUri of the Bisc Site Document.)
  2. The default value of BiscGroup.id is "sg_n". Where "n" is the index of the group in the HTML. (Starts with 1.) Example: "sg_1"
  3. The default value of BiscGroup.sgSpec is "capisSgSpec 0.1"
  4. The default value of RML BiscProfile.id is "protocol_n". (Where "protocol" is the value of the protocolSpec, and "n" is the index of the item in the serviceProfileList array.) (Starts with 1.) (The id of the BiscProfile.)
  5. The default value of RML BiscProfile.sdSpec is "remereSdSpec 0.1",
  6. The default value of RML BiscProfile.protocolSpec is "remere".
  7. The default value of RML BiscProfile.requestFormatList is ["remereRequestFormat 0.1"]
  8. The default value of RML Request.requestFormat is "remereRequestFormat 0.1".
  9. The default name of the HTTP parameter containing the Capis service request is "capis_request".
  10. The default directory name for "capis login authentication" files is "/_capis/userauth".
          "endpointBlock": {
            "id": "endpoint_1", "http_method": "POST", // Default http_method is "POST"
            "sUri": "/_remere/requestServiceOp.json", // REQUIRED. Define the endpoint URI.
            "supportedFormats": ["JWS"]
          },
      "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
    
  11. The default directory name for "fallback" files is "/_capis/fallback".
    Example Anchor:
    <a href="remere://example.com/remereService?op=login" rel="servicetrigger" trigger-config='{ "op":"login", ... }'>Login</a>

Capis Default Values: capis_request

Type string. Required. (A value must be specified.)

The default name of the HTTP parameter that contains the Capis service request. It is JSON data.

The browser sends the service request to the "Service Endpoint" in whatever manner the RP designated in the BiscProfile. (i.e. In the Bisc Site Document.) Usually the method is an HTTP POST. (As a special case, if the Service Trigger HTML Element that activated Capis is a form, and Capis is configured to send an HTTP POST, then the browser will send the service request as a special HTTP parameter *in addition to* any regular form data. The default name of the HTTP parameter is capis_request.) See the Capis Service Invocation Protocol.

The RML Request JSON object contains a crProofSection" ("prs") property, and the "opIdReq" to be performed.

Remere Login User Auth Method (uauth_method)

How a user is authenticated. How he signs-in to an RP. A user must prove that they are who they claim to be. Several ways to do this are:

  1. prove access to a shared secret (such as a password)
  2. prove possession of a private key (by creating a key signature)
  3. prove that the user is authorized by a different RP. (i.e. a federated credential)
  4. prove ownership of a Locked Id.
  5. Some combination of the above

Using any of the "certificate_" variations (such as "only_MSUID") means that a type of "UserId certificate" is being used. Be careful to use to correct "csvm" value.

In general, which "authentication method" the browser chooses to use, will also determine what "csvm" value needs to be sent to the RP. "RML Request.sigInfo.csvm" is used for Certificate Signature Verification Protocol.

(The "csvm" values include "OIDCD", "BrowserID" and "RDAC".)

List of User Auth Methods (i.e. Login Methods)

List of user authentication methods. These can be supported by an RP in RML BiscProfile.supported.userAuthScheme. And used by the browser in RML Request.user_auth_method.

Remere Login UA Method: "stored_cred"

The RP should use the stored set of Credential Verification Rule (e.g. passwords, public keys, etc.) to authenticate the user. This option will not work if the RP does not have any stored credentials for the user_login. This is the simplest form of user authentication. This is the default.

The RP must store some Credential Verification Rule (e.g. passwords, public keys, etc.) for each user.

This is the only user_auth_method for Single-site UserId>. (Or can without_MSUID be used too?)

The RP may choose to not support this user_auth_method. It may choose to support only the only_MSUID user_auth_method.

If the RP supports this option, then it (probably) means that the RP supports creating a "Single-site UserId" during login. (i.e. assigned_ulc or similar.)

Remere Login UA Method: "without_MSUID"

The RP should not verify that the user owns the Locked Id. The RP should authenticate the claimed UserId using only the set of CVR that it has stored for the user. This option will not work if the RP does not have any stored credentials for the user_login.

The RP should not verify the ownership of the UserId. If the UserId is a Federated UserId the RP should not require or use the UserId certificate. Even if a UserId Certificate if provided by the browser. If the UserId is a Self-contained type, then the RP will not extract the lock requirements from inside the UserId.

This is a shortcut for browsers and the RP. It eliminates a lot of the work that usually is not necessary. It allows the use of a Locked Id during user authentication, but skips the step of verifying its ownership. This is possible because if the Multi-site UserId is recognized by the RP, (If there exists a user that uses the UserId), then the ownership of the Multi-site UserId was verified previously, during the "user login creation". (The login_creation method was probably "MSUID User Login Creation Method".)

This option is very useful if the RP already stores a set of CVR for the user. As long as the user has credentials, and chose sufficiently secure credentials, then it is not really necessary to require the user to also prove that he owns the UserId during every login. (i.e. to unlock the UserId.)

When using this option, the RML Request signatures that have certPK, should have their sigInfo.vkm value set to "site_stored_vks".

This method can only be used if the RP stores some kind of "Credential Verification Rule" (e.g. a public key, password, etc.) for the user. This method also requires the user to store a Credential Source for the RP in his Login Manager. (A password or private key, etc.)

See "without_MSUID" User Authentication Method Detail.

Remere Login UA Method: "only_MSUID"

The RP should use only the Locked Id to authenticate the user. It should not use any of the credentials stored at the RP.

This option entirely relies on the proof that the user "owns" the UserId. If the UserId is a Federated UserId, then it requires a UserId certificate and entirely relies on the Identity Provider.

See only_MSUID-user-authentication-detail.

Remere Login UA Method: "combo_MSUID"

The RP should use the active credentials stored at the RP AND the Locked Id proof of ownership. This process will prove that the user "owns" the UserId.

User Login Creation at an RP

How to create a new User Login at an RP. See opId "registerUserLogin". (A.K.A. user registration.) Used by RML BiscProfile.biscProfile.userLoginCreation.

Creates a new User Login at a website. This registers the current user of the RP. It assigns him a UserId and some type of login secrets. (i.e. Some Credential Verification Rules. A public/private key or "username and password", etc.) Creating a User Login will allow the RP website to be able to identify the same user in the future.

A User Login is not the same thing as an "account". This is because RPs may allow Account Sharing. That is, for multiple users to share the same account. Each user would get their own "user login", they would get their own UserId and password or public key, etc. but they would share a single "service account". Because of this, creating a new user login DOES NOT have to also create a new "service account" at the RP. Some RPs may require an additional step to "create an account". Normally, both the "user login" and the "service account" are created together. However, some times a user may not want to create their own account, they may want to "be added to a friend's existing account" instead. For this reason, there is an only_register option to specifically inform the RP to only "register" the user, and not to create a service account. (An RP may split the account creation process into two steps, so this flag may not be needed.)

Users create a new User Login at an RP in order to... be able to login again later. (1) Have a way to identify themselves to the RP (i.e. with a UserId) and (2) be able to prove that they are who they claim to be. (i.e. authenticate themselves to the RP.)

The user's browser creates a opId="registerUserLogin" RML Request, includes some public key(s) etc. and sends it to the RP. The RP then sends a RML Response back to the browser, with acknowledgment of user registration, or an error. The default behavior is for the RP website to include in the response the new assignedUserId that it has assigned to the user. However, some RP may allow users to choose their own UserId.

If a Locked Id is specified when creating a User Login, there is an extra step. The RP MUST VERIFY that the user can unlock the Locked Id before the RP can use it to create a User Login. An RP MUST NOT register a Locked Id to any of its users, unless the user can unlock the ID. Because that would allow someone who does not own the Multi-site UserId to create a login using the UserId. (This is a security risk)

An RP SHOULD NOT automatically create a user_login for a UserId in response to a opId="login" RML Request. For example, if a user attempts to login with a Locked Id, and the RP verifies the user unlocked the UserId, but the RP does not have a record of a user_login for that UserId, the RP MUST NOT automatically create a user_login for the current user. Instead, the RP must CONFIRM that the user wants to create a new user_login. This will prevent User Login creation due to user error. It is easy for a user to make a mistake, and accidentally select the wrong User Login to log in to an RP with. The user may already have an account at the RP, but with a different UserId. Or the user may want to change his existing account. For example, the user may want to change the account in order to allow the new UserId to access it. Because the RP does not know the user's intentions, automatically creating a new user_login would be a problem.

The RP may allow users to CHOOSE THEIR OWN UserId. The RP may provide the user with a list of suggested Single-site UserId. Or it may do something more creative and perform a dynamic lookup of what suggestion the user types in. Regardless, when the user activates the "registerUserLogin" opId, the RML TriggerConfig.ulCreationCfg will contain the chosen UserId.

The RML Request JSON object:

let payload_unencoded = { "requestFormat": "remereRequestFormat 0.1", "protocolId": "remere", "opIdReq": "registerUserLogin", "sub": "remere_1/registerUserLogin", "iat": 1503971280, // issuedAt timestamp "exp": 1533064012, // expiresAt timestamp "aud": "RP_example.com", // the audience "challenge": "abcdefg", // nonce value "cht": 1533064012, // challengeTimestamp "uid": { "rawForLogin": "qi:A:H:2:K8h3_TfXr6ZtLq7d1m8k", // The QIF UserId "timestamp_uid": "q3jC9-h" }, // "user_auth_method": "combo_MSUID", "user_login_creation_method": "claim_ms_ulc", "redirectUri": "/some/path/page.html",
// user_id_certificate_chain (Available when not using the "stored_cred" uauth_method.) "uic_chain": [ {"uic.format":"JWS", "uic.csvm":"YY", "ucv": { "payload":"82h7vb...", "signatures": [...] }} ],
"useCount": 42, // crProofSection. "crProofSection": { "uid": { "raw2": "qi:A:H:2:xxxxxxxx", // The QIF UserId }, "uapCounter": 42, "cpl": [ { "cid_p": "cd2", "typ_p": "pubkey", "fmt_p": "JWT", // "format": "JWT" (not necessary. The default is "JWT".) "val_p": "mmmm" // This is the encoded JWT, see below. } ], }, // "credRegSec" credentialRegSection. Required for "registerUserLogin" and "setActiveCredentials" opIdReq. "credRegSec": { "backup_credentials": [ { "cid_r": "cd-3", "typ_r": "pubkey", "fmt_r": "JWK", "alg_COSE": -7, "bupk": "qi:A:H:2:mK7HnbndYb746GvnYkrU", // The Backup User Public Key ("backup_upk") "bupk2": "none" } ], "crList": [ { "cid_r": "cd10", "typ_r": "pubkey", "fmt_r": "JWK", "alg_COSE": -7, "val_r": { "kty": "EC", "kid": "cd10", // "kid" is REQUIRED. Same as the "cid_r". "alg": "ES256", "crv": "P-256", "ext":true, "key_ops": ["verify"], "x": "5sy3ogiqTrlC_FF7aOdCq7cNFsN2nbrH4xQmNCCBtso", "y": "ctK7P_LU-SQPf-ejkmC1JYzm7S5N0B6ZX5rwOQWzuv8" } } ] } }; let RML Request = { "JWS": { "payload": BASE64URL(UTF8(payload_unencoded)), "signatures": [{ "protected": "eyJhbGciOiJFUzI1NiJ9", // protected_header = {"alg":"ES256"} "header": { "kid": "e9bc097a-ce51-4036-9562-d2ade882db0d", // "kid": "userIdPK" // "userIdPK" means the public key is in "userId". "vkm": "certificateF" }, "signature": "DtEhU3ljbEg8L38VWAfUAqOyKAM6-Xx-F4Ga" }] } }
The "UserId certificate" JWT. header and claims: (uic_chain[0])
let payload_unencoded = { "sub2": "remere_1/certificate", "iss": "id_registrar.example.com", // The Backer "iat": 1503971280, // REQUIRED "exp": 1503971430, // REQUIRED "sub": "qi:A:F1:1:ACMA_org:M4j-q", // The QIF UserId. "uid": { "rawForLogin": "qi:A:H:2:K8h3_TfXr6ZtLq7d1m8k", // The QIF UserId }, "cert_pubKeyList": [ { "pkf": "JWK", "kty": "RSA", "kid": "f85762a7f52c8346", "alg": "RS256", "n" : "4b9e34...", "e" : "93bc32..." } ] } let jws_certificate = { "payload": BASE64URL(UTF8(payload_unencoded)), "signatures": [{ "protected": "eyJhbGciOiJSUzI1NiJ9", // protected_header = {"alg":"RS256", "sct":192} "header": { "alg": "RS256", "kid": "bf4a76332a6c8370f48", // "kid" is REQUIRED. ID of the issuer key. // "csvm": "OIDCD" // Get the sig verification key from the issuer via "OIDCD", etc. "csvm": "idr_keystore" // Get the sig verification key from an "identity registrar keystore". }, "signature": "DtEhU3ljbEg8L38VWAfUAqOyKAM6-Xx-F4Ga" }] }

Account Creation at an RP

Users can create a User Login at an RP by using the opId "registerUserLogin" value. RPs publish their requirements for User Login creation in the biscProfile.userLoginCreation property.

When creating a User Login at an RP, a user must do a few things. In order to be able to login again later. (1) Have a way to identify themselves to the RP (i.e. with a UserId) and (2) be able to prove that they are who they claim to be. (i.e. authenticate themselves to the RP.)

Ways to create a UserId.
  1. The RP assigns a UserId.
  2. The RP provides a list of options. (The user chooses from several options.)
  3. The RP makes suggestions. (i.e. interactivity between the user and the RP.)
  4. The user requests a UserId. The RP may approve the request.
    Usually, the RP publishes some list of requirements for the identifier. For example: The UserId must be "unused". There is a limited character set to choose from. There is a maximum length, etc. Limited interactivity (negotiation) with the RP is necessary, to find out if a desired UserId is already in use.
  5. Use a "Locked Id".
    It is a universally unique UserId, that is guaranteed to be "unused". (Because the UserId is RESERVED. The RP must not register it to a user, unless the user can unlock the ID. i.e. Prove he owns it.) Note: Multi-site UserIds may use some characters that are not available to "Single-site UserIds". Or may start with a unique prefix. (i.e. "qi:A:H:", "qi:A:F1:") See QIF UserId format.

Options 1, 2 and 3 are "Single-site UserIds". Because they only have meaning at that single RP.

There are two choices for how to set the Credential Verification Rule. (i.e. CVRs)
  1. Send the CVRs to the RP upon User Login creation. (i.e. password and/or public key, etc.) The RP will store the CVR associated with the UserId. It uses the CVR to authenticate the user on subsequent logins.
  2. Do not send any CVR to the RP on User Login creation. Or, the RP does not store any CVR. For a time, the RP relies exclusively on external forces to authenticate the user. This requires a Locked Id. (It requires more than a "Single-site UserId", because there is no password.) The RP can rely exclusively on the user's MSUID (on the CVR in the MSUID), a federated MSUID. etc.
The RP can also allow users to update the Credential Verification Rule that it stores for them. So both of the above cases are not permanent, and can be modified over time.

There must be some way of telling if an account already exists for the supplied username or MSUID. One way to do this is that the RP can require a "register-MSUID" package (i.e. a User Login creation) (the package contains a public key and username) sent with a form submission. (The form submission can include user name, email address, etc.)

When creating an account, the RP might allow additional Credential Verification Rule (i.e. public keys) to be set. (2nd factor authentication) The public keys can be sent to the RP in an additional RML Request.property. The keys can be in JWK format. When logging into an RP, the second signature can be sent to the RP in this second property. See "req_factor2".

See UserLogin Creation Methods for a list of the possible values.

List of User Login Creation Methods

The User Login Creation Methods. Used in the biscProfile.userLoginCreation.createMethods. Used in the rml.request.user_login_creation_method value. Used with the "registerUserLogin" opId.

Previous values are SSUID_acm and MSUID_acm.

Login Creation Method: "assigned_ulc"

The RP assigns a new Single-site UserId without any user intervention. The "assigned_ulc" value is the default. See rml.request.user_login_creation_method See biscProfile.userLoginCreation.createMethods.

When the RP is sent a "registerUserLogin" opId. The RP sends back a new assignedUserId in the RML Response.

Login Creation Method: "claim_ms_ulc" Claim a Multi-site UserId

The user claims a Locked Id as his UserId.

The RP may limit the types of Locked Id that it supports. See the user identifier type supported by the RP.

A simple way for a user to create a User Login at an RP. The user provides a Locked Id and proof of ownership of the UserId. This skips the hardest part of traditional User Login creation, having the user find (and remember) an unused Single-site UserId.

See MSUID_acm.

Login Creation Method: "requested_ulc"

The user requests a specific UserId from the RP.

Used with RML TriggerConfig.ulCreationCfg and RML BiscProfile.userLoginCreation.

Login Creation Method: "requested2_ulc"

The RP negotiates a UserId with the user.

The user performs some interactive process with the RP to negotiate a new Single-site UserId. This is only used when the user has NOT provided a Locked Id. And there is no UserId certificate.

In this case, there is no UserId Certificate. There is only the UserId Assertion, and the RP has the sig verification key for it. The RP stores some "Credential Verification Rule" (e.g. a public key) for each user. (The UserId Assertion should use a "sigInfo.vkm" value of "site_stored_vks".)

See SSUID_acm.
31 32 33 34 35 36 37 38

Capis BiscProfile Detail

A formatted text section that specifies the capabilities and requirements of a Remote Service. Usually written as a set of properties in modified-for-HTML JSON. BiscProfiles are usually listed together in a BiscGroup.serviceProfileList, as a biscProfileItem. (In a Bisc Site Document, etc.) Browsers use the BiscProfiles to understand what types of services the RP provides/supports. A BiscProfile contains: (1) The id of the service. (2) The protocolSpec. (3) The endpointBlock URI. (i.e. What URI the browser should send the Service Request to.) (4) The other features that the service supports. See the RML BiscProfile. (The Capis BiscProfiles may use JSON Web BiscProfile Format. JWSD)

Example BiscProfile:
serviceItemStart{
  "id": "remere_1",
  "protocolSpec": "remere",
  "protocolVer": "1.0",
  "sdSpec": "remereSdSpec 0.1",
  "endpointBlock": {
    "id": "endpoint_1", "http_method": "POST",
    "sUri": "/_remere/requestServiceOp.json",
    "supportedFormats": ["JWS"]
  },
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
  "requestFormatList": ["remereRequestFormat 0.1"]
}serviceItemEnd

Capis BiscProfile - List of Properties

List of common BiscProfile properties.

RML BiscProfile Detail

A RML BiscProfile is a specific version of a BiscProfile. It is used for User Authentication.

A RML BiscProfile specifies the capabilities and requirements of an RP's "User Authentication service". It is one type of "Remote Service" and uses a custom "BiscProfile". (Currently the specification is "remereSdSpec 0.1")

A RML BiscProfile must be contained in a BiscGroup. (In the serviceProfileList.)

Example BiscProfile:
serviceItemStart{
  "id": "remere_1",
  "protocolSpec": "remere",
  "protocolVer": "1.0",
  "sdSpec": "remereSdSpec 0.1",
  "endpointBlock": {
    "id": "endpoint_1", "http_method": "POST",
    "sUri": "/_remere/requestServiceOp.json",
    "supportedFormats": ["JWS"]
  },
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
  "requestFormatList": ["remereRequestFormat 0.1"],
  "sapIdSpec": "example.com/path/svApp.json",
  "userLoginCreation": {
    "allowedRpIdRules": {"rpMatch": [{"id":"example2.com", "all-subdomains":"yes"}]},
    "userIdTypes": ["single_site_userId", "qi:A:H:9:ri"],
    "createMethods": ["assigned_ulc", "claim_ms_ulc"]
  },
  "loginUseRules": {
    "altLoginSourceList": [
      {"sapId":"login.example.com/svApp2.json", "colMode":"SSO"},
      {"sapId":"example.com/svApp3.json", "colMode":"SSO"} ]
  },
  "mediation": "silent",
/* One possible suggestion. Old style.
      "acceptableCredentials": {
        "password": {minEntropy: 64},
        "federated": {providers: ["https://accounts.google.com", "https://www.facebook.com", ...]},
        "sms": {  checkBy: {      send: function(number) {/*Ask the server to send an SMS*/},
          "vouch": [googleKey, samsungKey, appleKey, ...],        },      },
        "publicKey": { // <-- Better name for webauthn credentials.
          "attestationChallenge": crypto.getRandomValues(sixteen_byte_buffer),
          "cryptoParameters": [{algorithm: "ES256"}],
          // Do we need a filter for acceptable attestation certificates?
        }
      },
*/
  "userAuthenticationRequirements": {
    "comment_21": "Each loginConfiguration details the number and type of credentials required for that configuration.",
    "loginConfigurations": [
      { "id": "cfg1", "allow": "always", "credentialInfoList": [
        {"type":"module", "mid":"pubKeyFirst"} ]
      },
      { "id": "cfg2", "allow": "always", "credentialInfoList": [
        {"type":"module", "mid":"passwordCred2"} ]
      }
    ],
    "credentialInfoModules": [
      { "id": "passwordCred2", "allow": "always", "credentialInfoList": [
        { "type":"password", "transport":"raw" } ]
      },
      { "id": "pubKeyFirst": "allow": "always", "credentialInfoList": [
        { "type":"public-key", "alg_COSE": -7 },
        { "type":"public-key", "alg_COSE": -257 } ]
      }
    ]
  },
  "credentialReg": {
      "ruleTypes": {"pubkey1":"1"},
    "passwordTypes": [{"name":"password_s1", "maxLength":14, "storageQuantity":"1"}],
    "publicKeyTypes": [{"name":"pubkey_s1", "JWA_alg":"ES256", "storageQuantity":"1"}],
    "required_ruleTypes": {"pubkey1":"1"}
  },
  "supported": {
    "userAuthScheme": {"methods":["stored_cred", "only_MSUID"]},
    "supported.uic.csvm": ["basic1", "basic2"]
  },
  "requirement_section": {
  }
}serviceItemEnd
Example BiscProfile:
serviceItemStart{
  "id": "remere_1",
  "protocolSpec": "remere",
      // Lists what Webauthn credential creation options the RP supports.
      "loginRegistrationOptions": {
        "publicKeyCredentialCreationOptions": {
          // "Note that both the 'rp' and 'user' properties of Webauthn have been moved.",
          // "The 'rp' was MOVED up a level. The 'user' values MOVED to 'rml.biscProfile.user_info'.",
          // "pubKeyCredParams is an array of type PublicKeyCredentialParameters. The order is important.",
          // "This Relying Party will accept either an ES256 or RS256 credential, but prefers an ES256 credential.",
          // "COSE_alg is a COSEAlgorithmIdentifier",
          // "-7 is the value for ES256. As registered in the IANA COSE Algorithms registry",
          // "-257 is the value for RS256. As registered by the WebAuthn specification",
        
          "pubKeyCredParams": [
            { "type":"public-key", "alg_COSE": -7 },
            { "type":"public-key", "alg_COSE": -257 }
          ],
        
          "timeout": 60000,
          "excludeCredentials": [],
          "extensions": {"loc": true},
          "attestation": "none",
          "authenticatorSelection": {
            "authenticatorAttachment": "platform",
            "residentKey": "required",
            "requireResidentKey": false,
            "userVerification": "preferred"
          }
        }
      },
      // Lists what Webauthn credential request options the RP supports.
      "loginProofOptions": {
        publicKey": {
          // "allowCredentials is an array of type PublicKeyCredentialDescriptor.",
          // "The id fields in allowCredentials, will be automatically converted into a Uint8Array.",
          // "id conversion is: Uint8Array.from(window.atob(id), c=>c.charCodeAt(0))",
          "timeout": 60000, 
          "allowCredentials": [
            { "type":"public-key" },
            { "type":"public-key", "id":"!!!!!!!hi there!!!!!!!\n" },
            { "type":"public-key", "id":"roses are red, violets are blue\n" },
            { "type":"public-key", "transports": [] }
          ],
          "userVerification": "preferred",
          "extensions": {
            "txAuthSimple": "Wave your hands in the air like you just don't care",
            "webauthnExample_foobar": 42
          }
        }
      },
      ...
}serviceItemEnd

Each authentication BiscProfile MUST have a "biscProfile.protocolSpec" and an "endpoint.sUri".

This protocol does not provide an attestation mechanism which allows RPs to identify the class of device and either accept it or not depending on the particular site's policy. Instead of telling the RP about the device, the RP publishes the class of device it accepts. "supported_device_type".

Note that all "supported" properties are arrays. (Example: BiscProfile.credentialReg.credentialReg.ruleTypes: ["pubkey"])

RML BiscProfile - List of Properties

RML BiscProfile Detail

BiscProfile Detail: Property "biscProfile.id"

Type string. Default value: "protocol_n"

Specifies the id of the service. The default value is "protocol_n". Where "protocol" is the value of the "protocolSpec" property in the BiscProfile, and "n" is the index of the item in the serviceProfileList array. (Starts with 1.) (If the protocol is not specified, the id will be set to "service_n". However, if the protocol is not specified, then the biscProfile is invalid.)

Example BiscProfile:
serviceItemStart{
  "id": "remere_1",
  "protocolSpec": "remere",
  "endpointBlock": {
    "id":"endpoint_1", "http_method":"POST", "sUri":"/_remere/requestServiceOp.json"
  },
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"}
}serviceItemEnd

Valid values are anything unique. Example: "remere_1", etc...

Example ServiceGroup HTML Element:
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup"
 servicegroup-config='{ "challengeTime": 1599876543210,
  "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK",
  "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"},
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
  "mediation": "required"}] }'/>

BiscProfile Detail: Property "biscProfile.protocolSpec"

Type string. Required. (A value must be specified.)

Specifies the protocols handled by the service. For Remere Login the value must be "remere". For Webauthn, the value must be "webauthn".

Valid values are "remere", "webauthn", etc..

Example ServiceGroup HTML Element:
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup"
 servicegroup-config='{ "challengeTime": 1599876543210,
  "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK",
  "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"},
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
  "mediation": "required"}] }'/>

BiscProfile Detail: Property "biscProfile.protocolVer"

Type string. Default value: "1"

Specifies the maximum protocol version handled by the service.

BiscProfile Detail: Property "biscProfile.default_endpoint"

Type string. Default value: "endpoint_n"

Specifies the default_endpoint of the service.

BiscProfile Detail: Property "biscProfile.sdSpec"

Type string. Default value: "remereSdSpec 0.1"

Specifies the name and version of the "BiscProfile Specification" that the BiscProfile is written in. If there is no sdSpec specified, then the default sdSpec for the protocolSpec is used.

Different services can use different BiscProfile Specifications. They can define different properties, use different protocols, etc. Even though all the services are offered by the same RP.

Valid values are in the form of "remereSdSpec 0.1". See Capis Default Values.

Specifies the name and version of the specification that the RP used to write the BiscProfile. (A BiscProfile is used inside of a BiscGroup in the HTML page.) Note the difference between a sdSpec and a BiscGroup sgSpec.

All the property names and values the RP uses in a BiscProfile (in the HTML page, etc.) are defined by the "sdSpec" that the RP uses. With a few exceptions. There are a few configuration options which are independent of the sdSpec, as they are used before the Bisc Site Document is retrieved. They are the biscSiteDocUri and similar properties.

Valid values: "remereSdSpec 0.1".
Example BiscProfile:
serviceItemStart{
  "id": "remere_1",
  "protocolSpec": "remere",
  "sdSpec": "remereSdSpec 0.1",
  "endpointBlock": {
    "id": "endpoint_1", "http_method": "POST", "sUri": "/_remere/requestServiceOp.json"
  },
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"}
}serviceItemEnd

BiscProfile Detail: Property "biscProfile.endpointBlock"

Type Object. At least one endpoint is required.

An "endpointBlock" object contains settings for the RP endpoint. An endpoint can be either a single item, or one of the items in the "endpointList" array. (If there is both an "endpointBlock" and an "endpointList" property, the "endpointList" is used.)

Defines an authentication service endpoint.

An endpoint has the following properties:

Example BiscProfile:
serviceItemStart{
  "id": "remere_1",
  "protocolSpec": "remere",
  "endpointBlock": {
    "id": "endpoint_1", "http_method": "POST", "sUri": "/_remere/requestServiceOp.json",
    "parameterList": [{"name":"capis_request", "type":"json_object"}],
    "supportedFormats": ["JWS"]
  },
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"}
}serviceItemEnd

BiscProfile Detail: Property "biscProfile.endpointList"

Type Array(Endpoint). Required. At least one endpoint is required.

Defines the array of service endpoints.

Example BiscProfile:
serviceItemStart{
  "id": "remere_1",
  "protocolSpec": "remere",
  "endpointList": [
    { "id": "endpoint_1", "http_method": "POST", "sUri": "/_remere/requestServiceOp.json",
      "parameterList": [{"name":"capis_request", "type":"json_object"}],
      "supportedFormats": ["JWS"]
    },
    { "id": "endpoint_2", "http_method": "GET",
      "sUri": "/_remere/requestServiceOp.json",
      "supportedFormats": ["JWS"],
      "parameterList": [{"name":"capis_request", "type":"json_object"}]
    }
  ],
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"}
}serviceItemEnd

Endpoints typically receive HTTP POST requests and return an HTTP response. The response typically contains a single JSON object, a JSON document, that contains either return values (such as a success code) or an error object. That describes an error. For example, see RML Response Detail.

BiscProfile Detail: Property "biscProfile.endpoint.id"

Type string. Default value: "endpoint_n" (Where "n" is an integer.)

Specifies the id of the endpoint. The default is "endpoint_n". Where "n" is the index of the item in the array. (Starts with 1.)

BiscProfile Detail: Property "biscProfile.endpoint.http_method"

Type string. Default value: "POST"

Defines the type of HTTP request to send to the endpoint URI.

Valid "method" values are "POST" and "GET".

BiscProfile Detail: Property "biscProfile.endpoint.sUri"

Type string. Required. (A value must be specified.)

Specifies the URI of the authentication service endpoint.

Must start with either "/" or "https:". The https protocol is always used. If it starts with "/", then "https:" is prepended.

BiscProfile Detail: Property "biscProfile.endpoint.parameterList"

Type Array(). Default value: [{"name":"capis_request", "type":"json_object"}]

Specifies the list of parameters in the Service Request data sent to the RP. Each parameter must have a "name" and a "type".

The same parameter names are used with both HTTP GET and POST methods.

Lists the parameters that the endpoint takes, in the order it takes them. All parameters are required by default, unless otherwise noted. (i.e. "isOptional":true) Most APIs require a particular number of parameters, in a particular order. The end parameters may be set as optional.

Example BiscProfile:
serviceItemStart{
  "id": "remere_1",
  "protocolSpec": "remere",
  "endpointList": [
    { "id": "endpoint_1", "http_method": "POST",
      "sUri": "/_remere/requestServiceOp.json",
      "supportedFormats": ["JWS"]
    },
    { "id": "endpoint_2", "http_method": "GET",
      "sUri": "/_remere/requestServiceOp.json",
      "supportedFormats": ["JWS"],
      "parameterList": [{"name":"capis_request", "type":"json_object"}]
    }
  ],
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
    ...
}serviceItemEnd
Example GET URI: http://example.com/endpointUri?capis_request=%7B"JWS"%3A"xxx"%7D -- The encoded value for 'capis_request={"JWS":"xxx"}'

The parameterList is used to override the default parameterList that is used by the protocol. For example, the Remere Login protocol uses a default parameterList of [{name:"capis_request", type:"json_object"}].

The most common data type is "json_object". This means that the Protocol Handler will (attempt to) convert the parameter into a JSON object, before sending the request to the RP. The "type" value can be "string", "integer", "number" (i.e. a real_number), "boolean", "json_object", or "json_array".

BiscProfile Detail: Property "biscProfile.endpoint.supportedFormats"

Type string. Default value: "JWS"

Specifies the format of the request sent to the RP.

The default value of "JWS" is usually correct.

BiscProfile Detail: Property "biscProfile.requestFormatList"

Type Array. Default value: ["remereRequestFormat 0.1"]

Specifies the list of request formats supported by the RP. In the order of priority. The name and version of the request format desired by the RP.

The default value of ["remereRequestFormat 0.1"] is usually correct. Whatever format the browser chooses to use, that value should be put in the RML Request.requestFormat.

BiscProfile Detail: Property "biscProfile.protocolFallback"

Type Array. Default value: {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"}

Specifies the fallback behavior if the browser does not support the protocol of the service. In the order of priority.

For example: If the browser does not support the "remere login" protocol, or if there is a problem using that protocol, then the backup behavior is for the browser to redirect the user to a page containing a standard login form. The default uri of the "login" page is "https://$domainName/_capisFallback/remere/login.html".

The default value of {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"} is usually good enough. Note that the "$domainName" "$protocolId", "$biscProfileId" and "$opId" strings are replaced with the actual values.

Example ServiceGroup HTML Element:
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup"
 servicegroup-config='{ "challengeTime": 1599876543210,
  "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK",
  "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"},
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
  "mediation": "required", "ras_endpoint": "endpoint_2"}] }'/>

BiscProfile Detail: Property "biscProfile.ras_endpoint"

Type string.

Specifies the id of the endpoint to use. The endpoint must exist in the serviceProfileList in the Bisc Site Document.

Example ServiceGroup HTML Element:
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup"
 servicegroup-config='{ "challengeTime": 1599876543210,
  "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK",
  "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"},
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
  "mediation": "required", "ras_endpoint": "endpoint_2"}] }'/>

RML BiscProfile Detail: Property "biscProfile.user_info"

Type Object.

Specifies information about the user, to the user's browser, after User Login creation.

Example ServiceGroup HTML Element:
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup" servicegroup-config='{ "challengeTime": 1599876543210, "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK", "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"}, "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"}, "mediation": "required", "user_info": {"username":"qi:A:A:2:M4j-q:XSAErLq"} }] }'/> ... <form ... rel="servicetrigger" trigger-config='{ "op":"signData", "bip":"remere_1" }'> <input type="text" name="user_email" value="john@example.com" placeholder="Enter your email address" /> </form>

This property is used to inform the user's browser of the information the RP has, that might be of help to the user. For instance, that the user supplied to the RP. The browser can add this information to its internal data stores to augment the credentials, to help the user in the future.

Example: Inside the "user_info": {} data object:
user_info: {
  "id": "MIIBkzCCATigAwIBAjCCAZMwggE4oAMCAQIwggGTMII=",
  "name": "alex.p.mueller@example.com",
  "displayName": "Alex P. Müller",
  "small_icon": "https://pics.example.com/00/p/aBjjjpqPb.png"
}

RML BiscProfile Detail: Property "biscProfile.sapIdSpec"

Type string. Default value: (the RP domain name)

Specifies the Source Application Identifier (sapId) to use. (When logging in, and when creating a new User Login.) The default is to use the "current domain" as the sapId. (i.e. The rapId as the sapId.) A sapId is the id under which a Capis service (such as Remere Login) stores data. The RemereLogin API and the Login Manager stores the User Logins for an RP, or organization under the sapId.

A sapId is similar to a URI, however it does not have a scheme. (A scheme of "https" is assumed.) Example: "login.example.com". It may or may not have a path. (A path contains a slash and a file name after the slash.) Example: "login.example.com/path/svApp.json" The path may also contain additional parts, such as a GUID as a directory or file name. (Or as a field in the query string?)

The default is to use the rapId as the sapId. And that rapId will be the only "read-only authorized rapId" and "ulCreation authorized rapId". (i.e. An rapId that is allowed to access the User Logins that are associated with the sapId.) However, a larger organization may set up multiple RPs to use the same sapId. (Known as SSO. Single Sign On.) Access to a sapId is validated by rapId, so that only an "authorized" RP can access User Logins that use the sapId.

What does sapIdSpec do?

The sapIdSpec is used in two ways.

An RP can set the sapIdSpec value to whatever string value it wants. However, this will cause it to not work correctly. Because the browser enforces security restrictions. The rapId of the current page is passed into these functions as a security parameter.

When finding existing User Login, the browser will only add those User Logins that MATCH the sapId (and the altLoginSourceList) to the result list.

When finding existing User Login, the "collectUserLogins" function searches on the baseSapid (and the altLoginSourceList). The browser will pass in the rapId of the current page. (The result list of User Login can be shown to the user.) The returned list of User Login will ONLY include those User Login that regard the rapId argument as "authorized". The Login Manager will MATCH the rapId with those authorized by the sapId. (i.e. The Login Manager checks that the rapId is authorized to use the sapId.)

Example BiscProfile:
serviceItemStart{
  "id": "remere_1",
  "protocolSpec": "remere",
  "sapIdSpec": "example.com/path/svApp.json",
  "loginUseRules": {
    "altLoginSourceList": [
      {"sapId":"login.example.com/svApp2.json", "colMode":"SSO"},
      {"sapId":"example.com/svApp3.json", "colMode":"SSO"} ]
  },
  "userLoginCreation": {
    "allowedRpIdRules": {"rpMatch": [{"id":"example2.com", "all-subdomains":"yes"}]}
  },
  ...
}serviceItemEnd
Examples of sapId values:
  • "example.com"
  • "login.example.com"
  • "login.example.com/path/svApp.json"

How a User Login uses sapId

Each User Login is created for, and is associated with, a single sapId. (In a Login Manager, the sapId is the "database key" that a User Login is tied to.) In a Login Manager, a set of User Login are found by searching on an sapId. (See the LoginManager.collectUserLogins function.)

By default, a User Login is only authorized to be used by a single rapId. (The rapId that is in the base of the sapId.) A User Login may allow additional rapId to use it. (A User Login may define a list of authorized rapId. See allowedRpIdRules. Possible change. The list of authorized rapId may be defined by a *sapId*, not by a User Login.) Because of this, a single rapId may be authorized to use a wide set of User Logins. (Every User Login that lists that rapId as authorized.) At a minimum, an RP is authorized to use (at least) all the User Login that are associated with an sapId that contains its rapId. (i.e. All the sapId that contain the rapId of the RP.)

An RP gets to decide which sapId to use, or multiple sapId that it wants to use. (Subject to it being authorized to use that sapId.) See altLoginSourceList.

An rapId is used to address a "proof of identity"

A "proof-of-identity" MUST be addressed to a rapId, or it is not valid. The "audience" field in a RML Request must contain the rapId of the RP. If an RP receives a proof of identity with an "aud" value that does not match itself, then the proof is invalid, and the RP MUST NOT accept it. (i.e. an RP may only use a proof that is addressed correctly.) Same with the "forSapId" field. It must contain a known sapId. This is another way that prevents a "proof of identity" from being reused. (The other is the challenge.) A generated proof cannot be used to login to any RP other than the one for which it was created. Note that using a non-standard "biscSiteDocUri" may require that the "audience" in the "proof of identity" be changed too. See the Bisc Site Document biscProfile.sapIdSpec property.

What does a sapId do?

A sapId is used in two ways. (1) To create a new User Login. (2) To find existing User Login. (to login, etc.). (i.e. rml.opId "login".)

The RP gets to choose what sapId to use during both scenarios. During user login creation and use. It can choose either a sapId that matches the RP domain name, or one that is a parent domain of it.

For example, if a user login was created using the sapId "login.example.com", and then the user tried to login at "example.com", the user login for "login.example.com" would NOT be visible. However, if the website at "login.example.com" forced the use of the sapId "example.com" (not "login.example.com"), for "create" (so that it was used for both "create" and "use" scenarios), then the user would be able to use the same user login at both URLs.

This has both good points and bad points. A good point is that a domain (i.e. "example.com") cannot read the User Logins for any sub-domain. Another good point is that a sub-domain can force the *creation* of a user login using a parent domain. A bad point is that a sub-domain can *read* (i.e. access) all the User Logins for all parent domains. Another bad point, if the website initially used a sub-domain, and then wants to change to use a parent domain, that is impossible.

Webauthn --- Note: rapId represents the caller’s RP ID. The RP ID defaults to being the caller’s origin's effective domain unless the caller has explicitly set options.rapId when calling get().

The default value

The default value for a sapId is simply the rapId of the current page. It is the RP's domain name, without any scheme, port number or path component. (A sapId may include a path component, but the default value has none.) Example: If the current page is "http://login.example.com/som/place/like/home.html", then the default value of sapId is "login.example.com".

RESTRICTIONS

When creating a User Login, the sapIdSpec value must be based on the web site's origin. (The sapId must start with the rapId.) All the RP can do is make the sapIdSpec less specific. For example, if a web site is served on "help.login.example.com", the RP can set its sapIdSpec to be "login.example.com" or "example.com". This makes the sapIdSpec LESS specific than the default. This will cause, during User Login creation, the new User Login be tied to the LESS specific domain. (That might mean that the User Login can be accessed by rapId with different sub-domains, like "site3.example.com".)

Alternate. The sapIdSpec may denote a JSON file. If it does, then in order to create a User Login, the file is retrieved (via HTTPS). (In this case, the URI is unrestricted and may be at any domain name. i.e. The sapIdSpec does not have to start with the rapId of the current page.) The JSON file may contain a list of ulCreation authorized rapId. i.e. A list of rapId that are allowed to CREATE new User Logins using that sapId. (i.e. a "ulCreationRpIdList") If the rapId of the current page is authorized by the list, then it is allowed to create a new User Login. The file may also contain a list of rapId that are allowed to FIND and use those User Logins created with the sapIdSpec. (i.e. a "allowedRapIdList") In this case, that list is made the authorized rapId list. Similar to allowedRpIdRules.

When creating a new User Login. The RP may specify a sapIdSpec value that is different from the default. It will work as long as the new sapId value starts with a registrable domain suffix of, or is equal to, the caller’s origin's effective domain. (The sapId value before the path component is restricted in this manner.)

When finding existing User Login. If sapIdSpec is not present, then set sapIdSpec to effectiveDomain. (i.e. the rapId of the RP.) Otherwise: If the domain name in sapId (before the slash) is not a registrable domain suffix of and is not equal to effectiveDomain, return a DOMException whose name is "SecurityError", and terminate this algorithm. Set sapId to callOptions.sapId. Note: the sapId before the slash represents the caller’s RP ID. The sapId specifies an attribute of the User Logins. The sapId defaults to being the caller’s origin's effective domain unless the caller has explicitly set sapId when calling remereLogin_api.performServiceOp -- and/or LoginManager.collectUserLogins().

Example ServiceGroup HTML Element:
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup" servicegroup-config='{ "challengeTime": 1599876543210, "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK", "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"}, "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"}, "sapIdSpec":"example.com/path/svApp.json", "mediation": "required", "user_info": {"username":"qi:A:A:2:M4j-q:XSAErLq"} }] }'/>

RML BiscProfile Detail: Property "biscProfile.ulCreationRpIdList" (longName: "fubar")

Type string.

The list of rapId that are allowed to create a new User Login. (Using the sapIdSpec as the sapId.) These are ulCreation authorized rapId. (for User Login creation)

If the ulCreationRpIdList is not specified (or is empty) then the default rules of sapIdSpec apply. (Only the rapId that the sapIdSpec starts with is authorized. Or, if the sapIdSpec is a JSON file, then it can contain the ulCreationRpIdList.)

Example ServiceGroup HTML Element:
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup" servicegroup-config='{ "challengeTime": 1599876543210, "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK", "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"}, "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"}, "sapIdSpec":"example.com/path/svApp.json", "ulCreationRpIdList": ["login.example.com", "example2.com"], "mediation": "required", "user_info": {"username":"qi:A:A:2:M4j-q:XSAErLq"} }] }'/>

RML BiscProfile Detail: Property "biscProfile.FIDO_appId" (longName: "fubar")

Type string.

No longer in use. This refers to an old specification used by FIDO.

Specifies one or more facets of the same application. A facet is either a domain name, sub-domain name, or an Android or iOS app key.

This specification defines a "Key Storage" system. This storage system is not part of a web browser, but is remotely accessible from a web browser, and from other applications. The system can be running on a device such as a phone and the applications may be phone applications. (Android or iOS applications.) The "Key Storage" system may be a physical device, (such as a USB stick) or it may be remote (i.e. running on an internet server). The "Key Storage" system assigns a "KeyHandle" to every key that it generates. A web browser, or other application, accesses the keys in the "Key Storage" by providing a keyHandle, and an AppID.

The "Key Storage" stores keys based on the RP. However, if that was the case, then all applications that wanted to access

If applications accessed keys with only a keyHandle, then there could be a malicious app, installed on the device (on the phone or desktop computer) that can bypass the security. It can try every possible keyHandle, in order to steal every key. Because of this, having only a keyHandle is too little security. Instead, an application must PROVE that it is allowed to access the "Key Storage" system for the desired keyHandle. If applications accessed keys by providing both a keyHandle and an RP identification string.

An appId value allows each of the specified facets to use the same authentication. A user can use a web browser, or an app on their mobile phone, and use the same credential to authenticate themselves to the application. The same username and public key, etc. Without an appId, each different application would have to have its own method of authentication. (A different username and password for each web browser, and for each mobile phone app.)

Most of the time, an appId is not needed.

The default is for the appId to be missing from the "Bisc Site Document" entirely. In this case, the browser uses a "default value" for the appId. This consists of the

Examples:
  • "https://RP_example.com"
  • "/app-id.json"
  • "https://example.com/app-id.json"

The specification must not allow one RP to access the credentials of another RP. What set of Web origins and native applications (facets) make up a single logical application and how can they be reliably identified? How can we avoid making the user register a new key for each web browser or application on their device that accesses services controlled by the same target entity? How can access to registered keys be shared without violating the security guarantees around application isolation and protection from malicious code that users expect on their devices? How can a user roam credentials between multiple devices, each with a user-friendly Trusted Computing Base for FIDO?

Default is the page origin. Example: "https://RP_example.com:2030"

The appId, if it exists, must be a JSON object that lists the facets of the application.

The appId document must be retrieved using an anonymous fetch. That is, the HTTP GET used to retrieve the document MUST not have any cookies, authentication, Origin or Referrer headers, and must not use any TLS certificates or other credentials. The response delivering the document MUST have a MIME Content-Type of "application/json".

The appId only needs to be specified if the application can be reached through multiple urls and/or mobile. If connecting to the app on a different url, but it has the same app-id, it instructs the browser (or app) to use the same proof (use the same private key on both urls). Without the app-id, accessing the service via different means would use different private keys. See App ID and FIDO Alliance Specification .

{
  "trustedFacets": [{
    "version": { "major": 1, "minor" : 0 },
    "ids": [
        "https://login.example.com",
        "https://secure.example.com",
        "android:apk-key-hash:585215fd5153209a7e246f53286035838a0be227"
    ]
  }]
}

RML BiscProfile Detail: Property "biscProfile.loginUseRules"

Type Object. Required. (A value must be specified.)

Specifies the extended User Login information.

Example BiscProfile:
serviceItemStart{
  "id": "remere_1",
  "protocolSpec": "remere",
  "sapIdSpec": "example.com/path/svApp.json",
  "loginUseRules": {
    "altLoginSourceList": [
      {"sapId":"login.example.com/svApp2.json", "colMode":"SSO"},
      {"sapId":"example.com/svApp3.json", "colMode":"SSO"} ]
  },
  "userLoginCreation": {
    "allowedRpIdRules": {"rpMatch": [{"id":"example2.com", "all-subdomains":"yes"}]}
  },
  ...
}serviceItemEnd

RML BiscProfile Detail: Property "biscProfile.loginUseRules.altLoginSourceList"

The list of "Foreign User Login Service Apps" (foreign sapId) supported by the RP. That is, the list of Foreign RP from which the RP is willing and able to use a Login Item to authenticate the user.

This option allows the RP to receive and process User Login information that belongs to the listed Foreign RP. That is, the RP can use User Logins that belong to the Foreign RP website. (Those User Logins that are normally used to login the user to the foreign website.)

This option is for websites that want to use the User Login created by a different website. (i.e. To share login credentials.) To allow the user to login to the RP website with the username and credentials for a different website. For example, a set of websites may only have one username and set of credentials for a user. (All are shared for the websites in the group). This is also useful if a website changes its domain name. The new website can continue to use the same logins as the old website.

Contains two lists. (1) "altLoginSourceList" is other RP that are alternate sources for credentials. (2) "allowedRpIdRules" contains Foreign RP that are allowed to use this RP's credentials.

Example BiscProfile:
serviceItemStart{
  "id": "remere_1",
  "protocolSpec": "remere",
  "sapIdSpec": "example.com/path/svApp.json",
  "loginUseRules": {
    "altLoginSourceList": [
      {"sapId":"login.example.com/svApp2.json", "colMode":"SSO"},
      {"sapId":"example.com/svApp3.json", "colMode":"SSO"} ]
  },
  "userLoginCreation": {
    "allowedRpIdRules": {"rpMatch": [{"id":"example2.com", "all-subdomains":"yes"}]}
  },
  ...
}serviceItemEnd

RML BiscProfile Detail: Property "biscProfile.mediation"

Type string.

Specifies if the RP requires user presence and approval.

If the service requires user intervention.

Options are: "silent", "optional", "required"

Example ServiceGroup HTML Element:
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup"
 servicegroup-config='{ "challengeTime": 1599876543210,
  "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK",
  "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"},
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
  "mediation": "required"}] }'/>

RML BiscProfile Detail: Property "biscProfile.rml.biscProfile.displayInfo" (longName: "fubar")

Type Object.

Specifies custom names and icons for the site. Can be displayed to the user in the identity login box.

Example BiscProfile:
serviceItemStart{
  "protocolSpec": "remere",
  "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"},
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
  "displayInfo": {
    "loginIcon": "/images/logo.png"
  }
}serviceItemEnd

RML BiscProfile Detail: Property "biscProfile.userLoginCreation"

Type Object. Default value: {"createMethods":["assigned_ulc"]}

Specifies the "User Login creation" options that the RP supports. The values must be from the UserLogin Creation Methods. (Used with the "registerUserLogin" opId.) Used in the RML Request.user_login_creation_method value.

Specifies the Single-site UserId to use during User Login creation. (i.e. When registering the user.) The value must be one of the set of UserId created by the RP, and given to the browser to choose from.

This value is used by the requested_ulc User Login Creation Method.

TODO, WARNING: THE userIdGenMethods PROPERTY MAY BE REMOVED. This property really isn't needed.

Example ServiceGroup HTML Element:
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup" servicegroup-config='{ "challengeTime": 1599876543210, "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK", "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"}, "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"}, "mediation": "required", "userLoginCreation": {"userIdGenMethods":["st1","ct1"]} }] }'/> ... <form ... rel="servicetrigger" trigger-config='{ "op":"signData", "bip":"remere_1", "ulCreationCfg": { "userIdGenMethods": ["st1","ct1"] }, "setTriggerPropByFieldName":["input27"] }'> <input id="input26" type="text" name="user_email" value="john@example.com" placeholder="Enter your email address" /> <input id="input27" type="text" name="ulCreationCfg" value='{ "userIdGenMethods": ["st1","ct1"] }' /> </form>

The "userLoginCreation" value is an object. The object can have the "userIdGenMethods" property. The "st1" value means "server timestamp format #1". The "ct1" value means "client timestamp values format #1"

The RML BiscProfile userLoginCreation value tells the browser what the RP's rules are. The RML TriggerConfig ulCreationCfg asks the RP to change its default behavior.

This property is used to specify a Single-site UserId. (As opposed to a Locked Id.) Therefore, it is only used when the RP supports both User Login creation and account login using Single-site UserIds. (Which is the default.) Specifically, the RP must support Single-site UserIds (i.e. the "single_site_userId" userLoginCreation.userIdTypes), and it must be capable of storing Credential Verification Rules (i.e. the "stored_cred" supported.userAuthScheme).

With this configuration option, the RP can provide help to the user when choosing a Single-site UserId, or validate the UserId, before the browser sends the "authentication request" to the RP.

Example BiscProfile:
serviceItemStart{
  "id": "remere_1",
  "protocolSpec": "remere",
  "sapIdSpec": "example.com/path/svApp.json"
  "userLoginCreation": {
    "userIdTypes": ["single_site_userId"],
    "createMethods": ["assigned_ulc", "claim_ms_ulc"]
  },
  "loginUseRules": {
    "altLoginSourceList": [
      {"sapId":"login.example.com/svApp2.json", "colMode":"SSO"},
      {"sapId":"example.com/svApp3.json", "colMode":"SSO"} ]
  },
  "supported": {
  }
}serviceItemEnd

RML BiscProfile Detail: Property "biscProfile.userLoginCreation.userIdTypes"

Type Array(). Default value: ["single_site_userId"]

Specifies the list of "user identifier types" the RP supports. For use in the UserId. Default is ["single_site_userId"].

An "identifier type" can be either one of the defined values (i.e. "single_site_userId"), or it can be a QIF type specifier. (i.e. contain the text "qi:", a namespace and type.) For example, either "single_site_userId" or "qi:A:H:9:ri", etc. An RP can choose to trust only QIF identifiers with a particular namespace. Or it can only trust those in a namespace that also have a certain subtype (such as "qi:A:H:9:ri"), etc.

The value is also used in the UserLogin Creation Methods. When the "claim_ms_ulc" biscProfile.userLoginCreation.createMethods is used. It limits what type of identifier can be used to identify a user at the RP.

Values include "single_site_userId", "qi:A:H:9:ri", "federated", etc.

(Used by the "RML Request.uic.format" property.)

Example: ["single_site_userId", "qi:A:H:9:ri", ...]

single_site_userId value:

The "single_site_userId" value means that the RP MUST be capable of storing some sort of Credential Verification Rule for the users. (a password, or public key, etc.) When the RP receives the "proof of identity", it will validate the proof using the Credential Verification Rule stored for the claimed UserId.

RML BiscProfile Detail: Property "biscProfile.userLoginCreation.createMethods"

Type Array(). Default value: ["assigned_ulc"]

Specifies a list of "User Login creation" methods the RP supports. (Used with the "registerUserLogin" opId.) Used in the RML Request.user_login_creation_method value.

See UserLogin Creation Methods for a list of the possible values.

Valid values are "assigned_ulc", "claim_ms_ulc", "requested_ulc" etc.

Example BiscProfile:
serviceItemStart{
  "id": "remere_1",
  "protocolSpec": "remere",
  "sapIdSpec": "example.com/path/svApp.json"
  "userLoginCreation": {
    "userIdTypes": ["single_site_userId"],
    "createMethods": ["assigned_ulc", "claim_ms_ulc"]
  },
  "loginUseRules": {
    "altLoginSourceList": [
      {"sapId":"login.example.com/svApp2.json", "colMode":"SSO"},
      {"sapId":"example.com/svApp3.json", "colMode":"SSO"} ]
  },
  "supported": {
  }
}serviceItemEnd

RML BiscProfile Detail: Property "biscProfile.userLoginCreation.allowedRpIdRules" (longName: "Permit Sharing With RP")

Type Object.

Contains the Foreign RP sharing rules.

The "rpMatch" is the list of Foreign RP that this RP allows its User Logins to be shared with. This authorizes the Foreign RP to use Logins from this RP as a "Foreign Login Source".

The Foreign RP must also list this RP as one of the "supported Foreign Login Source". So that it can ask its users to login using logins from this RP. See altLoginSourceList.

The "allowedRpIdRules" option is for websites that want to share this RP's login credentials with other websites. This will allow a user to login to OTHER websites with the username and credentials for THIS RP.

Contains a list. (2) Other rp that are allowed to use this rp's credentials.

Example BiscProfile:
serviceItemStart{
  "id": "remere_1",
  "protocolSpec": "remere",
  "sapIdSpec": "example.com/path/svApp.json",
  "loginUseRules": {
    "altLoginSourceList": [
      {"sapId":"login.example.com/svApp2.json", "colMode":"SSO"},
      {"sapId":"example.com/svApp3.json", "colMode":"SSO"} ]
  },
  "userLoginCreation": {
    "allowedRpIdRules": {"rpMatch": [{"id":"example2.com", "all-subdomains":"yes"}]},
    "allowedRapIdList": [{"rapId":"example2.com"}, {"rapId":"example3.com"}]
  },
  ...
}serviceItemEnd

RML BiscProfile Detail: Property "biscProfile.userLoginCreation.allowedRapIdList" (longName: "Permit Sharing With RP")

Type Object.

Contains the Foreign RP sharing rules.

The list of Foreign RP that this RP allows its User Logins to be shared with. This authorizes the Foreign RP to use Logins from this RP as a "Foreign Login Source".

The Foreign RP must also list this RP as one of the "supported Foreign Login Source". So that it can ask its users to login using logins from this RP. See altLoginSourceList.

The "allowedRapIdList" option is for websites that want to share this RP's login credentials with other websites. This will allow a user to login to OTHER websites with the username and credentials for THIS RP.

Contains a list. (2) Other rp that are allowed to use this rp's credentials.

Example BiscProfile:
serviceItemStart{
  "id": "remere_1",
  "protocolSpec": "remere",
  "sapIdSpec": "example.com/path/svApp.json",
  "loginUseRules": {
    "altLoginSourceList": [
      {"sapId":"login.example.com/svApp2.json", "colMode":"SSO"},
      {"sapId":"example.com/svApp3.json", "colMode":"SSO"} ]
  },
  "userLoginCreation": {
    "allowedRapIdList": [{"rapId":"example2.com"}, {"rapId":"example3.com"}]
  },
  ...
}serviceItemEnd

RML BiscProfile Detail: Property "biscProfile.supported"

Type Object. Required. (A value must be specified.)

The section containing all the protocols, etc. that the RP supports.

Contains the protocols, etc. that are supported.

RML BiscProfile Detail: Property "biscProfile.supported.userAuthScheme"

Type Array(). Default value: ["only_MSUID"]

Specifies a list of "Remere Login UA methods" that the RP supports. See the Login Method List. For example, "stored_cred".

The values in this property are used by the "user_auth_method" property.

This property contains a list of which authentication methods can be used to login to the RP.

RML BiscProfile Detail: Property "biscProfile.supported.uic"

Type Object.

Specifies a UserId certificate information object.

RML BiscProfile Detail: Property "biscProfile.supported.uic.format" (longName: "supported.uic.format")

Type Array(). Default value: ["JWS"]

TODO. MAY_BE_REMOVED. Identity certificates are only used when a person uses a "Federated UserId". (i.e. A type of Locked Id that uses an "identity provider".)

Specifies a list of the "UserId certificate formats" the RP supports. RPs must support at least "JWS".

(Used by the RML Request.uic.format property.)

Values include "JWS-CS" ("JWS-Compact Serialization"), "JWE-CS" (JWE-Compact Serialization), "JWS" (Long form JWS-JSON), "chain_42".

If "chain_42" is used, then the "uic.ucv" is not used, and the "user_id_certificate_chain" is used instead.

RML BiscProfile Detail: Property "biscProfile.supported.uic.csvm" (longName: "supported.uid_cert.sig_ver_method")

Type Array(). Default value: ["basic1"]

TODO. MAY_BE_REMOVED. Identity certificates are only used when a person uses a "Federated UserId". (i.e. A type of Locked Id that uses an "identity provider".)

Specifies a list of "UserId certificate signature verification methods" the RP supports. RPs must support at least "basic1".

(Used by the RML Request.uic.csvm property.)

The RP uses the "supported.uic.csvm" value in an attempt to verify the UserId certificate. To do this, typically the RP must get a list of signature verification keys from the issuer of the certificate. This is to verify the UserId certificate actually was signed by the issuer. Thus, in a lot of cases, the "supported.uic.csvm" value is used for Certificate Signature Verification Protocol.

Valid values are "basic1", "basic2". (These include "OIDCD" and "BrowserID".)

TODO MAY_BE_REMOVED (X.509 certificate chain and thumbprints, JSON web key and url, etc.) Prefix an entry with "-" (minus sign, dash) to drop support for it. (Example: "supported.uic.csvm": ["basic2","-basic1"]

RML BiscProfile Detail: Property "biscProfile.supported.credentialProof.formats" (longName: "supported.credentialProof.formats")

Type Array(). Default value: ["TBD-CPF"]

Specifies a list of the Credential Verification Rule "formats" the RP supports. RPs must support at least "TBD-CPF".

(Used by the RML Request.credentialProof.fmt_p property.)

It is expected that this attribute is rarely used, as the default will suffice. However, it is here in case an RP wants to use something else.

Known values are "TBD-CPF" and "fmt_cert_42".

RML BiscProfile Detail: Property "biscProfile.credentialReg.ruleTypes"

Lists the types of Credential Verification Rule that the RP can store for users. (The RML Request.credentialRegistration.type (typ_r) property should be one of these values.)

Valid values are "password", "pubkey", "federated".

(CVR types define types of CVR. User Identifier Types define types of identifiers.)

RML BiscProfile Detail: Property "biscProfile.credentialReg"

Type Object. Default value: {"publicKeyTypes":[{"name":"pubkey_s1", "JWA_alg":"ES256", "storageQuantity":"1"}]}

Lists the "Credential Verification Rule" types and number that the RP can store for users.

Valid property names are "credentialReg.passwordTypes", "credentialReg.publicKeyTypes", "credentialReg.federatedTypes", "HOTP", "TOTP".

"password" uses the "credentialReg.passwordTypes. HOTP protocol.

Example BiscProfile:
serviceItemStart{
  "id": "remere_1",
  "protocolSpec": "remere",
  "endpointBlock": {
    "id":"endpoint_1", "sUri":"/_remere/requestServiceOp.json", "supportedFormats": ["JWS"]
  },
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
  "userLoginCreation": {
    "userIdTypes": ["single_site_userId", "qi:A:H:9:ri"],
    "createMethods": ["assigned_ulc", "claim_ms_ulc"]
  },
  "credentialReg": {
    "ruleTypes": {"pubkey":"1"},
    "passwordTypes": [{"name":"password_s1", "maxLength":14, "storageQuantity":"1"}],
    "publicKeyTypes": [{"name":"pubkey_s1", "JWA_alg":"ES256", "storageQuantity":"1"}],
    "required_ruleTypes": {"pubkey1":"1"}       // The RP requires a "public key" authentication.
  },
  "supported": {
    "userAuthScheme": {"methods":["stored_cred", "only_MSUID"]},
    "supported.uic.csvm": ["basic1", "basic2"]
  },
  "requirement_section": {}
}serviceItemEnd

RML BiscProfile Detail: Property "biscProfile.credentialReg.passwordTypes"

Type Object.

Lists the "Credential Verification Rule" "password" type and number that the RP can store for users.

RML BiscProfile Detail: Property "biscProfile.credentialReg.publicKeyTypes"

Type Object. Default value: {"size":"1"}

Lists the "Credential Verification Rule" "pubkey" type and number that the RP can store for users.

Valid properties are "size". An RP can declare it does NOT support storing any public keys for the user by either setting "size": "0" or setting "pubkey":{}.

RML BiscProfile Detail: Property "biscProfile.credentialReg.publicKeyTypes.JWA_alg"

Type Object. Default value: "ES256"

The JWK algorithm of the public key Credential Verification Rule being sent to the RP in the CVR section.

Valid values are "ES256", "RS256", "RS384", "RS512". See RML Request.JWS.sig_alg and alg_COSE.

RML BiscProfile Detail: Property "biscProfile.credentialReg.federatedTypes"

Type Object.

Lists the "Credential Verification Rule" "federated" type and number that the RP can store for users.

See federated credential.

RML BiscProfile Detail: Property "biscProfile.credentialReg.required_ruleTypes"

Type Object.

The type and number of "Credential Verification Rule" that the RP REQUIRES.

Valid property names are whatever types are defined in "credentialReg". Examples are: "pubkey1", "password1", "federated1".

Tells the browser what the RP requires that the "proof of identity" contain. A common "required" Credential Verification Rule (CVR) is a public key. A "supported public-key" CVR means that the RP must be able to store a "public key" for each of its users. (Should a user choose to sign-in with a public key.) Being a "required" CVR means that the RP requires the user to send a digital signature signed by the private key. (Provides additional security.)

RML BiscProfile Detail: Property "biscProfile.credentialReg.required_ruleTypes.pubkey1"

Type Object. May be Required?.

RML BiscProfile Detail: Property "biscProfile.supported.factor2"

Type Array().

Specifies the types of 2nd factor authentication that are supported. If the attribute is omitted, no 2nd factor is supported. The most common value is "JWT". Used to support a 2nd authentication form. Tells the browser to submit a second JWT, signed by the user's private key for the RP.

RML BiscProfile Detail: Property "biscProfile.requirements"

Type Object.

The section containing all the protocols, etc. that the RP requires.

Contains all the requirements of the Service. The protocols, etc.

RML BiscProfile Detail: Property "biscProfile.requirement_section.factor2"

Type string.

Specifies the type of 2nd factor authentication required. If the attribute is omitted, no 2nd factor is required. The most common value is "JWT". Used to require a 2nd authentication form. Tells the browser to submit a second JWT, signed by the user's private key for the RP.

RML BiscProfile Detail: Property "biscProfile.userAuthenticationRequirements"

Type Object. Required. (A value must be specified.)

Specifies the RP requirements for authenticating a user. i.e. This lists the RP requirements for creating and modifying a User Login.

Example BiscProfile:
serviceItemStart{
  "id": "remere_1",
  "protocolSpec": "remere",
  ...
  "userLoginCreation": {
    "allowedRpIdRules": {"rpMatch": [{"id":"capisdemo.example2.com", "all-subdomains":"yes"}]}
  },
  "userAuthenticationRequirements": {
    "comment_21": "Each loginConfiguration details the number and type of credentials required for that configuration.",
    "loginConfigurations": [
      { "id": "cfg1", "allow": "always", "credentialInfoList": [
        {"type":"module", "mid":"pubKeyFirst"} ]
      },
      { "id": "cfg2", "allow": "always", "credentialInfoList": [
        {"type":"module", "mid":"passwordCred2"} ]
      }
    ],
    "credentialInfoModules": [
      { "id": "passwordCred2", "allow": "always", "credentialInfoList": [
        { "type":"password", "transport":"raw" } ]
      },
      { "id": "pubKeyFirst": "allow": "always", "credentialInfoList": [
        { "type":"public-key", "alg_COSE": -7 },
        { "type":"public-key", "alg_COSE": -257 } ]
      }
    ]
  }
}serviceItemEnd

RML BiscProfile Detail: Property "biscProfile.loginConfigurations"

Type Object. Required. (A value must be specified.)

An array of loginConfiguration objects. Each loginConfiguration object details the requirements for authenticating a user.

The credentialInfoList contains credentialInfo items. These items can have a "type" that is one of "public-key", "password", "federated", or "module". The "module" value means that the credentialInfo definition exists in a different place, in the credentialInfoModules.

Example BiscProfile:
serviceItemStart{
  "id": "remere_1",
  "protocolSpec": "remere",
  ...
  "userLoginCreation": {
    "allowedRpIdRules": {"rpMatch": [{"id":"capisdemo.example2.com", "all-subdomains":"yes"}]}
  },
  "userAuthenticationRequirements": {
    "comment_21": "Each loginConfiguration details the number and type of credentials required for that configuration.",
    "loginConfigurations": [
      { "id": "cfg1", "allow": "always", "credentialInfoList": [
        {"type":"module", "mid":"pubKeyFirst"} ]
      },
      { "id": "cfg2", "allow": "always", "credentialInfoList": [
        {"type":"module", "mid":"passwordCred2"} ]
      }
    ],
    "credentialInfoModules": [
      { "id": "passwordCred2", "allow": "always", "credentialInfoList": [
        { "type":"password", "transport":"raw" } ]
      },
      { "id": "pubKeyFirst": "allow": "always", "credentialInfoList": [
        { "type":"public-key", "alg_COSE": -7 },
        { "type":"public-key", "alg_COSE": -257 } ]
      }
    ]
  }
}serviceItemEnd

RML BiscProfile Detail: Property "biscProfile.credentialInfoModules"

Type Object. Required. (A value must be specified.)

An array of credentialInfoModule objects. Each credentialInfoModule object details one of the credential requirements, for authenticating a user.

The credentialInfoList contains credentialInfo items. These items can have a "type" that is one of "public-key", "password", "federated".

Example see loginConfigurations:
{
}

RML BiscProfile Detail: Property "biscProfile.loginRegistrationOptions"

Type Object. Default value: {(see details)}

Lists the options for creating a credential. (i.e. a Credential Verification Rule.)

Example BiscProfile:
serviceItemStart{
  "id": "remere_1",
  "protocolSpec": "remere",
  ...
  "loginRegistrationOptions": {
    "publicKeyCredentialCreationOptions": {
      "comment_0a": "Note that both the 'rp' and 'user' properties of Webauthn have been moved.",
      "comment_0b": "The 'rp' section was MOVED to root:'service_info'. The 'user' values MOVED to the 'servicegroup-config' HTML attribute.",
      "comment_1": "rp is of type PublicKeyCredentialRpEntity (Relying Party)",
      "comment_2": "user is of type PublicKeyCredentialUserEntity",
      "comment_2b": "The id field in user, will be automatically converted into a Uint8Array.",
      "comment_2c": "id conversion is: Uint8Array.from(window.atob(id), c=>c.charCodeAt(0))",
      "comment_3": "pubKeyCredParams is an array of type PublicKeyCredentialParameters. THe order is important.",
      "comment_3b": "This Relying Party will accept either an ES256 or RS256 credential, but prefers an ES256 credential.",
      "comment_3bb": "COSE_alg is a COSEAlgorithmIdentifier",
          "comment_3c": "-7 is the value for ES256. As registered in the IANA COSE Algorithms registry",
          "comment_3d": "-257 is the value for RS256. As registered by the WebAuthn specification",
      "comment_4": "timeout is of type unsigned long. 60000 milliseconds = 1 minute",
      "comment_5": "excludeCredentials is an array of type PublicKeyCredentialDescriptor",
      "comment_5b": "In this example, there is No exclude list of PKCredDescriptors",
      "comment_6": "extensions is of type UserAuthenticationExtensionsClientInputs",
      "comment_6b": "An extension of {loc:true} means Include location information in attestation.",
      "comment_7": "attestation is of type AttestationConveyancePreference. values are none, direct, indirect",
      "comment_8": "authenticatorSelection is of type UserAuthenticatorSelectionCriteria",
    
      "rp_REMOVED": {
        "name": "ACME Corporation",
        "icon": "http://example.com/some/path/icon.png",
        "id": "https://login.example.com"
      },
    
      "user_REMOVED": {
        "id_comment": "id is of type BufferSource. id will be converted. Uint8Array.from(window.atob(id), c=>c.charCodeAt(0))",
        "id": "MIIBkzCCATigAwIBAjCCAZMwggE4oAMCAQIwggGTMII=",
        "name": "alex.p.mueller@example.com",
        "displayName": "Alex P. Müller",
        "icon": "https://pics.example.com/00/p/aBjjjpqPb.png"
      },
    
      "pubKeyCredParams": [
        {
          "type": "public-key",
          "alg_COSE": -7
        },
        {
          "type": "public-key",
          "alg_COSE": -257 
        }
      ],
      "timeout": 60000,
      "excludeCredentials": [],
      "extensions": {"loc": true},
      "attestation": "none",
      "authenticatorSelection": {
        "authenticatorAttachment": "platform",
        "residentKey": "required",
        "requireResidentKey": false,
        "userVerification": "preferred"
      }
    }
  }
  "loginProofOptions": {
    "publicKey": {
      "rpId_REMOVED": "example.com",
      "timeout": 60000,
      "allowCredentials": [
        { "type":"public-key" },
        { "type":"public-key", "id":"!!!!!!!hi there!!!!!!!\n" },
        { "type":"public-key", "id":"roses are red, violets are blue\n" },
        { "type":"public-key", "transports": [] }
      ],
      "userVerification": "preferred",
      "extensions": {
        "txAuthSimple": "Wave your hands in the air like you just don’t care",
        "webauthnExample_foobar": 42
      }
    }
  }
}serviceItemEnd

RML BiscProfile Detail: Property "biscProfile.loginRegistrationOptions.publicKey"

Type Object.

Lists the options for creating a Public Key credential.

(i.e. a Credential Verification Rule.)
Example BiscProfile:
serviceItemStart{
  "id": "remere_1",
  "protocolSpec": "remere",
  ...
  "loginRegistationOptions": {
    "publicKey": {
       "pubKeyCredParams": [
        {
          "type": "public-key",
          "alg_COSE": -7
        },
        {
          "type": "public-key",
          "alg_COSE": -257 
        }
      ],
      "timeout": 60000,
      "excludeCredentials": [],
      "extensions": {"loc": true},
      "attestation": "none",
      "authenticatorSelection": {
        "authenticatorAttachment": "platform",
        "residentKey": "required",
        "requireResidentKey": false,
        "userVerification": "preferred"
      }
    }
  }
  "loginProofOptions": {
    "publicKey": {
      "rpId_REMOVED": "example.com",
      "timeout": 60000,
      "allowCredentials": [
        { "type":"public-key" },
        { "type":"public-key", "id":"!!!!!!!hi there!!!!!!!\n" },
        { "type":"public-key", "id":"roses are red, violets are blue\n" },
        { "type":"public-key", "transports": [] }
      ],
      "userVerification": "preferred",
      "extensions": {
        "txAuthSimple": "Wave your hands in the air like you just don’t care",
        "webauthnExample_foobar": 42
      }
    }
  }
}serviceItemEnd

RML BiscProfile Detail: Property "biscProfile.loginRegistrationOptions.pubKeyCred.JWA_alg"

Type string. Default value: "ES256"

Lists the options for creating a Public Key credential.

RML BiscProfile Detail: Property "biscProfile.loginRegistrationOptions.pubKeyCred.cci"

Type integer. Default value: none

Lists the options for creating a Public Key credential.

RML BiscProfile Detail: Property "biscProfile.loginRegistrationOptions.pubKeyCred.type"

Type string. Default value: none

Lists the options for creating a Public Key credential.

RML BiscProfile Detail: Property "biscProfile.loginRegistrationOptions.pubKeyCred.alg_COSE"

Type integer. Default value: -7 (i.e. JWA "ES256".)

Lists the options for creating a Public Key credential.

Example BiscProfile:
serviceItemStart{
  "id": "remere_1",
  "protocolSpec": "remere",
  ...
  "loginRegistationOptions": {
    "publicKey": {
       "pubKeyCredParams": [
        {
          "type": "public-key",
          "alg_COSE": -7
        },
        {
          "type": "public-key",
          "alg_COSE": -257 
        }
      ],
      "timeout": 60000,
      "excludeCredentials": [],
      "extensions": {"loc": true},
      "attestation": "none",
      "authenticatorSelection": {
        "authenticatorAttachment": "platform",
        "residentKey": "required",
        "requireResidentKey": false,
        "userVerification": "preferred"
      }
    }
  }
  "loginProofOptions": {
    "publicKey": {
      "rpId_REMOVED": "example.com",
      "timeout": 60000,
      "allowCredentials": [
        { "type":"public-key" },
        { "type":"public-key", "id":"!!!!!!!hi there!!!!!!!\n" },
        { "type":"public-key", "id":"roses are red, violets are blue\n" },
        { "type":"public-key", "transports": [] }
      ],
      "userVerification": "preferred",
      "extensions": {
        "txAuthSimple": "Wave your hands in the air like you just don’t care",
        "webauthnExample_foobar": 42
      }
    }
  }
}serviceItemEnd

RML BiscProfile Detail: Property "biscProfile.loginProofOptions"

Type Object.

Lists the options for creating a credential assertion.

"comment_1": "rapId is of type USVString", "comment_2": "timeout is of type unsigned long. 60000 milliseconds = 1 minute", "comment_3": "allowCredentials is an array of type PublicKeyCredentialDescriptor.", "comment_3b": "The id fields in allowCredentials, will be automatically converted into a Uint8Array.", "comment_3c": "id conversion is: Uint8Array.from(window.atob(id), c=>c.charCodeAt(0))", "comment_3d": "allowCredentials item, transports values are usb, nfc, ble", "comment_3e": "allowCredentials item can omit the id field? Example 8 in webauthn", "comment_5": "userVerification is of type UserVerificationRequirement", "comment_6": "extensions is of type UserAuthenticationExtensionsClientInputs",

Example BiscProfile:
serviceItemStart{
  "id": "remere_1",
  "protocolSpec": "remere",
  ...
  "loginProofOptions": {
    "publicKey": {
      "rpId_REMOVED": "example.com",
      "timeout": 60000,
      "allowCredentials": [
        { "type":"public-key" },
        { "type":"public-key", "id":"!!!!!!!hi there!!!!!!!\n" },
        { "type":"public-key", "id":"roses are red, violets are blue\n" },
        { "type":"public-key", "transports": [] }
      ],
      "userVerification": "preferred",
      "extensions": {
        "txAuthSimple": "Wave your hands in the air like you just don’t care",
        "webauthnExample_foobar": 42
      }
    }
  }
}serviceItemEnd

RML BiscProfile Detail: Property "biscProfile.loginProofOptions.publicKey"

Type Object.

Lists the options for creating a credential assertion.

"comment_1": "rapId is of type USVString", "comment_2": "timeout is of type unsigned long. 60000 milliseconds = 1 minute", "comment_3": "allowCredentials is an array of type PublicKeyCredentialDescriptor.", "comment_3b": "The id fields in allowCredentials, will be automatically converted into a Uint8Array.", "comment_3c": "id conversion is: Uint8Array.from(window.atob(id), c=>c.charCodeAt(0))", "comment_3d": "allowCredentials item, transports values are usb, nfc, ble", "comment_3e": "allowCredentials item can omit the id field? Example 8 in webauthn", "comment_5": "userVerification is of type UserVerificationRequirement", "comment_6": "extensions is of type UserAuthenticationExtensionsClientInputs",

Example BiscProfile:
serviceItemStart{
  "id": "remere_1",
  "protocolSpec": "remere",
  ...
  "loginProofOptions": {
    "publicKey": {
      "rpId_REMOVED": "example.com",
      "timeout": 60000,
      "allowCredentials": [
        { "type":"public-key" },
        { "type":"public-key", "id":"!!!!!!!hi there!!!!!!!\n" },
        { "type":"public-key", "id":"roses are red, violets are blue\n" },
        { "type":"public-key", "transports": [] }
      ],
      "userVerification": "preferred",
      "extensions": {
        "txAuthSimple": "Wave your hands in the air like you just don’t care",
        "webauthnExample_foobar": 42
      }
    }
  }
}serviceItemEnd

RML Request Detail

The Remere Login Service Request (RML Request) is a communication from the browser to the Service Endpoint. It asks the RP to perform a user authentication service, such as "login", and it contains all the data needed for that purpose. It is a type of Service Request. It consists of a single JSON object. The JSON contains a JSON Web Signature. The RP will send a RML Response in response to the request.

In general, the RML Request is used to transmit a "proof of identity", along with any other necessary data, to the RP. Using a JWS allows all the data to be cryptographically signed, with multiple signatures. The signatures can be verified by the RP. The payload of the JWS is used to store all the custom information. The payload values include a requested user authentication command (i.e. the opIdReq). The opIdReq value should contain a opId that is one of the RML Operation List. (i.e. "login", "registerUserLogin", "setActiveCredentials" etc.)

The browser sends the RML Request to the "Service Endpoint" in whatever manner the RP designated in its RML BiscProfile. (i.e. In the a BiscGroup, such as in the Bisc Site Document.) Usually the method is an HTTP POST. (As a special case, if the Service Trigger HTML Element that activated Capis is a form, and Capis is configured to send an HTTP POST, then the browser will send the service request as a special HTTP parameter *in addition to* any regular form data. The default name of the HTTP parameter is capis_request.)

Example RML Request JSON object:
let payload_unencoded = { "requestFormat": "remereRequestFormat 0.1", "protocolId": "remere", "opIdReq": "setActiveCredentials", "sub": "remere_1/setActiveCredentials", "iat": 1503971280, // issuedAt timestamp "exp": 1533064012, // expiresAt timestamp "aud": "RP_example.com", // the audience "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK", // nonce value "cht": 1533064012, // challengeTimestamp "uid": { "encReqValue": "xxxxxxxx", "rawForLogin": "qi:A:A:2:M4j-q:XSAErLq", // The QIF UserId "encForLogin": "q3jC9-h", "usk": "q3jC9-h" }, "user_auth_method": "stored_cred", "redirectUri": "/some/path/page.html", "useCount": 42,
/* The user_id_certificate_chain is absent when using the "stored_cred" uauth_method. // user_id_certificate_chain "uic_chain": [ {"uic.format":"JWS", "uic.csvm":"YY", "ucv": { "payload":"82h7vb...", "signatures": [...] }} ], */
// crProofSection. "crProofSection": { "uid": { "raw2": "qi:A:H:2:xxxxxxxx", // The QIF UserId }, "uapCounter": 42, "aar": { // authenticatorAssertionResponse (optional) "adf": "WebAuthN 1.0", // authenticatorData_format "cda": "xxx", // clientDataJSON. Serialized JSON. "ada": "xxx", // authenticatorData. base64url encoded. "uha": "xxx" // userHandle. base64url encoded. }, "cpl": [ // credentialProofList { "cid_p": "cd2", "typ_p": "pubkey", "fmt_p": "TBD-CPF", // "format": "TBD-CPF" (not necessary. The default is "TBD-CPF".) "val_p": "mmmm" // base64url encoded JWT or signature. } ] }, // "credRegSec" credentialRegSection. Required for "registerUserLogin" and "setActiveCredentials" opId. "credRegSec": { "backup_credentials": [ { "cid_r": "cd-3", "typ_r": "pubkey", "fmt_r": "JWK", "alg_COSE": -7, "val_r": { ... } } ], "crList": [ { "cid_r": "cd10", "typ_r": "pubkey", "fmt_r": "JWK", "alg_COSE": -7, "val_r": { "kty": "EC", "kid": "cd10", // "kid" is REQUIRED. Same as the "cid_r". "crv": "P-256", "ext":true, "key_ops": ["verify"], "x": "5sy3ogiqTrlC_FF7aOdCq7cNFsN2nbrH4xQmNCCBtso", "y": "ctK7P_LU-SQPf-ejkmC1JYzm7S5N0B6ZX5rwOQWzuv8" }, "aof": "WebAuthN 1.0", // attestation_object_format "aod": "xxx" // attestation_object. base64url encoded. }, // If the RP allows 2 public keys as Credential Verification Rule. { "cid_r": "cd11", "typ_r": "pubkey", "fmt_r": "JWK", "alg_COSE": -257, "val_r": { "kty": "RSA", "kid": "cd11", // "kid" is REQUIRED. Same as the "cid_r". "alg222": "RS256", "n" : "4b9e34...", "e" : "93bc32..." }, "aof": "WebAuthN 1.0", // attestation_object_format "aod": "xxx" // attestation_object. base64url encoded. } ] } }; let RML Request = { "JWS": { "payload": BASE64URL(UTF8(payload_unencoded)), "signatures": [ { "protected": "eyJhbGciOiJFUzI1NiJ9", // protected_header = {"alg":"ES256", "sct":192} "header": { "kid": "cd1", "kid2": "e9bc097a-ce51-4036-9562-d2ade882db0d" // "kid": "userIdPK" // "userIdPK" means the public key is in "uid". }, "signature": "DtEhU3ljbEg8L38VWAfUAqOyKAM6-Xx-F4Ga" } ] } }

RML Request - List of Properties

Special JSON properties used in the "service request" JSON object

The following properties can be used in the "service request" JSON object. The following properties can be used in the "payload" JSON object.

RML Request: Property "requestData.JWS" (longName: "JWS")

Type Object. Required. (A value must be specified.)

Contains a JSON Web Signature value. It is used as a UserId Assertion.

The JWS property contains a "JSON Web Signature" type of request. This is only one of the possible types of requests. Other types can be created in the future. JWE, etc. This allows the spec to be extended in the future. (For extensibility.)

Example RML Request:
let RML Request = {
  "JWS": {
    "payload": BASE64URL(UTF8(payload_unencoded)),
    "signatures": [
      { "protected": "eyJhbGciOiJFUzI1NiJ9",
        // protected_header = {"alg":"ES256", "sct":192}
        "header": {
          "kid": "cd1", "kid2": "e9bc097a-ce51-4036-9562-d2ade882db0d"
        // "kid": "userIdPK" // "userIdPK" means the public key is in "uid".
        },
        "signature": "DtEhU3ljbEg8L38VWAfUAqOyKAM6-Xx-F4Ga"
      }
    ]
  }
}

RML Request: Property "requestData.JWS.payload" (longName: "payload")

Type Object. Required. (A value must be specified.)

Contains the data to be signed.

RML Request: Property "requestData.JWS.signatureInfo" (longName: "signatureInfo")

Type Object. Required. (A value must be specified.)

A single item in the signatures array. It represents a Credential Signature. Contains the signature. The signatures property contains an array of these items.

Example RML Request:
let RML Request = {
  "JWS": {
    "payload": BASE64URL(UTF8(payload_unencoded)),
    "signatures": [
      { "protected": "eyJhbGciOiJFUzI1NiJ9",
        // protected_header = {"alg":"ES256", "sct":192}
        "header": {
          "kid": "cd1", "kid2": "e9bc097a-ce51-4036-9562-d2ade882db0d"
        // "kid": "userIdPK" // "userIdPK" means the public key is in "uid".
        },
        "signature": "DtEhU3ljbEg8L38VWAfUAqOyKAM6-Xx-F4Ga"
      }
    ]
  }
}

RML Request: Property "signatureItem.header" (longName: "Signature unprotected header")

Type Object. Required. (A value must be specified.)

Contains the "unprotected" signature header. This commonly includes the "key id" ("kid") against which the signature should be verified.

Contains the kid property.

RML Request: Property "signatureItem.protected" (longName: "Signature protected header")

Type Object. Required. (A value must be specified.)

Contains the "protected" signature header.

RML Request: Property "signatureItem.protected.alg" (longName: "Signature Public Key Algorithm")

Type string. Required. (A value must be specified.)

Contains the public key algorithm used to create the signature.

Suggested values: "RS256", "RS384", "RS512". See alg_COSE and RML BiscProfile.JWA_alg.

RML Request: Property "signatureItem.protected.sct" (longName: "Signature Key Sign Count")

Type integer. May be required?

Contains the sign count. (Anti-forgery protection. Detect a cloned User Authenticator.)

RML Request: Property "signatureItem.header.kid" (longName: "Signature Key ID")

Type string. Required when ?.

Contains the Key ID. Uniquely identifies the key for the User Login.

Key Id value: userIdPK[:n]

The string "userIdPK[:n]" can be used as the "kid" value in signature headers in the RML Request. (Where 'n' is an integer from 1 to 100.) If it is used as the "kid" value, it notifies the RP that the signature was not created by a regular credential. Instead, the signature must be verified using the sig verification key of the public key encoded inside the "UserId". (i.e. In the "payload"."uid" value.)

Key Id value: certPK:n

The string "certPK:n" can be used as the "kid" value in signature headers in the RML Request. (Where 'n' is an integer from 1 to 100.) If it is used as the "kid" value, it notifies the RP that the signature was not created by a regular credential. Instead, the signature must be verified using the sig verification key of the public key with the specified number from the UserId certificate.

RML Request: Property "signatureItem.header.vkm" (longName: "sigInfo.header.sigVKMethod")

Type string. Required if the credential sig verification key is in the UserId Certificate. Default value: "site_stored_vks"

Used for Sig VK Method. See Set User Credential Verification Rules.

Values are site_stored_vks, userIdF and certificateF. Located in the unprotected signature header. (NOT THE SAME AS vkmc_value_list)

Ver Key Method value: site_stored_vks

The string "site_stored_vks" can be used

Ver Key Method value: userIdF

The string "userIdF" can be used as the "vkm" value in signature headers in the RML Request. If it is used as the "vkm" value, it notifies the RP that the signature was not created by a regular credential. Instead, the signature must be verified using the sig verification key of the public key encoded inside the "UserId". (i.e. In the "payload"."uid" value.)

Ver Key Method value: certificateF

The string "certificateF" can be used as the "vkm" value in signature headers in the RML Request. If it is used as the "vkm" value, it notifies the RP that the signature was not created by a regular credential. Instead, the signature must be verified using the sig verification key of the public key with the specified number from the UserId certificate.

RML Request: Property "signatureItem.header.csvm" (longName: "sigInfo.header.certificateSigVKMethod")

Type string. Required if the JWT is a UserId Certificate.

Used for Certificate Signature Verification Protocol. See Set User Credential Verification Rules.

Located in the unprotected signature header.

RML Request: Property "signatureItem.signature" (longName: "Signature")

Type string. Required. (A value must be specified.)

Contains the actual signature value.

RML Request: Property "requestData.signatures" (longName: "signatures[]")

Type Array(). Required. (A value must be specified.)

An array of signatureInfo objects. An array of signatures inside a JWS (JSON Web Signature). These signatures are created by signing the payload with a set of private keys. The signatures are given to the RP in order to authenticate the JWS to the RP. When a RML Request is composed of a JWS, the signatures will thereby authenticate the service request. A JWS supports multiple signatures. Therefore, a JWS service request is capable of Multi-Credential Authentication and Multi-Factor Authentication. (Each signature is proof of a different Credential Verification Rule. Each CVR may be a different factor.)

The Capis specification requires that each signature, except for one (for the "UserId"), MUST match a Credential Verification Rule that the RP stores for the UserId. Each signature MUST have a "kid" value (in the header section) that is the "Credential Verification Rule id" stored by the RP. (There may be less signatures than the number of CVR at the RP. The RP may have some CVR be optional, etc.)

There can be only one signature that does not directly represent a CVR stored at the RP. This is the signature from the UserId private key. The UserId private key signature will be always marked with a special "kid" value. ("kid": "userIdPK") The UserId private key signature is optional. (The RP may or may not require that user authentication requests be signed by it.) (This is for the case when the UserId contains or represents a public key. The UserId private key is the private key corresponding to the public one inside, or represented by, the UserId.)

Example RML Request:
let RML Request = {
  "payload":
   "eyJpc3MiOiJq2bUiLA0KICJleHAiOjEzMDA4MTkzODAsDQogImh0dHA6Ly9leGF
    tcGxlLmNvbS9pc19yj290Ijp0cnVlfQ",
  "signatures": [
    { "protected": "eyJhbGciOiJSUzI1NiJ9",
        // protected_header = {"alg":"RS256", "sct":192}
      "header": {"kid":"cd1"},
      "signature":
       "cC4hiUPoj9Eetdgtv3hF80EGrhuB__dzERat0XF9g2VtQgr9PJbu3XOiZj5RZ
      mh7AAuHIm4Bh-0Qc_lF5YKt_O8W2Fp5jujGbds9uJdbF9CUAr7t1dnZcAcQjb
      KBYNX4BAynRFdiuB--f_nZLgrnbyTyWzO75vRK5h6xBArLIARNPvkSjtQBMHl
      t1L07Qe7K0GarZRmB_eSN9383LcOLn6_dO--xi12jzDwusC-eOkHWEsqtFZES
      c6BfI7noOPqvhJ1phCnvWh6IeYI2w9QOYEUipUTI8np6LbgGY9Fs98rqVt5AX
      LIhWkWywlVmtVrBp0igcN_IoypGlUPQGe77Rw"
    },
    { "protected": "eyJhbGciOiJFUzI1NiJ9",
        // protected_header = {"alg":"ES256", "sct":13}
      "header": {"kid":"cd2", "kid2":"e9bc097a-ce51-4036-9562-d2ade882db0d"},
      "signature":
       "DtEhU3ljbEg8L38VWAfUAqOyKAM6-Xx-F4GawxaepmXFCgfTjDxw5djxLa8IS
      lSApmWQxfKTUJqPP3-Kg6NU1Q"
    }
  ]
}

RML Request: Property "payloadData.requestFormat" (longName: "requestFormat")

Type string. Default value: "remereRequestFormat 0.1"

The specification name and version that the RML Request is written in. (That the browser chose to use.)

The value should be one of those listed in the BiscProfile Detail.requestFormatList. If the request does not specify a requestFormat, then the RP should use the default requestFormat for the protocolSpec.

RML Request: Property "payloadData.protocolId" (longName: "protocolId")

Type string. Required. (A value must be specified.)

The protocol of the operation to be performed by the RP. It is usually copied from the "bip" property. (In the "trigger-config" attribute.)

RML Request: Property "payloadData.opIdReq" (longName: "opIdReq")

Type string. Required. (A value must be specified.)

The requested operation to be performed by the RP. It is usually copied from the "triggerConfig.op" property. (In the "trigger-config" attribute.) It should contain a opId that is one of the RML Operation List. (i.e. One of "login", "logout", "proveUserPresence", "registerUserLogin", "grantAccess", etc.)

RML Request: Property "payloadData.forSapId" (longName: "forSapId")

Type string. Required. (A value must be specified.)

Specifies the Source Application Identifier (sapId) that the selected User Login is registered to. This is usually what website the User Login was registered to.

The forSapId is always always equal to the biscProfile.sapIdSpec. The exception is when the user selects a foreignSap User Login to use (i.e. to login with).

RML Request: Property "payloadData.uam" (longName: "user_auth_method")

Type string. Default value: "stored_cred"

Specifies how the request wants the RP to authenticate the user. (If it should require that "ownership" of the MSUID be verified. i.e. With a UserId certificate.)

See Login Method List for the list of valid values. Example: "stored_cred".

Used by the "supported.userAuthScheme" service property.)

RML Request: Property "payloadData.iat" (longName: "issuedAt")

Type string. Required. (A value must be specified.)

Indicates the timestamp when the request was generated.

RML Request: Property "payloadData.exp" (longName: "expiresAt")

Type string. Required. (A value must be specified.)

Indicates the timestamp when the request expires.

RML Request: Property "payloadData.sub" (longName: "subject")

Type string. Required. (A value must be specified.)

Indicates the subject of the request.

RML Request: Property "payloadData.aud" (longName: "audience")

Type string. Required if the JWT is not a UserId certificate.

Indicates the intended audience of the request.

RML Request: Property "payloadData.challenge" (longName: "challenge")

Type string. Required. (A value must be specified.)

A "cryptographic nonce" value. base64url encoded. It is a value generated by, and passed back to, the RP. In order to prevent cross site scripting attacks. (CSS attacks) Copied from the config "challenge" option.

RML Request: Property "payloadData.cht" (longName: "challengeTimestamp")

Type string. Required. (A value must be specified.)

The timestamp when the challenge was issued. It is a value generated by, and passed back to, the RP. In order to prevent cross site scripting attacks. (CSS attacks)

RML Request: Property "payloadData.redirectUri" (longName: "redirectUri")

Type string.

The URI the caller wants to be redirected to.

RML Request: Property "payloadData.uid" (longName: "userId.mmm")

Type Object. Required. (A value must be specified.)

The claimed UserId.

This is not the actual UserId, but a temporary UserId, used only in the current session. The actual UserId is kept secret from the browser. It is encrypted and sent to the RP in an encrypted form in the "login" request. (etc.)

When the opIdReq is "registerUserLogin", the browser should set the uid.timestamp_uid property. The RP will create a new assignedUserId and send it to the browser in an encrypted form. The browser should send it to the Login Manager, using LoginManager.updateUserLoginWithServiceResult() in svUlUpdate.updatedUserId. The Login Manager will decrypt the value and store it, associated with the login.

RML Request: Property "payloadData.uid.rawForLogin" (longName: "userId.rawForLogin")

Type string. Required. (A value must be specified.)

The raw UserId.

RML Request: Property "payloadData.uid.encForLogin" (longName: "userId.encryption_value_1")

Type string. Required when opId="registerUserLogin".

The encrypted UserId. Using encryption method 1.

The encrypted UserId and the sessionUserId are extra features to protect User Privacy. They both hide the real UserId from the browser. So that the user can use any browser and the UserId for all RP websites will remain secret from the browser.

The encrypted UserId is used when the browser is not logged into the RP website. In this case, the browser must send to the RP a secret, encrypted UserId. The UserId can be encrypted using the HTTP session encryption key or with the RP website HTTPS key.

If the browser is already logged into the RP website, then the browser does NOT send the encrypted UserId to the RP. In this case, it must send the sessionUserId instead. The sessionUserId is a temporary value the RP creates to "stand-in" for the real UserId.

RML Request: Property "payloadData.uid.usk" (longName: "userId.sessionKey")

Type string. Required except when opId="registerUserLogin".

The UserId session key. The value from sessionUserId.

The encrypted UserId and the "UserId session key" are extra features to protect User Privacy. They both hide the real UserId from the browser. So that the user can use any browser and the UserId for all RP websites will remain secret from the browser.

The encrypted UserId is used when the browser is not logged into the RP website. In this case, the browser must send to the RP a secret, encrypted UserId. The UserId can be encrypted using the HTTP session encryption key or with the RP website HTTPS key.

If the browser is already logged into the RP website, then the browser does NOT send the encrypted UserId to the RP. In this case, it must send the sessionUserId instead. The sessionUserId is a temporary value the RP creates to "stand-in" for the real UserId.

RML Request: Property "payloadData.uid.encReqValue" (longName: "userId.encReqValue")

Type string. Required. (A value must be specified.)

The new UserId value for the RP to set. Encoded.

RML Request: Property "payloadData.uid.timestamp_uid" (longName: "userId.timestamp_uid")

Type string. Required when opId="registerUserLogin".

A raw UserId made from a timestamp. It is used with "registerUserLogin" opId as a "service request id". The RP copies it into the response so that the browser will know what request is being responded to.

RML Request: Property "payloadData.iss" (longName: "issuer")

Type string. Required if the JWT is a UserId certificate.

Indicates the Backer of the UserId.

RML Request: Property "payloadData.pr.uid" (longName: "pr.userId.mmm")

Type Object. Required. (A value must be specified.)

The claimed UserId.

RML Request: Property "payloadData.pr.uid.raw2" (longName: "pr.userId.raw2")

Type string. Required. (A value must be specified.)

The claimed UserId.

RML Request: Property "payloadData.uid.uit" (longName: "userId.type")

Type string.

The type of the claimed UserId. Only necessary if the UserId is not written using "QIF" format.

Valid values are a QIF type specifier. (i.e. the text "qi:", namespace_id, idClass and subClass.) Examples: "qi:A:H:9", "qi:A:A:2".

(Used by the "userLoginCreation.userIdTypes" service property.)

RML Request: Property "payloadData.uid.clientReqUserId" (longName: "uid.clientReqUserId")

Type string.

The requested username to use when creating an account.

This property is only used with one of the "Negotiated UserId" User Login Creation Method. Such as "requested2_ulc".

This property name stands for "requested username". This property value is set from the RML TriggerConfig.ulCreationCfg property. This property is what the browser (or user) asks for. This is different from the RML BiscProfile.userLoginCreation, which contains the rules, and the default userId value that the RP provides.

See biscProfile.userLoginCreation.

RML Request: Property "payloadData.uid_cert_chain" ("icc") (longName: "UserId Certificate Chain")

Type Object. Required if the browser tries to authenticate with a Locked Id that uses a UserId certificate.

(If "user_auth_method" is "only_MSUID", "combo_MSUID", or "certificate_2").

A JSON object containing an array of certificates. Each certificate is a JSON object.

(Note: If the UserId certificate is an X.509 certificate chain, then it can be stored in the UserId Assertion JWT header (in the RML Request) as the "x5c" value. There does not have to be a separate "uid_cert_chain" property in this case.)

The UserId proof includes the "uic.ucv", "uic.format", and "uic.csvm" fields. These are part of the user_id_certificate_chain.

Example RML Request:
let payload_unencoded = { "requestFormat": "remereRequestFormat 0.1", "protocolId": "remere", "opIdReq": "signData", "sub": "remere_1/signData", ... // user_id_certificate_chain (Available when not using the "stored_cred" uauth_method.) "uic_chain": [ {"uic.format":"JWS", "uic.csvm":"YY", "ucv": { "payload":"82h7vb...", "signatures": [...] }} ], ... }

RML Request: Property "payloadData.uic.ucv" (longName: "uid_cert.value -- UserId Certificate")

Type Object. Required. (A value must be specified.)

Contains an "UserId certificate". (Can be a JWT.) It is required, unless the "UserId certificate" is included in the UserId Assertion. For example, it could be an X.509 certificate and can be included in the UserId Assertion JWT as the "x5c" header property.

Example RML Request:
let payload_unencoded = { "requestFormat": "remereRequestFormat 0.1", "protocolId": "remere", "opIdReq": "signData", "sub": "remere_1/signData", ... // user_id_certificate_chain (Available when not using the "stored_cred" uauth_method.) "uic_chain": [ {"uic.format":"JWS", "uic.csvm":"YY", "ucv": { "payload":"82h7vb...", "signatures": [...] }} ], ... }

RML Request: Property "payloadData.uic.format" (longName: "uid_cert.format")

Type string. Default value: "JWS"

Specifies the format of "UserId certificate" in the "uic.ucv" property.

RPs must support at least the format "JWS" in the "supported.uic.format" service property.

Values include "JWS-CS" ("JWS-Compact Serialization"), "JWE-CS" (JWE-Compact Serialization), "JWS" (Long form JWS-JSON), "chain_42".

If "chain_42" is used, then the "uic.ucv" is not used, and the "user_id_certificate_chain" is used instead.

RML Request: Property "payloadData.uic.csvm" (longName: "uid_cert.sig_ver_method")

Type string. Default value: "OIDCD"

Contains the "UserId certificate signature verification method". This value gives the RP information about how to verify the certificate. It is usually used to tell the RP how to get the sig verification key for the certificate. (i.e. it is usually used as input to Certificate Signature Verification Protocol.) However, the RP must first know the type of the certificate, and have the ability to read it.

(Used by the "supported.uic.csvm" service property.)

Valid values are:

The browser should choose to use an IDP and an "UserId certificate" that the RP can understand.

RML Request: Property "payloadData.useCount" (longName: "useCount")

Type integer. Required. (A value must be specified.)

Holds the use count. Holds the number of times the User Login has been used. Should always increase. (Anti-forgery protection. Detect a cloned User Authenticator.)

The User Login use counter. Holds the number of times the User Login has been used. Should always increase. Every use of the User Login to login should increment the counter. For extra security, the RP can record the count. If any subsequent login by the User Login uses an equal or lower value, then the User Login was compromised. (Attempts to detect if the User Authenticator is duplicated. Or the security device was copied, etc.)

RML Request: Property "payloadData.gua" (longName: "grant_user_access")

Type Object. Required if opId="grantAccess".

The collection of information required in order to add, remove and modify a user's access to the account. Used by the Grant Access Service Action.

Example RML Request JSON object:
let payload_unencoded = { "requestFormat": "remereRequestFormat 0.1", "protocolId": "remere", "opIdReq": "grantAccess", "sub": "remere_1/grantAccess", ... // The grant_user_access section. "gua": { "backup_credentials": [ { "cid_r": "cd-3", "typ_r": "pubkey", "fmt_r": "JWK", "alg_COSE": -7, "val_r": { ... } } ], "crList": [ { "cid_r": "cd10", "typ_r": "pubkey", "fmt_r": "JWK", "alg_COSE": -7, "val_r": { "kty":"ES", "kid":"cd10", ... } } ] } }

RML Request: Property "payloadData.prs" (longName: "credentialProofSection")

Type Object. Required if opId="registerUserLogin" or "setActiveCredentials".

The details of the user identity for an RP. Includes "id", credentialProofList ("cpl").

let payload_unencoded = { "requestFormat": "remereRequestFormat 0.1", "protocolId": "remere", "opIdReq": "login", // or "proveUserPresence" "sub": "remere_1/login", ... "iat": 1503971280, // issuedAt timestamp "exp": 1533064012, // expiresAt timestamp "aud": "RP_example.com", // the audience "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK", // nonce value "cht": 1533064012, // challengeTimestamp "uid": { "encReqValue": "xxxxxxxx", "rawForLogin": "qi:A:A:2:M4j-q:XSAErLq", // The QIF UserId "encForLogin": "q3jC9-h", "usk": "q3jC9-h" }, "user_auth_method": "stored_cred", "redirectUri": "/some/path/page.html", "useCount": 42, ... // crProofSection. "crProofSection": { "uid": { "raw2": "qi:A:H:2:xxxxxxxx", // The QIF UserId }, "uapCounter": 42, "aar": { // authenticatorAssertionResponse (optional) "adf": "WebAuthN 1.0", // authenticatorData_format "cda": "xxx", // clientDataJSON. Serialized JSON. "ada": "xxx", // authenticatorData. base64url encoded. "uha": "xxx" // userHandle. base64url encoded. }, "cpl": [ { "cid_p": "cd2", "typ_p": "pubkey", "fmt_p": "TBD-CPF", // "format": "TBD-CPF" (not necessary. The default is "TBD-CPF".) "val_p": "mmmm" // base64url encoded JWT or signature. } ] }, ... }

RML Request: Property "payloadData.prs.uapCounter" (longName: "uapCounter")

Type integer.

The number of times the LoginManager has been used to create a user authentication proof. (i.e. a proof of identity)

RML Request: Property "payloadData.prs.cpl" (longName: "credentialProofList")

Type Array().

An array of credentialProof objects. This normally contains only proofs for credentials that are not public keys. The signatures property holds the proof for those credentials that are public keys. (If the RML Request is not represented by a JWS, then the "credentialProofList" may hold public key credentials as well.) Each "credential proof" object can be of a different type.

The credential proofs are given to the RP in order to authenticate the user. Having the RML Request contain multiple credential proof objects allows the RP to use Multi-Credential Authentication and Multi-factor authentication.

Example RML Request JSON object:
let payload_unencoded = { "requestFormat": "remereRequestFormat 0.1", "protocolId": "remere", "opIdReq": "login", // or "proveUserPresence" "sub": "remere_1/login", ... "useCount": 42, // crProofSection. "crProofSection": { "uid": { "raw2": "qi:A:H:2:xxxxxxxx", // The QIF UserId }, "uapCounter": 42, "aar": { // authenticatorAssertionResponse (optional) "adf": "WebAuthN 1.0", // authenticatorData_format "cda": "xxx", // clientDataJSON. Serialized JSON. "ada": "xxx", // authenticatorData. base64url encoded. "uha": "xxx" // userHandle. base64url encoded. }, "cpl": [ { "cid_p": "cd2", "typ_p": "pubkey", "fmt_p": "TBD-CPF", // "format": "TBD-CPF" (not necessary. The default is "TBD-CPF".) "val_p": "mmmm" // base64url encoded JWT or signature. } ] }, ... }

RML Request: Property "payloadData.prs.credentialProof" (longName: "credentialProof")

Type Object.

A single item in the credentialProofList array. Represents a Credential Proof for a credential that is not a publicKey.

Each credential proof object has an "id", a "type", a "format", and a "value". The names of these properties are "cid_p", "typ_p", "fmt_p" and "val_p". The value is a string or a JSON object of a type specified by the format value. Each credential MUST normally have a "cid_p" value, and the value MUST MATCH one of the "Credential Verification Rule id" values stored by the RP for the UserId. (There is only one exception. The "UserId" public key.)

There is one special case. One credential proof object is allowed to NOT refer to a CVR stored by the RP. In this case, the "cid_p" must be set to the special value "userIdPK". ("cid_p": "userIdPK") This marks the credential proof object as being the signature of the UserId private key. (This requires that the UserId be an encoded public key. See UserId.) Note that the UserId credential proof object is optional. An RP may or may not require it.

The RP stores "Credential Verification Rule" values for user authentication. The CVR values are given to the RP during (1) "registerUserLogin" and (2) "Set Active Credentials" operations. The RP may not require all CVR. Some stored CVR may be optional, or the RP may require only a subset. The exact configuration is up to the RP. Because some CVR may be optional, the RML Request may contain less credential proofs than the number of CVR at the RP. (The total number of credential proofs, in the cpl_list and the "signatures" array, may be less than the number of CVR stored by the RP.)

The credentialProof object also allows experiences that combine multiple authentication mechanisms such as fingerprint + PIN.

RML Request: Property "payloadData.prs.credentialProof.cid_p" (longName: "credentialProof.id")

Type string. Required. (A value must be specified.)

Specifies the id of a credentialProof in the "credentialProofList". (Used with rml.request.credRegSec.crList request property.)

The credentialProof."cid_p" value MUST MATCH the id (the credentialReg."cid_r") of one of the "Credential Verification Rule id" values stored by the RP for the UserId. (The "Credential Verification Rule" values were given to the RP during a previous "Set Active Credentials" operation.) (i.e. one of opId="registerUserLogin", "setActiveCredentials".) The RP stores the "cid_r", along with the CVR values. (The password or public key, etc.)

RML Request: Property "payloadData.prs.credentialProof.typ_p" (longName: "credentialProof.type")

Type string. May be Required?.

Specifies the type of a credentialProof in the "credentialProofList". (Used with credentialReg.ruleTypes service property.)

Valid values are "password", "pubkey", "federated".

RML Request: Property "payloadData.prs.credentialProof.val_p" (longName: "credentialProof.value")

Type string. Contains base64url encoded binary data. Required. (A value must be specified.)

Specifies the value of a credentialProof in the credentialProofList array. Usually this is a JWT value. The format of the item is specified by the neighboring credentialProof.format parameter. The default credentialProof.format is "TBD-CPF".

If the CVR is a public key, then the credentialProof.value is usually a JWT, with a signature created by the private key.

RML Request: Property "payloadData.prs.credentialProof.fmt_p" (longName: "credentialProof.format")

Type string. Default value: "TBD-CPF"

Specifies the format of a credentialProof.value in the credentialProofList array.

Values include "JWS-CS", "U2F", "sig". ("JWS-Compact Serialization"). (U2F is the standard of Universal 2nd Factor.)

If the value is "TBD-CPF", then the credentialProof."value" is a "TBD-CPF". If the value is "fmt_cert_42", then the credentialProof."value" is not used, and the "user_id_certificate_chain" is used instead. (That includes the "uic.ucv", "uic.format", and "uic.csvm" fields.)

The value the browser uses for credentialProof."format." should be one of those supported by the RP. (One of those in the "supported.credentialProof.formats" array.)

RML Request: Property "payloadData.req_factor2" (longName: "req_factor2")

Type string.

Holds the 2nd factor authentication. (During User Login creation, the list of public keys. During login, the 2nd JWT.) When creating an account, the RP might allow additional public keys to be set. (2nd factor authentication) The public keys can be sent to the RP in an additional HTTP parameter. The keys can be in JWK format. When logging into an RP, the second signature can be sent to the RP in this second parameter. (As a JWT.)

RML Request: Property "payloadData.cert.pubKeyList" (longName: "cert.pubKeyList")

Type Array(). Required if JWT is a UserId certificate.

Specifies the array of public keys in the UserId certificate.

RML Request: Property "payloadData.cert.pubKey.pkf" (longName: "cert.pubKey.format")

Type string. Required if JWT is a UserId certificate.

Specifies the format of a public key in the UserId certificate.

RML Request: Property "payloadData.prs.aar" (longName: "authenticatorAssertionResponse")

Type Object. Required when opId="registerUserLogin" or "setActiveCredentials".

A JSON object that specifies the exact bytes that the User Authenticator returned.

Example RML Request JSON object:
let payload_unencoded = { "requestFormat": "remereRequestFormat 0.1", "protocolId": "remere", "opIdReq": "setActiveCredentials", // or any opId "sub": "remere_1/setActiveCredentials", ... "crProofSection": { ... "uapCounter": 42, "aar": { // authenticatorAssertionResponse (optional) "adf": "WebAuthN 1.0", // authenticatorData_format "cda": "xxx", // clientDataJSON. Serialized JSON. "ada": "xxx", // authenticatorData. base64url encoded. "uha": "xxx" // userHandle. base64url encoded. }, "cpl": [ // credentialProofList { "cid_p": "cd2", "typ_p": "pubkey", "fmt_p": "TBD-CPF", // "format": "TBD-CPF" (not necessary. The default is "TBD-CPF".) "val_p": "mmmm" // base64url encoded JWT or signature. } // End of credential entry. ] } // End of crProofSection. }

RML Request: Property "payloadData.prs.adf" (longName: "authenticatorData_format")

Type string. Default value: "WebAuthN 1.0"

A string that specifies how the "authenticatorData" is encoded.

RML Request: Property "payloadData.prs.cda" (longName: "clientDataJSON")

Type string. Contains base64url encoded binary data. Requirement unknown.

Holds the result of JSON stringifying and UTF-8 encoding to bytes a CollectedClientData dictionary.

Example JSON
{"type":"webauthn.create", "challenge":"MTIzNDU2Nzg", "origin":"RP_example.com", "tokenBinding":{"id":"m38hcBq"}}
Don't have any real idea what this should be. Look at webAuthn for ideas.
dictionary CollectedClientData {
    required DOMString           type;
    required DOMString           challenge;
    required DOMString           origin;
    TokenBinding                 tokenBinding;
};

RML Request: Property "payloadData.prs.ada" (longName: "authenticatorData")

Type string. Contains base64url encoded binary data. Required if opId="registerUserLogin" or "setActiveCredentials".

Base64url encoded binary data. Holds the data from the User Authenticator.

Don't have any real idea what this should be. Look at webAuthn for ideas.
dictionary ParsedAuthenticatorData {
    ArrayBuffer (32 bytes) rpIdHash; // A hash of the rapId string.
    ArrayBuffer (1 bytes) flags;
    // MOVED signCount; (Number) Moved to useCount.
    // MOVED attestedCredentialData; (Object. optional) Moved to attestation_object.
    extensions; (Object. optional)
};

RML Request: Property "payloadData.prs.uha" (longName: "loginItem_userHandle")

Type string. Contains base64url encoded binary data. Requirement unknown.

Base64url encoded binary data. Holds an opaque user handle.

RML Request: Property "payloadData.credRegSec" (longName: "credRegSec")

Type Object. Required if opId="registerUserLogin" or "setActiveCredentials".

The Credential Registration Section. The collection of User Authentication Credentials to be stored by the RP. Used when the opId is either "registerUserLogin" or "setActiveCredentials".

It contains the list of Credential Verification Rule to be stored by the RP. (i.e. the "crList") (Each entry in the "removeList" contains two items, "cid_r" and "typ_r".) Each entry in the "crList" contains at least 4 items, "cid_r", "typ_r", "fmt_r" and "val_r". The data may be passwords or public keys, etc.

Valid properties are "cid_r" = "credential id", "typ_r" = "type", "fmt_r" = "format", "val_r" = "value"

Example RML Request JSON object:
let payload_unencoded = { "requestFormat": "remereRequestFormat 0.1", "protocolId": "remere", "opIdReq": "setActiveCredentials", // or "registerUserLogin" "sub": "remere_1/setActiveCredentials", ... // The "credRegSec" credentialRegSection "credRegSec": { "backup_credentials": [ { "cid_r": "cd-3", "typ_r": "pubkey", "fmt_r": "JWK", "alg_COSE": -7, "val_r": { ... } } ], "crList": [ { "cid_r": "cd10", "typ_r": "pubkey", "fmt_r": "JWK", "alg_COSE": -7, "val_r": { "kty":"ES", "kid":"cd10", ... }, "aof": "WebAuthN 1.0", // attestation_object_format "aod": "xxx" // attestation_object. base64url encoded. } ] } }

RML Request: Property "payloadData.user_login_creation_method" (longName: "user_login_creation_method")

Type Array(). Required if opId="registerUserLogin". Default value: "assigned_ulc"

It is a member of the credRegSec section.

The value is one of those from UserLogin Creation Methods. Such as claim_ms_ulc, assigned_ulc. The value has to be one of those supported by the RP. See biscProfile.userLoginCreation.createMethods.

RML Request: Property "payloadData.credRegSec.bkcr" (longName: "backup_credentials")

Type Array(). Required if opId="registerUserLogin" or "setActiveCredentials".

It is a member of the credRegSec section.

Provides a backup way to verify the user's identity. It exists in case the primary public key (in the UserId) is compromised. The public key is also used when verifying an "identity change request". When the user tries to change their identity. (The backup is also verified in case the user's primary public key has been compromised.) This backup key is given to the RP in the RML Request (that uses the "registerUserLogin" opId) when creating an account at the RP. The RP should permanently keep the key. It provides an additional way to verify the user. It is only used to verify the user for a few extreme cases.

When the user wants to set the UserId, he must provide an "identity change request" key. The RP must ensure that the change request is performed by the user. The request must be signed with a signature from the private key linked to the "backup_credentials".

RML Request: Property "payloadData.credRegSec.crList" (longName: "credRegSec.credentialRegList")

Type Array(). Required. (A value must be specified.)

An array of credentialRegistration objects. Each item represents a Credential Verification Rule to be stored by the RP. The list is expandable, to hold any number of credentials. See RML Request: Set Credential Verification Rules Detail.

It is a member of the credRegSec section.

RML Request: Property "payloadData.credRegSec.credReg" (longName: "credentialRegistration")

Type Object.

A single item in the crList array. (In the "credRegSec" section.) It represents a Credential Verification Rule export. (It contains the exported CVR.)

Example RML Request JSON object:
let payload_unencoded = { "requestFormat": "remereRequestFormat 0.1", "protocolId": "remere", "opIdReq": "setActiveCredentials", // or "registerUserLogin" "sub": "remere_1/setActiveCredentials", ... // The "credRegSec" credentialRegSection "credRegSec": { "backup_credentials": [ { "cid_r": "cd-3", "typ_r": "pubkey", "fmt_r": "JWK", "alg_COSE": -7, "val_r": { ... } } ], "crList": [ { "cid_r": "cd10", "typ_r": "pubkey", "fmt_r": "JWK", "alg_COSE": -7, "val_r": { "kty":"ES", "kid":"cd10", ... }, "aof": "WebAuthN 1.0", // attestation_object_format "aod": "xxx" // attestation_object. base64url encoded. } ] } }

RML Request: Property "payloadData.credRegSec.credReg.cid_r" (longName: "credentialRegistration.id")

Type string. Required. (A value must be specified.)

Specifies the id of a credentialReg in a crList. The identifier of a Credential Verification Rule being sent to the RP in the "credRegSec" section.

During login, each of the credentialProof."cid_p" values sent to the RP (by the user's Login Manager) MUST MATCH the id of one of the "Credential Verification Rules" stored by the RP for the user. (The credentialProof."cid_p" and signature."kid" must match a credentialReg."cid_r".)

During one of the "Set Active Credentials" commands, the user's "Login Manager" sends a list of credentialReg items (i.e. the "crList") to the RP. It can set the credentialReg."cid_r" values to whatever it likes, with the following restrictions. Each value must be unique within the scope of the crList. Limited to alpha-numeric, dash and underscore characters. (allows base64url encoding). Maximum of 16 characters. The first character must be "c".

This value is NOT supplied by the RP. It is supplied by the browser. It is used during one of the "Set Active Credentials" commands. (i.e. one of opId="registerUserLogin", "setActiveCredentials".) The RP stores the "cid_r" value, along with the actual CVR value. (The password or public key, etc.)

RML Request: Property "payloadData.credRegSec.credReg.typ_r" (longName: "credentialRegistration.type")

Type string. May be Required?.

The type of a Credential Verification Rule being sent to the RP in the "credRegSec" section. (Used with credentialReg.ruleTypes service property.)

Valid values are "password", "pubkey", "federated".

(Note: User Identifier Types define types of identifiers. Like a Credential Verification type is a type of CVR.)

RML Request: Property "payloadData.credRegSec.credReg.fmt_r" (longName: "credentialRegistration.format")

Type string. Default value: "JWK"

The format of a Credential Verification Rule being sent to the RP in the "credRegSec" section. (Used with credentialReg.ruleTypes service property.)

"pubkey" values are usually of format "JWK". "password" values are usually a sting. "federated" values are ??

RML Request: Property "payloadData.credRegSec.credReg.alg_COSE" (longName: "credentialRegistration.alg_COSE")

Type integer. Default value: -7 (i.e. JWA "ES256".)

The JWK algorithm of the public key Credential Verification Rule being sent to the RP in the CVR section.

Valid "JWA_alg" values are "ES256", "RS256", "RS384", "RS512". See RML Request.JWS.sig_alg and RML BiscProfile.JWA_alg.

RML Request: Property "payloadData.credRegSec.credReg.val_r" (longName: "credentialRegistration.value")

Type Object. May contain base64url encoded binary data. Required. (A value must be specified.)

The value of a Credential Verification Rule being sent to the RP in the "crList" section of the "credRegSec". (Used with credentialReg.ruleTypes service property.)

"pubkey" values are usually of format "JWK". "password" values are usually a sting. "federated" values are ??

RML Request: Property "payloadData.credRegSec.credReg.kid" (longName: "credentialRegistration.keyId")

Type string. Required. (A value must be specified.)

The id of the public-key Credential Verification Rule. // The Key ID.

Must be the same as the credentialRegistration.id ("cid_r").

RML Request: Property "payloadData.credRegSec.credReg.aod" (longName: "credentialRegistration.attestation_object")

Type string. Contains base64url encoded binary data. Required if opId="registerUserLogin" or "setActiveCredentials".

Base64url encoded binary data. Holds the attestation object from the LoginManager.

RML Request: Property "payloadData.credRegSec.credReg.aof" (longName: "credentialRegistration.attestation_object_format")

Type string. Default value: "WebAuthN 1.0"

Holds the attestation object format from the LoginManager.

RML Response Detail

The Remere Login Service Response (RML Response) is a JSON object created by the RP, and sent to the browser, in response to a RML Request that was sent to the Service Endpoint. It consists of a single JSON object. All RML Response objects are received and processed by the browser RML implementation first, before any scripts on the HTML page. This is so that the browser will always know the current Remere Login Status at the RP.

The response JSON object can contain a success code or error, etc. If the opId sent to the RP was "registerUserLogin" then the response from the RP will contain the new assignedUserId. (Or an error.)

The "error" property contains the error code, message, etc. A json response must only have EITHER a "result" OR an "error" property. A single response cannot have both.

Example RML Response JSON object:
{
  "protocolId": "remereResponse 1.0",
  "id": 1234567890,
  "request": {
    "opIdReq": "login",
    "bip": "remere_1"
  },
  "result": {
    "assignedUserId": "qi:A:A:1:Gib9_cYs",
    "sessionUserId": "q3jC9-h",
    "alt_user_id": "qi:A:A:1:Gib9_cYs"
  },
  "comment_22": "The 'result' and 'error' properties cannot both exist in a single response.",
  "error": {
    "code": 1492,
    "message": "Parse error",
    "message_2": "Method not found",
    "message_3": "Parse error",
    "message_4": "Invalid request",
    "data": { "some property":"some data" }
  }
}

RML Response - List of Properties

Special JSON properties used in the "service response" JSON object

The following properties can be used in the "service response" JSON object.

RML Response: Property "responseData.id" (longName: "id")

Type integer. Required. (A value must be specified.)

The id number of the request. The response must have the same id number as the corresponding request. The sender may use these numbers to identify the request and response.

RML Response: Property "responseData.protocolId" (longName: "protocolId")

Type string. Required. (A value must be specified.)

The protocol that the response is written in. The response must have a supported protocol.

RML Response: Property "responseData.result" (longName: "result")

Type Object. Required if an error did not occur.

Contains the result value from the RML Request. A response may only have ONE of "result" or "error". It may not have both.

Example RML Response JSON object:
{
  "protocolId": "remereResponse 1.0",
  "id": 1234567890,
  "request": {
    "opIdReq": "login",
    "bip": "remere_1"
  },
  "result": {
    /* "assignedUserId": "qi:A:A:1:Gib9_cYs", Not used with "login" */
    "sessionUserId": "q3jC9-h",
    "alt_user_id": "qi:A:A:1:Gib9_cYs"
  }
}

RML Response: Property "responseData.error" (longName: "error")

Type Object. Required if an error occurred.

Contains the error object resulting from the RML Request. A response may only have ONE of "result" or "error". It may not have both.

RML Response: Property "responseData.request.opIdReq" (longName: "requestOpId")

Type string. Required. (A value must be specified.)

Contains the opId value from the RML Request.

Example RML Response JSON object:
{
  "protocolId": "remereResponse 1.0",
  "id": 1234567890,
  "request": {
    "opIdReq": "registerUserLogin"
  },
  "result": {
    "assignedUserId": "qi:A:A:1:Gib9_cYs",
    "sessionUserId": "q3jC9-h",
    "alt_user_id": "qi:A:A:1:Gib9_cYs"
  }
}

RML Response: Property "responseData.result.assignedUserId" (longName: "assignedUserId")

Type string. Required if opId="registerUserLogin", and not using a multi-site UserId.

Sent in response to the "registerUserLogin" and "setUserId" opId.

When the opId is "registerUserLogin", the browser should set the uid.timestamp_uid property. The RP will create a new assignedUserId and send it to the browser in an encrypted form. The browser should send it to the Login Manager, using LoginManager.updateUserLoginWithServiceResult() in svUlUpdate.updatedUserId. The Login Manager will decrypt the value and store it, associated with the login.

Example RML Response JSON object:
{
  "protocolId": "remereResponse 1.0",
  "id": 1234567890,
  "request": {
    "opIdReq": "registerUserLogin",
    "bip": "remere_1"
  },
  "result": {
    "assignedUserId": "qi:A:A:1:Gib9_cYs",
    "sessionUserId": "q3jC9-h",
    "alt_user_id": "qi:A:A:1:Gib9_cYs"
  }
}

RML Response: Property "responseData.result.sessionUserId" (longName: "sessionUserId")

Type string. Required. (A value must be specified.)

Sent by the RP in response to a "login" action. (i.e. The "login" and "registerUserLogin" opId)

The encrypted UserId and the UserId session key are extra features to protect User Privacy. They both hide the real UserId from the browser. So that the user can use any browser and the UserId for all RP websites will remain secret from the browser.

The sessionUserId is a temporary value the RP creates to "stand-in" for the real UserId.

The browser must remember the sessionUserId. It must send the sessionUserId as the UserId session key value when performing most actions. Example: opId "logout", "proveUserPresence", etc. If the browser is not logged into the RP website, then the browser must send to the RP an "encrypted UserId". Example: UserId using encryption method 1

RP User Authentication Process

The RP user authentication process (login process) has the following flow:

If the RP verification page receives an HTTP POST request, and the request does not contain the special HTTP parameter (Default name is "capis_request"), then the user's browser does not support the Capis specification. The browser simply followed the "href" attribute of the HTML anchor, like normal, and did not add any "_auth_" parameters. In this case, the RP should redirect the user to some other login method. It can also use the default fallback identity login path. See Appendix D - Browser does not support Capis HTML Attributes

Alternately, it may be easier for the RP verification page to detect a GET request, and redirect on that. But this can only be done if the RP is certain that all GET requests are errors (from older browsers) and all POST requests are correct. Check that the RP does not allow GET requests (in the Bisc Site Document), and check that the RP does not send form submissions to the same endpoint.

During the identity proof verification, the RP must check to see if it has a record for the given UserId. If it does have a record for the UserId, then the RP must retrieve all the Credential Verification Rule for the UserId, and the "Credential Verification Methods" for each CVR. Then use the methods to verify each Credential Verification Rule in the identity to the identity proof. If verification fails, then the RP generates and returns a verification error message. (Ex: "The provided identity proof is not valid. Please provide different proof in order to login.")

If RP does not recognize a UserId, then one of two (or more) error messages must be returned. In other words, if an account DOES NOT EXIST for the specified user id. To determine which error message to return, the token must still be validated. Only if the token is valid (and any UserId certificate is also valid), then the user has successfully unlocked the Locked Id. Then the user is who he claims to be, and has proven he owns the UserId. (The user trying to log in is therefore authorized to use the user id he claimed.) If the user is verified, then the return message will be the "unknown user" error message. (This should be "unregistered user". No account exists for this user.) The user should then be prompted to create an account, with the proven user id. (Ex: An account does not exist for that user. Click here to create an account.)

If the token is NOT valid, then the RP should send a generic authentication error message. This prevents unverified users being able to determine if an account exists for any un-owned UserId. The situation where the existence of an account connected to any user id can be queried by anyone, even if they do not own the user id.

Note that an RP SHOULD NOT automatically create an account for identities in response to a login RML Request. (When a user tries to login with an identity, the identity is VERIFIED, but the RP does not have an account for that identity.) Instead, confirmation from the user is required before User Login creation. (To prevent User Login creation due to user error. If the user accidentally selected the wrong identity to log in with, etc.) See User Login creation and rml.opId "registerUserLogin".

If the signature is not valid, then an error message is displayed to the user. Note that the login process does not necessarily require the server to communicate with any other website. (This is unlike Mozilla Persona, Open ID, Facebook Connect, etc.) Only if the "authentication method" is for a third party server (an identity provider, etc.) then communication must be done with a third party. Note that the login process does not send the server (the RP) a password. The server does not store or validate passwords. It stores a public key and validates a digital signature.

========

Capis Javascript implementation (and Remere Login)

The goal is that browsers will implement Remere Login natively. However, until that time, there is a javascript implementation.

  1. RP web pages must have the RemereLogin API library. (The code to be executed.)
  2. RP web pages that use rel="servicetrigger" HTML elements should include a script in the head. <script src="capis_library.js"></script>
  3. It hooks up all the Service Trigger HTML Elements to use the activateTrigger behavior. (It calls CapisControl.activateTrigger.)
    The Anchor HTML Element and button HTML Elements call the activateTrigger when they are clicked. The Form HTML Elements call activateTrigger when they are submitted.
  4. There must be a way for the library to access the user's RP credentials. The "User Logins" could be stored on the user's machine, or in the browser or at a particular website. (In cookies, in localStorage, etc. How to do this?
  5. OLD. There must be a way to obtain a "proof of identity". This may involve communicating with an external website. The user's IdP. There must be a standardized way of automatically communicating with the IdP.

Step 1. Attach CapisControl.activateTrigger as a click handler to all Anchor HTML Elements. Use CSS selector "a[rel=servicetrigger]" and "addEventListener" to add a click handler.

function CAPIS_init() {
  // let capisControl_api = navigator.id.capisControl_api;
  // let capisControl_api = window.capisControl;
  let triggerAnchorList = window.document.querySelectorAll("a[rel=servicetrigger]");
  let triggerInputList = window.document.querySelectorAll("input[rel=servicetrigger]");
  let triggerButtonList = window.document.querySelectorAll("button[rel=servicetrigger]");
  let triggerFormList = window.document.querySelectorAll("form[rel=servicetrigger]");
  let clickList = [];
  triggerAnchorList.forEach(function (item) {clickList.push(item);})
  triggerInputList.forEach(function (item) {clickList.push(item);})
  triggerButtonList.forEach(function (item) {clickList.push(item);})

  clickList.forEach((triggerEl)=> {
    triggerEl.addEventListener("click", function(evt){evt.preventDefault(); capisControl_api.activateTrigger(this, evt);});
  });
  triggerFormList.forEach((triggerEl)=> {
    triggerEl.addEventListener("submit", function(evt){evt.preventDefault(); capisControl_api.activateTrigger(this, evt);});
  });
}
window.addEventListener("load", CAPIS_init);

The browser needs to treat Anchor HTML Elements as if they had a standard capis javascript click handler.

Example Anchor:
<a href="remere://example.com/remereService?op=login" rel="servicetrigger" trigger-config='{ "op":"", "bip":"remere_1login", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }' onclick="function(evt){capisControl_api.activateTrigger(this, evt)}">Login</a>

RML Remote Usage. Calling the RemereLogin API functions from non-RP web pages

It can be beneficial for a browser to store direct links to an Bisc Site Document. Browsers are encouraged to store opId "login" links. This way, the user does not have to load the RP website in order to look for a "setActiveCredentials" link on the RP website. The "biscSiteDocUri" in the login link is generally the same destination as a "setActiveCredentials" link. (As part of its "password manager", the browser remembers all links where the user logged in via the "login" opId.) Therefore, the browser or password manager can display an option screen to the user, and it can contain generated links to RPs to change the user's public key at that RP.

<a href="..." rel="servicetrigger" trigger-config='{ "op":"login", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }'>Login</a>

Form Signing

An RP can request that a form be cryptographically signed by the user when it is submitted. This may help prove that the user made the submission, or agreed to the terms in the form, etc. An RP does this by setting the "triggerConfig.op" property to be "signData". (Note that the "triggerConfig.op" property referred to here is not the "action" attribute of the form. Instead, it is one of the Trigger Configuration inside the "servicegroup-config" attribute.)

Example Form:
<form action="some_uri" rel="servicetrigger" trigger-config='{ "op":"signData", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }'>

"Form-signing" can be used for:

Form snapshot

A signed form must contain much more data than a regular form submission. This data is contained in a "form snapshot". It is a JSON representation of the form.

How it works

The use of the "remere" protocol and "signData" opId (along with the rel="servicetrigger" attribute) will cause the CapisControl.activateTrigger(formElement, event) function to be executed instead of the regular browser behavior when the submit button is pressed. This new function does the same as the regular behavior, validates the form as usual, fires the same events, etc. but as a last step, it causes the CapisControl.invokeServiceAction("remere_1", "signData", callOptions) function to be executed, instead of submitting the form.

The RemereLogin.performServiceOp(biscProfileId, "signData", callOptions) function causes a "form signature" pop-up dialog to be displayed to the user. (Instead of submitting the form.) The pop-up dialog shows a pull-down menu for the user to select which certificate (which User Login) to use to sign the form. There is also an option to create or import a User Login. After the User Login is selected, the CapisControl.createFormSnapshot(formElement, UserId) function is called. And that creates a form signature and adds it as "proof" to the RML Request JSON object.

When the submit button is pressed, all regular javascript code runs (such as a validator, and event listeners). The validator, etc, may stop the form submission before the RemereLogin.performServiceOp(biscProfileId, "signData", callOptions) function is called.

More details:

The activateTrigger function gets the triggerConfig.op property. It then calls CapisControl.invokeServiceAction.

First, the activateTrigger function detects that the triggerHtmlElement is a form. Then it calls the regular "onsubmit" javascript code. (a validator, etc.) If the regular code returns a false or otherwise stops the form submission, then invokeServiceAction stops execution. Second, if the form is still to be submitted, then the invokeServiceAction function checks if the opId is "signData". If it is, then the form signing path is taken. Third, a dialog is presented to the user asking which User Login (and key) they want to use to sign the form. Fourth, the invokeServiceAction function creates a JWT, that has all the data in the form copied to the JWT payload section. Fifth, it signs the JWT with the user's private key, and adds the JWT to the RML Request JSON object, as an additional property.

An example HTML form:


What is your gender? : :
What kind of car do you want?

<form action="remere://example.com/remereService?op=signForm" rel="servicetrigger" trigger-config='{ "op":"signData", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/formConfirm.php"}] }'> <input type="text" name="firstname" placeholder="Enter your first name"><br/> <input type="text" name="lastname" placeholder="Enter your last name"><br/> What is your gender? <label for="i_male">Male</label>: <input type="radio" id="i_male" name="gender" value="male"> <label for="i_female">Female</label>: <input type="radio" id="i_female" name="gender" value="female"><br/> What kind of car do you want?<br/> <select multiple name="carmake"> <option value="volvo">Volvo</option> <option value="toyota">Toyota</option> <option value="ford">Ford</option> </select><br/> <input type="hidden" name="today_date" value="2018-01-12"> <input type="submit" value="Submit"> </form>
Example BiscProfile:
serviceItemStart{
  "id": "remere_1",
  "protocolSpec": "remere",
  "endpointBlock": {
    "id":"endpoint_1", "sUri":"/_remere/requestServiceOp.json", "supportedFormats": ["JWS"]
  },
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
  "userLoginCreation": {
    "userIdTypes": ["single_site_userId", "qi:A:H:9:ri"],
    "createMethods": ["assigned_ulc", "claim_ms_ulc"]
  },
  "credentialReg": {
    "passwordTypes": [{"name":"password_s1", "maxLength":14, "storageQuantity":"1"}],
    "publicKeyTypes": [{"name":"pubkey_s1", "JWA_alg":"ES256", "storageQuantity":"1"}]
  },
  "supported": {
    "userAuthScheme": {"methods":["stored_cred", "only_MSUID"]},
    "supported.uic.csvm": ["basic1", "basic2"]
  },
  "requirement_section": {}
}serviceItemEnd
The HTTP values:
firstname=Mickey
lastname=Mouse
gender=male
carmake=toyota,volvo
Example RML Request JSON object:
let payload_unencoded = { "requestFormat": "remereRequestFormat 0.1", "protocolId": "remere", "opIdReq": "signData", "sub": "remere_1/signData", "iat": 1503971280, // issuedAt timestamp "exp": 1533064012, // expiresAt timestamp "aud": "RP_example.com", // the audience "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK", // nonce value "cht": 1533064012, // challengeTimestamp "uid": { "rawForLogin": "qi:A:F1:1:ACMA_org:M4j-q", // The QIF UserId "usk": "q3jC9-h" }, "user_auth_method": "only_MSUID", "redirectUri": "/some/path/page.html", "useCount": 42,
// user_id_certificate_chain (Available when not using the "stored_cred" uauth_method.) "uic_chain": [ {"uic.format":"JWS", "uic.csvm":"YY", "ucv": { "payload":"82h7vb...", "signatures": [...] }} ],
// crProofSection. "crProofSection": { "uid": { "raw2": "qi:A:H:2:xxxxxxxx", // The QIF UserId }, "uapCounter": 42, "cpl": [ { "cid_p": "cd2", "typ_p": "pubkey", "fmt_p": "TBD-CPF", // "format": "TBD-CPF" (not necessary. The default is "TBD-CPF".) "val_p": "mmmm" // base64url encoded JWT or signature. } ] }, "form_details": { "iss": "qi:A:H:2:K8h3_TfXr6ZtLq7d1m8k", // The Backer doing the signing. formSnapshot: [ // The form contents. {"n":"firstname", "t":"text", "v":"Mickey"}, {"n":"lastname", "t":"text", "v":"Mouse"}, {"n":"gender", "t":"radio", "v":"male", "o":[{"l":"Male","v":"male","s":true},{"l":"Female","v":"female"}]}, {"n":"vehicle", "t":"checkbox", "v":[], "o":[{"l":"I have a bike","v":"Bike"},{"l":"I have a car","v":"Car"}]}, {"n":"carmake", "t":"select-multiple", "v":["toyota","volvo"], "o":[{"l":"Toyota","v":"toyota","s":true}, {"l":"Volvo","v":"volvo","s":true},{"l":"Audi","v":"audi"}]} ] }, /* "credRegSec" credentialRegSection. Not required for "signForm" opId. "credRegSec": { "backup_credentials": [ { "cid_r": "cd-3", "typ_r": "pubkey", "fmt_r": "JWK", "alg_COSE": -7, "val_r": { ... } } ], "crList": [] } */ }; let RML Request = { "JWS": { "payload": BASE64URL(UTF8(payload_unencoded)), "signatures": [{ "protected": "eyJhbGciOiJFUzI1NiJ9", // protected_header = {"alg":"ES256", "sct":192} "header": { "kid": "cd1", "kid2": "e9bc097a-ce51-4036-9562-d2ade882db0d" // "kid": "userIdPK" // "userIdPK" means the public key is in "uid". }, "signature": "DtEhU3ljbEg8L38VWAfUAqOyKAM6-Xx-F4Ga" }] } }

The "UserId certificate" JWT. header and claims: (uic_chain[0])

let payload_unencoded = { "sub2": "remere_1/certificate", "iss": "id_registrar.example.com", // The Backer "iat": 1503971280, "exp": 1533064012, "sub": "qi:A:F1:1:ACMA_org:M4j-q", // The QIF UserId. "uid": { "rawForLogin": "qi:A:F1:1:ACMA_org:M4j-q", // The QIF UserId. "usk": "q3jC9-h" }, "cert_pubKeyList": [ { "kty": "RSA", "kid": "f85762a7f52c8346", "alg": "RS256", "n" : "4b9e34...", "e" : "93bc32..." } ] } let jws_certificate = { "payload": BASE64URL(UTF8(payload_unencoded)), "signatures": [ { "protected": "eyJhbGciOiJSUzI1NiJ9", // protected_header = {"alg":"RS256", "sct":192} "header": { "alg": "RS256", "kid": "bf4a76332a6c8370f48", // "kid" is REQUIRED "csvm": "RDAC" // How to get the sig verification key from the issuer. // "csvm": "OIDCD" // Get the sig verification key from the issuer via "OIDCD", etc. // "csvm": "idr_keystore" // Get the sig verification key from an "Backer keystore". }, "signature": "DtEhU3ljbEg8L38VWAfUAqOyKAM6-Xx-F4Ga" }] }

The JWT MUST have an issue date, and an issuer string that contains the User Login. That is, the required fields include the "kid" value in the header, and both an "iat" and "iss" claim values. When validating the form, the issuer string is extracted, and used to look up the sig verification key set for that issuer. The "kid" specifies which key was used. (Note that the key used may not belong to the RP. The RP may need to retrieve the list of keys from an internet address.)

Form Snapshot

A form snapshot is a JSON representation of the form. The HTML form is converted into JSON, and most of the form fields and attributes are retained.

A form snapshot must contain much more data than a regular HTTP form submission. A form snapshot is about proving what data a user provided, and thus it is necessary to document the questions on the form, and what options were available for each of them. An HTTP form submission is not sufficient, as it only contains the values that were sent to the server. It doesn't contain the labels, options or even the field types (text, radio button, etc). Furthermore, there is no distinction between the values the user provided, and values from "hidden" input elements. Without this distinction, it would be possible for form authors to add hidden form fields and make it seem that a user agreed to something they were not aware of.

A form snapshot converts each input element in a form into a JSON object. Each converted input element will include the name, type, value, label, and the options available. The options will include the label, value and a marker for if the option is selected. Each option can have its own label.

See CapisControl.createFormSnapshot(formElement).

Capis API Function: CapisControl.createFormSnapshot(formElement)

Return type: Object.

Converts an HTML form into a JSON object. Retains most of the form fields, attributes, labels and options.

Function info: (parameter list, return value, etc.)
  • @param {Object} formElement; The HTML form element to extract the data from.
  • @return {Object} formSnapshot; The form snapshot. A JSON object.
  • @property {string} formSnapshot.id; The id of the form.
  • @property {integer} formSnapshot.creationDate; The date the snapshot was created. Unix timestamp in milliseconds.
  • @property {Array} formSnapshot.elementList; The list of "input elements" in the form.
  • @object_example item = { n: name, t: type, v: value, l: label, o: optionList, so: selectedOptionList }
  • The array items may contain name "n", type "t", value "v", label "l", optionList "o".

This function goes through the form, and converts each input element into a JSON object. Each converted input element will include the name, type, value, label, and the options available. The options will include the label, value and a marker for if the option is selected. Each option can have its own label. (The options are limited to 50 for select fields).

A form snapshot is necessary because the regular HTTP form submission does not retain the questions on the form. It doesn't contain the labels, options or even the field types (text, radio button, etc). Without that data, it is hard to verify what questions the user was answering. See Form Snapshot.

See Form signing.

Details:

The snapshot:

The form snapshot contains a lot more data than a standard form submission. It contains:
Example HTML form:
<form action="remere://example.com/remereService?op=signForm" rel="servicetrigger" trigger-config='{ "op":"signData", "bip":"remere_1", "onSuccess":[{"redirectUri":"/some/path/formConfirm.php"}] }'> <input type="text" name="firstname" placeholder="Enter your first name"><br/> <input type="text" name="lastname" placeholder="Enter your last name"><br/> <input type="text" id="i_nickname" name="nickname"><label for="i_nickname">What you like to be called.</label><br/> What is your gender? <label for="i_male">Male</label>: <input type="radio" id="i_male" name="gender" value="male"> <label for="i_female">Female</label>: <input type="radio" id="i_female" name="gender" value="female"><br/> What kind of vehicles do you have?<br/> <input type="checkbox" id="i_bike" name="vehicle" value="Bike" checked> <label for="i_bike">I have a bike</label><br/> <input type="checkbox" id="i_car" name="vehicle" value="Car" checked> <label for="i_car">I have a car</label><br/> <input type="checkbox" id="i_boat" name="vehicle" value="Boat"> <label for="i_boat">I have a boat</label><br/> <select multiple name="carmake"> <option value="volvo">Volvo</option> <option value="toyota">Toyota</option> <option value="ford">Ford</option> </select><br/> <select name="favoriteFruit"> <option value="apple">Apple</option> <option value="orange">Orange</option> <option value="pear">Pear</option> </select><br/> <input type="hidden" name="today_date" value="2018-01-12"> <input type="submit" value="Submit"> </form>
// createFormSnapshot example output.
formSnapshot: {
  "creationDate": 1555876543210,
  "elementList": [ // The form contents.
    {"n":"firstname", "t":"text", "v":"Mickey"},
    {"n":"lastname", "t":"text", "v":"Mouse"},
    {"n":"nickname", "t":"text", "v":"Big Ears", "l":"What you like to be called."},
    {"n":"gender", "t":"radio", "v":"male", "o":[{"l":"Male","v":"male","s":true},{"l":"Female","v":"female"}]},
    {"n":"vehicle", "t":"checkbox", "v":[],
        "o":[{"l":"I have a bike","v":"Bike"},{"l":"I have a car","v":"Car"},{"l":"I have a boat","v":"Boat"}]},
    {"n":"carmake", "t":"select-multiple", "v":["toyota","volvo"],
      "o":[{"l":"Toyota","v":"toyota","s":true}, {"l":"Volvo","v":"volvo","s":true}, {"l":"Ford","v":"ford"}]},
    {"n":"favoriteFruit", "t":"select-one", "v":"Apple",
      "o":[{"l":"Apple","v":"apple","s":true}, {"l":"Orange","v":"orange"}, {"l":"Pear","v":"pear"}]},
    {"n":"today_date", "t":"hidden", "v":"2018-01-12"},
  ]
}

In JSON, names and values cannot contain double quotes. So, both the names and values of the form items will need to have any double quotes encoded. (Should use json encoding, backspace, '\"', not html "&quot;")

Example javascript code for creating a Javascript object with all the form names and values.
// example implementation
/**
 * Extracts structure and user data from a form as an array of data objects.
 * Objects include name, value, type, option_list and option labels.
 * Important: checkboxes and radio buttons with the same name are combined.
 * Each individual radio button or checkbox is one option for the shared name.
 * Single select items (radio, select-one) will have a value of null if nothing is selected.
 * Multi-select items will have a value of the empty array if nothing is selected.
 * Also, the array of selected options ("so"), is an attempt to minimize the length of the option list.
 * @return {Object} formSnapshot; The form snapshot. A JSON object.
 * @property {string} formSnapshot.id; The id of the form.
 * @property {integer} formSnapshot.creationDate; The date the snapshot was created. Unix timestamp in milliseconds.
 * @property {Array} formSnapshot.elementList; The list of "input elements" in the form.
 * @object_example item = { n: name, t: type, v: value, l: label, o: optionList, so: selectedOptionList }
 * The array items may contain name "n", type "t", value "v", label "l", optionList "o".
 */
function createFormSnapshot(theForm) {
  if (theForm === undefined || theForm.nodeName !== "FORM") {
    throw new Error("Cannot create a form snapshot. No form provided.");
  }
  let formData = {}; // The data to be signed.
  formData.creationDate = new Date().getTime();
  let itemList = []; // The list of elements
  let nameMap = new Map();
  // let data_names = {};
  let elem;
  let formLen = theForm.elements.length;
  for(let i = 0; i < formLen; i++) {
    elem = theForm.elements[i];
    let item;
    let addToList = true;
    let prevItem = nameMap.get(elem.name);
    if (prevItem !== undefined) {
      if (elem.type == "radio" || elem.type == "checkbox") {
        // Multiple "radio" and "checkbox" items with the same name are allowed.
        addToList = false;
      } else {
        throw new Error("Invalid form. Has two fields of type=" + elem.type + " with the same name. name=" + elem.name);
      }
    } else {
      item = {};
      item.n = elem.name;
      item.t = elem.type;
      if (elem.type == "checkbox" || elem.type == "select-multiple") {
        item.v = [];
      } else {
        // item.v = null;
      }
      // nameMap.set(elem.name, item);
    }
    switch (elem.type) {
      case "hidden":
      {
        item.v = elem.value;
        // item.l = getLabelFor(theForm, elem.id);
      }
        break;
      // These types do not have a "name". submit, reset, button, image
      case "submit":
      case "reset":
      case "button":
      case "image":
        addToList = false;
        break;
      // Do not include passwords in the itemList.
      case "password":
      // case "file":
      {
        // item.v = null; // elem.value
        item.l = getLabelFor(theForm, elem.id);
        // addToList = false;
      }
        break;
      case "select-multiple":
      {
        let options = [];
        item.v = [];
        item.l = getLabelFor(theForm, elem.id);
        item.o = options;
        item.so = []; // Array of only the selected options.
        let so = item.so;
        for(let k = 0; k < elem.length; k++) {
          let op = {};
          op.l = elem.options[k].text;
          op.v = elem.options[k].value;
          options.push(op);
          if(elem.options[k].selected) {
            op.s = true; // option is selected.
            item.v.push(elem.options[k].value);
            so.push(op);
          }
        }
      }
        break;
      case "select-one":
      {
        let options = [];
        item.v = null;
        if (elem.selectedIndex != -1) { item.v = elem.options[elem.selectedIndex].value; }
        item.l = getLabelFor(theForm, elem.id);
        item.o = options;
        for(let k = 0; k < elem.length; k++) {
          let op = {};
          op.l = elem.options[k].text;
          op.v = elem.options[k].value;
          options.push(op);
          if (elem.options[k].selected) {
            op.s = true; // option is selected.
          }
        }
      }
        break;
      case "radio":
      {
        if (prevItem !== undefined) {
          item = prevItem;
        } else {
          item.v = null;
          item.o = []; // options
        }
        let options = item.o;
        let op = {};
        op.l = getLabelFor(theForm, elem.id);
        op.v = elem.value;
        options.push(op);
        if(elem.checked) {
          op.s = true; // option is selected.
          item.v = elem.value;
        }
      }
        break;
      case "checkbox":
      {
        if (prevItem !== undefined) {
          item = prevItem;
        } else {
          item.v = [];
          item.o = []; // options
          item.so = []; // Array of only the selected options.
        }
        let options = item.o;
        let op = {};
        op.l = getLabelFor(theForm, elem.id);
        op.v = elem.value;
        options.push(op);
        if(elem.checked) {
          op.s = true; // option is selected.
          item.v.push(elem.value);
          let so = item.so;
          so.push(op);
        }
      }
        break;
      // text, textarea, etc.
      default:
      {
        item.v = elem.value
        item.l = getLabelFor(theForm, elem.id);
      }
    }
    if (addToList) {
      itemList.push(item);
    }
    if (prevItem === undefined) {
      nameMap.set(elem.name, item);
    }
  }
  formData.elementList = itemList;
  return formData;
}
function getLabelFor(theForm, theId) {
  let label = "";
  let html_labels = theForm.querySelectorAll("label[for='" + theId + "']");
  for( let index=0; index < html_labels.length; index++ ) {
    // Probably need some check in here to ensure the label is visible.
    label += html_labels[index].textContent;
  }
  return label;
}
========

API Data Types

API Data Types Type: JSON string ("json_string") // A quoted string.

API Data Types Type: integer // Data MUST be an integer. (Not a float)

API Data Types Type: number // Data may be an integer or a float.

API Data Types Type: boolean

API Data Types Type: JSON Object ("json_object")

API Data Types Type: JSON Array ("json_array")

API Data Types Type: Slightly modified JSON ("mofh-JSON")

Type Slightly modified JSON
A slightly modified JSON format for being used inside an HTML attribute.

Used by HTML ATTRIBUTE ServiceGroup HTML Element "servicegroup-config" and Service Trigger HTML Element "trigger-config"

The difference from standard JSON is that it allows property names and string values to be enclosed with the "caret" character in addition to the double quote character. This format was added for convenience, because HTML attribute values can be double quoted, and that interferes with standard JSON string quoting. Internally, all caret characters in the attribute value are simply converted into double quote characters. In order to include a caret character, use the percent encoding "%caret;".)

In order to include a double quote mark in a JSON property name or string value, prefix it with a backslash. HTML entity encoding can also be used. Single Quote (') = (&apos;) Double Quote (") = (&quot;) Less than (<) = (&lt;) Greater than (>) = (&gt;)

Example Anchor:
<a href="remere://example.com/remereService?op=login" rel="servicetrigger" trigger-config='{ "op":"login", "bip":"remere_1", "test":"Eat at Lefty&apos;s in \"Smallville\"!", "onSuccess":[{"redirectUri": "/some/path/page.html"}] }'>Login</a>
Example Anchor using caret quote characters:
<a href="remere://example.com/remereService?op=login" rel="servicetrigger" trigger-config="{ ^op^: ^login^, ^bip^:^remere_1^, ^test^:^Eat at Lefty's in \^Smallville\^!^, ^onSuccess^:{^redirectUri^: ^/some/path/page.html^} }">Login</a>

API Library

Optional Javascript Library

A set of API functions for the browser to call in order to perform the behavior required of "auth" elements. These API functions are exposed as Javascript functions.

Example Bisc Site Document:
// Example javascript using a BiscProfile
let siteInfo = {
  "documentId": "4857a8d28f6c",
  "rpInfo": {
    "displayName": "ACME Corporation",
    "smallIcon": "/images/logo.png"
  },
  "serviceProfileList": [serviceItemStart{
    "id": "remere_1",
    "protocolSpec": "remere",
    "endpointBlock": {
      "id":"endpoint_1", "sUri":"/_remere/requestServiceOp.json", "supportedFormats": ["JWS"]
    },
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
    "userLoginCreation": {
      "userIdTypes": ["single_site_userId", "qi:A:H:9:ri"]
      // "createMethods": ["assigned_ulc", "claim_ms_ulc"]
    },
    "credentialReg": {
      "passwordTypes": [{"name":"password_s1", "maxLength":14, "storageQuantity":"1"}],
      "publicKeyTypes": [{"name":"pubkey_s1", "JWA_alg":"ES256", "storageQuantity":"1"}]
    },
    "supported": {
      "userAuthScheme": {"methods":["stored_cred", "only_MSUID"]},
      "supported.uic.csvm": ["basic1", "basic2"]
    }
  }serviceItemEnd]
};

The CapisControl.activateTrigger(triggerHtmlElement, ui_event) is the top level function. It accepts a Service Trigger HTML Element. Internally, they call CapisControl.invokeServiceAction(biscProfileId, opId, callOptions).

Note that "many of" these functions have a "context" of the current browser tab.

All the "biscSiteDocUri" values must start with a slash. (Also "smallIcon" values too.) They CANNOT contain a domain name. It's a security risk. This is because the functions can be called directly from javascript running in a browser tab. A tab should not be able to log into or out of a different site. (Cross site scripting attack.)

API Table Of Contents

API Class: CapisControl

Global API Object: capisControl_api

API Class: ProtocolHandler

API Class: RemereLogin

Global API Object: remereLogin_api

Level 1 Javascript API functions.

API Class: LoginManager

The LoginManager functions are called from RemereDirector functions.
The LoginManager functions that accept the "rpClientData" argument are Authenticator functions. (And collectUserLogins is also a required Authenticator function.) The purpose of rpClientData is to be included in a signature, created by the Authenticator, and returned to the RP. This lets the RP know that the Authenticator received the correct data. For example, The RP can choose to use a parent domainName. The RP needs proof that the Authenticator knew that when it created the signature. The rpClientData is used when a response from the Authenticator is delivered to the RP. The rpClientData is used (1) when creating credential signatures, and (2) When CHANGING active credentials (3) when creating a User Login. (Note: creating credential sources does NOT require an rpClientData.) The credential signatures and attestation signature are signed over the rpClientData hash.

API Class: RemereDirector

Low level functions, internal to the browser implementation. These are suggestions only. They are not public, and could be implemented completely differently. The first group is called by the RemereLogin functions.
======== Private Key APIs. ========
  • authsecure.generateKeyPair() -- Generates a key pair. Stores private key securely. -- Also generates an "id" for the key pair. Records the keys internally. Returns only the public key.
  • authsecure.createIdentitySignature(); -- Creates a JWT signed by the userId private key.
  • LoginManager.createUserLoginProofForRp(header, payload, privateKey);

CapisControl.pRemereLogin_api

The pRemereLogin_api is a pointer internal to the CapisControl object. It points to a remereLogin_api.

The definition of the const variables.

const remere_login_protocol_id = "remere";

Capis API Function: CapisControl.activateTrigger(triggerHtmlElement, event)

Return type: void. (nothing)

This function is called as a "click handler" function on anchors, and buttons. (Etc.)

Called by the browser when the user clicks a Service Trigger HTML Element. (Such as a Anchor HTML Element with rel="servicetrigger" attribute.)

Function info: (parameter list, return value, etc.)
  • @param {Object} triggerHtmlElement; The trigger HTML element that was activated.
  • @param {Object} event; The event that occurred. (a click event, submit event, etc.)
  • @return {Promise(Object)} serviceCallPromise; The id (or promise) of the service call.
Internal steps:

This handler registers an internal function as a failure callback to receive error and failure notifications from the CapisControl.invokeServiceAction function. If "CapisControl.invokeServiceAction" encounters an error, or cannot complete correctly for any reason, then the failure callback is called. That will return control to this handler. It may then decide to display an error message to the user (as a popup or dialog box, etc.), or pass the error on to the browser.

For example: if a login was started, but the user cancels it. or the user supplied the wrong password to the IDP, etc. etc.

Extracts all the authentication configuration options from the anchor element (inside the "trigger-config" attribute). For example, this includes: "triggerConfig.op", "challenge", etc.

Example Service Trigger HTML Element HTML Element:
// arguments
<link href="/_capis/capisBiscSiteDoc.json" rel="servicegroup"
 servicegroup-config='{ "challengeTime": 1599876543210,
  "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK",
  "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"},
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
  "mediation": "required"}] }'/>
...
<a href="remere://example.com/remereService?op=login" rel="servicetrigger"
 trigger-config='{ "op":"", "bip":"remere_1login", "onSuccess":[{"redirectUri":"/some/path/page.html"}] }'>Login</a>
Example implementation code.
// example implementation
function CCI_activateTrigger(triggerHtmlElement, event) {
  let promise = Promise.resolve("yyy")
  .then( yyy_response => {
    let extractionInfo = CCI_extractTriggerAttributeFromHtmlElement(triggerHtmlElement);
    let triggerContents = extractionInfo.jsonContents;
    // Include the triggerHtmlElement in a private property inside the triggerContents.
    // Note, capisInternalDataPropName is reserved. If the page has defined its own version, overwrite it.
    triggerContents[capisInternalDataPropName] = extractionInfo.srcMetadata;
    let opId = triggerContents.op;
    let biscProfileId = triggerContents.bip;
    if (opId === undefined) {
      throw new Error("Invalid HTML trigger. Missing the 'op' property in the Trigger Config value. (In the trigger HTML element.)");
    }
    if (biscProfileId === undefined) {
      throw new Error("Invalid HTML trigger. Missing the 'bip' property in the Trigger Config value. (In the trigger HTML element.)");
    }
    return capisControl_api.invokeServiceAction(biscProfileId, opId, triggerContents)
  }).then( action_response => {
    // console.log("CCI.activateTrigger resolved action_response. biscProfileId=" + action_response.biscProfileId + " callId=" + action_response.callId);
    return action_response;
  }).catch(error => {
    // console.log("Error in CapisControl.activateTrigger. " + error.message);
    let genErrorMsg = "Could not activate trigger.";
    let traceMsg = "CCI_activateTrigger(htmlElement=" + element_title + ")";
    CapisError_pushStackFrame(error, {tm:traceMsg, genMsg:genErrorMsg});
    error.message = "Error in Capis. " + error.message;
    CCI_popup(error); // Display a popup dialog with the error.
    return Promise.reject(error);
  });
}

Capis API Function: CapisControl.invokeServiceAction(biscProfileId, opId, callOptions)

Return type: Promise(Object).

Will perform the service action specified by the biscProfileId and the opId. Will find the protocolId for the service, then call that Protocol Handler. Give the handler the action to perform (the opId) and any arguments (the callOptions). (The arguments are often specified in a service trigger. The triggerConfig.op parameter, etc.)

Function info: (parameter list, return value, etc.)
  • @param {string} biscProfileId; The service to be invoked. Example: "remere_1"
  • @param {string} opId; The service operation to be performed. Example: "login"
  • @param {Object} callOptions; The configuration options for the RP service call.
  • @return {Promise(Object)} serviceCallPromise; The id (or promise) of the service call.
Internal steps:
  • Calls the requested service operation. (biscProfileId:"remere_1", opId:"login" or "logout") etc.
  • Returns the Promise created from calling the opId function.

This function returns a Promise. If for any reason this function cannot complete correctly, then the promise's failure callback will be executed. For example, if the user cancels the login attempt, or the user supplied the wrong password.

The promise's failure callback is NOT called if the function completes correctly. For example, if the POST is sent to the website, the failure callback will never be called. Even if the website rejects the login or has some other error. In this example, if the website has an error, it can redirect the browser to a web page detailing the error.

Example implementation code.
// example implementation
function CCI_invokeServiceAction(biscProfileId, opId, callOptions) {
  if (biscProfileId === undefined) {
    throw new Error("Cannot invoke protocol action. Missing 'biscProfileId' argument.");
  }
  if (opId === undefined) {
    throw new Error("Cannot invoke protocol action. Missing 'opId' argument.");
  }
  if (callOptions === undefined) { callOptions = {}; }
  // Make sure that CapisControl has read the pageConfig before calling the protocolHandler.
  return this.ensurePageConfig()
  .then( pageConfig => {
    if (biscProfileId.length < 2) {
      throw new Error("Invalid 'biscProfileId' =" + biscProfileId + " in HTML trigger. It must be at least 2 characters.");
    }
    if (opId.length < 2) {
      throw new Error("Invalid 'opId' =" + opId + " in HTML trigger. It must be at least 2 characters.");
    }
    let biscProfile = CCI_getBiscProfileFromPageConfig(biscProfileId, pageConfig);
    let protocolId = biscProfile.pContents.protocolSpec;
    let protocolHandler = CCI_getProtocolHandler(protocolId);
    let opPromise;
    if (protocolHandler !== undefined) {
      opPromise = protocolHandler.performServiceOp(biscProfileId, opId, callOptions);
    } else {
      throw new Error("Cannot invoke protocol action. Unregistered protocolId=" + protocolId + ", opId=" + opId);
    }
    return opPromise;
  }).then( prHandlerResponse => {
    se9_debug.log("CapisControl.invokeServiceAction: resolved. response=" + JSON.stringify(prHandlerResponse));
    // window.location.reload();
    let action_response = prHandlerResponse;
    return action_response;
  }).catch( error => {
    let msg = "Error in CapisControl.invokeServiceAction. error=" + error;
    console.log(msg);
    alert(msg); // alert("Error in CapisControl.invokeServiceAction. error=" + error.message);
    return Promise.reject(error);
  });
}

Capis API Function: CapisControl.getProtocolHandler(protocolId)

Return type: Promise(Object).

Will find and return the Protocol Handler for the specified Service Protocol Id.

Function info: (parameter list, return value, etc.)
  • @param {string} serviceProtocolId; The Service Protocol Id. Example: "remere"
  • @return {Object} protocolHandler; The Service Protocol Handler.

Capis API Function: CapisControl.extractTriggerAttributeFromHtmlElement(htmlElement, otherOptions)

Return type: Object

Extracts the "Configuration Info" from the HTML element. Reads the "config" attribute of the htmlElement, and converts it into a JSON object. The extractionInfo "jsonContents" property contains the data as a JSON object. The attribute is usually the "trigger-config" attribute.

Function info: (parameter list, return value, etc.)
  • @param {Object} htmlElement; The HTML element to extract from.
  • @param {Object} otherOptions; Other options. (Usually undefined.)
  • @return {Object} extractionInfo; The extraction result. Includes srcMetadata, etc.
  • @property {Object} extractionInfo.jsonContents; The attribute contents, as a JSON object. (parsed from JSON.)
  • @property {Object} extractionInfo.srcMetadata; Ancillary information. (Includes sourceHtmlElement, etc.)
Example Service Trigger HTML Element HTML Element:
<link href="/_capis/capisBiscSiteDoc.json" type="application/json" rel="servicegroup" servicegroup-config='{ "challengeTime": 1599876543210, "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK", "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"}, "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"}, "mediation": "required"}], "biscSiteDocUri": "https://RP_example.com/some/path/capisBiscSiteDoc.json" }'/> ... <a href="remere://example.com/remereService?op=registerUserLogin" rel="servicetrigger" trigger-config='{ "op":"registerUserLogin", "bip":"remere_1", "ulCreationCfg": {"userIdGenMethods": ["st1", "ct1"], "rawUserId": "qi:A:A:1:Gib9_cYs"}, "onSuccess":[{"redirectUri": "/some/path/page.html"}] }'>Sign Up</a> ... <form action="remere://example.com/remereService?op=login" rel="servicetrigger" trigger-config='{ "op":"login", "bip":"remere_1", "onSuccess":[{"redirectUri": "/some/path/page.html"}] }'> <input type="text" name="username" value="" placeholder="Enter a username" /> </form>
// Example javascript using a "service trigger"
let attrInfo_1 = capisControl_api.extractTriggerAttributeFromHtmlElement(htmlElement);
// example output
let attrInfo_1 = {
  "jsonContents": {
    "op":"registerUserLogin", "bip":"remere_1",
    "ulCreationCfg": {"userIdGenMethods": ["st1", "ct1"], "rawUserId": "qi:A:A:1:Gib9_cYs"},
    "onSuccess":[{"redirectUri": "/some/path/page.html"}]
  },
  "srcMetadata": {
    "sourceHtmlElement": htmlElement // Reference to the original htmlElement
  }
};
let attrInfo_2 = {
  "jsonContents": {
    "challengeTime": 1599876543210,
    "challenge": "8fK2BzE9MQ2phX6RLu1VzD4F0wgWJ3In8dKNeGo9YdK",
    "serviceProfileList": [{"id":"remere_1", "protocolSpec": "remere", "endpointBlock": {"sUri":"/_remere/requestServiceOp.json"},
  "protocolFallback": {"uriPattern":"https://$domainName/_capisFallback/$protocolId/$opId.html"},
    "mediation": "required"}]
  },
  "srcMetadata": {
    "sourceHtmlElement": biscGroupHtmlElement // Reference to the original htmlElement
  }
};
Example implementation code.
// example implementation
/**
 * Reads the ConfigurationInfo from the triggerHtmlElement.
 * (1) Extracts the "trigger-config" attribute, converts it into a JSON object. (jsonContents)
 * (2) Extracts the element nodeName, and a pointer to the htmlElement. (extractionInfo.srcMetadata)
 * (3) If trigger is a form, then extracts the specified fields. (Inserts into extractionInfo.jsonContents)
 * @param {Object} htmlElement; The HTML element to extract from. (Has "trigger-config" attribute.)
 * @return {Object} extractionInfo; The extraction result. Includes srcMetadata, etc.
 * @property {Object} extractionInfo.jsonContents; The attribute contents, as a JSON object. (parsed from JSON.)
 * @property {string} jsonContents.challenge; The challenge value.
 * @property {string} jsonContents.op; The requested operation. Ex: "login"
 * @property {string} jsonContents.bip; The biscProfileId. Example: "remere_1"
 * @property {Object} extractionInfo.srcMetadata; Ancillary information. (Includes sourceHtmlElement, etc.)
 */
function CCI_extractTriggerAttributeFromHtmlElement(htmlElement, otherOptions) {
  if (htmlElement === undefined) {
    return undefined;
  }
  let attributeName = "trigger-config"; // han_trigger_config
  if (otherOptions.isSG) attributeName = "servicegroup-config";
  var extractionInfo = {};
  var attributeSet = {};
  var metaData = {};
  metaData.sourceHtmlElement = htmlElement;
  metaData.attributeSet = attributeSet;
  metaData.nodeName = htmlElement.nodeName;
  // let attrInfo = CCI_extractAttrInfoFromHtmlElementAttribute(htmlElement, attributeName);
  let configText;
  if (htmlElement.hasAttribute(attributeName)) {
    configText = htmlElement.getAttribute(attributeName);
  } else if (htmlElement.hasAttribute("data-" + attributeName)) {
    configText = htmlElement.getAttribute("data-" + attributeName);
  } else {
    // Nothing to extract? Error?
    configText = "";
  }
  // Note: Use a special function to convert configText into JSON. (Can have caret quoted strings.)
  let jsonContents = CCI_parseModJSONTextIntoJSON(configText);
  // Special case for "Anchor HTML Element". Extract the "href" attribute.
  if (htmlElement.nodeName == "A") {
    if (htmlElement.hasAttribute("href")) {
      attributeSet["href"] = htmlElement.getAttribute("href");
    }
  }
  // Special case for "Button HTML Element".
  if (htmlElement.nodeName == "BUTTON") {
    if (htmlElement.hasAttribute("href")) {
      attributeSet["href"] = htmlElement.getAttribute("href");
    }
  }
  // Special case for "Form HTML Element". Extract the form's "action" attribute.
  if (htmlElement.nodeName == "FORM") {
    if (htmlElement.hasAttribute("action")) {
      attributeSet["action"] = htmlElement.getAttribute("action");
    }
  }
  // Special case for "ServiceGroup HTML Element". Extract the "href" attribute.
  if (htmlElement.nodeName == "LINK") {
    if (htmlElement.hasAttribute("href")) {
      attributeSet["href"] = htmlElement.getAttribute("href");
    }
  }
  extractionInfo.jsonContents = jsonContents;
  extractionInfo.srcMetadata = metaData;
  let extractedData;
  if (htmlElement.nodeName == "FORM") {
    let fieldIdList = jsonContents["setTriggerPropByFieldName"];
    if (fieldIdList === undefined) {
	} else if (Array.isArray(fieldIdList) == false) {
      throw new Error("extractionInfo.setTriggerPropByFieldName must be an array. (Or undefined)");
	} else {
      extractedData = CCI_extractFieldDataFromForm(htmlElement, fieldIdList);
    }
    // OVERWRITE any existing jsonData values with the same name.
    Object.assign(jsonContents, extractedData);
  }
  return extractionInfo;
}

Capis API Function: CapisControl.ensurePageConfig()

Return type: Promise(Object) page_config_repository.

Ensures the CapisControl has been initialized, then returns the PageConfig options for the current page. The "pageConfig" is primarily a list of BiscGroup.

Calling this function will run the CapisControl initialization, if it has not already been performed. The initialization loads the information for the page. This includes the BiscGroup settings, Capis document, sapId, etc. For example, it extracts the BiscGroup settings from the ServiceGroup HTML Element in the page. Retrieves the Capis document. Gets the sapId from the Capis document.

Fetches the "Bisc Site Document" from the RP.

This function finds the ServiceGroup HTML Element in the current HTML page head. Extracts the a BiscGroup from it. (i.e. BiscGroup Detail) Figures out the URI of the "Bisc Site Document" to use. Fetches the "Bisc Site Document" from the RP. Returns a new options object.

As a final step, this function stores a copy of the resolved options and BiscProfile so that it is available for future use.

The configuration descriptor details the authentication abilities that the RP authentication service has.

The defaultValues.biscSiteDocUri of the Bisc Site Document is a "well-known" URI. (Example: "RP_example.com/.well-known/capisBiscSiteDoc.json".)

The biscSiteDocUri option overrides the default Capis document location. It describes where the Bisc Site Document is located.
Example Javascript use:
// Example javascript using "ensurePageConfig"
function doSomething(arg1) {
  // let rpClientData = {};
  return capisControl_api.ensurePageConfig()
  .then( pageConfig => {
    let biscGroupList = pageConfig.biscGroupList;
    let biscProfileId = "remere_1";
    let biscProfile = CCI_getBiscProfileFromPageConfig(biscProfileId, pageConfig);
    let sapId = biscProfile.sapIdBase;
    let baseRpClientData = pageConfig.baseRpClientData;
    let rpClientData = JSON.parse(JSON.stringify(baseRpClientData)); // copy
    let sgContents = biscProfile.biscGroupInfo.sgContents;
    rpClientData.challenge = sgContents.challenge;
    rpClientData.challengeTime = sgContents.challengeTime;
    // rpClientData.ancPolicy = "allowSOWA"; // isSameOriginWithAncestors
    // rpClientData.rpOrigin = rpOrigin;
    // rpClientData.rapId = rapId;
    return remereLogin_api.buildServiceRequest(biscProfileId, "login", callOptions)
  }).then( buildResponse => {
    let requestData = buildResponse.requestData;
    return remereLogin_api.sendRequestToService(buildResponse, requestData);
  }).then( svResponse => {
    if (svResponse.statusOK) ...
  });
}

Capis API Function: CapisControl.getPageConfig()

Return type: Object. Returns undefined if the CapisControl has not been initialized.

Gets a copy of the PageConfig options for the current page. (i.e. configuration options, stored values) The Capis document, sapId, BiscGroup settings. The user may need to call ensurePageConfig() before calling this function. Will return undefined if the CapisControl has not been initialized.

Capis API Function: CapisControl.getBiscProfile(biscProfileIdFull)

Return type: Object. Returns undefined if the CapisControl has not been initialized.

Gets the "BiscProfile Repository" for the specified protocol. This is the set of all BiscProfile definitions. (Note, this gets BOTH the BiscProfile objects from the HTML page, and from the Bisc Site Document.) The BiscProfile describes the service requirements, etc... The user may need to call ensurePageConfig() before calling this function. Will return undefined if the CapisControl has not been initialized.

Function info: (parameter list, return value, etc.)
  • @param {string} biscProfileIdFull; The id of the BiscProfile. Example: "sg_1.remere_1"
  • @return {Object} biscProfile; Contains the BiscProfile items. The combination of all biscProfile.
  • @property {Object} biscProfile.pContents; The BiscProfile.
  • @property {Object} biscProfile.biscGroupInfo; The BiscGroup info.
  • @property {Object} biscProfile.primaryBiscProfileId; The Default. The Page (If it exists), otherwise the Doc.
  • @property {Object} biscProfile.inPage; The biscProfile set in the HTML page.
  • @property {Object} biscProfile.inDoc; The biscProfile set in the CapisDocument.

Capis API Function: CapisControl.getInfo(protocolId, infoId, callOptions)

Return type: Object. {or undefined}

Gets the info values.

The difference between getInfo and performServiceOp is that getInfo executes immediately. It does NOT return a Promise.
Function info: (parameter list, return value, etc.) * Gets a known value from the underlying APIs. * DOES NOT return a Promise.
  • @param {string} protocolId; The id of the protocol.
  • @param {string} infoId; The id of the information to be retrieved.
  • @param {Object} callOptions; The call options.
  • @return {Object} result; The result value.

Capis API Function: CapisControl.performServiceOp(biscProfileId, opId, callOptions)

Return type: Object. {or undefined}

Performs the op.

Capis API Function: CapisControl.addEventListener(protocolId, eventId, listener, listenerOptions)

Return type: Object. {failureReason: "alreadyExists"}

Adds a javascript event listener.

The listener callback function will be called with an eventObject as the first parameter. The eventObject will contain "eventId", "protocolId", "isBefore" (used when listenerOptions.capture=true), and other properties.

Function info: (parameter list, return value, etc.)
  • @param {string} protocolId; The id of the protocol. Example: "remere".
  • @param {string} eventId; The event to listen for. Example: "loginStatusChange" or "all"
  • @param {Object/function} listener; The listener object to receive notification. (Contains function to be executed.)
  • @param {Object} listenerOptions; Additional options when to fire the event.
  • @property {string} listenerOptions.stageName; The stage name. Ex: "build", "send", "eval". (i.e. Before or after the event is sent to the RP.)
  • @property {boolean} listenerOptions.capture; To capture the event BEFORE it is executed.
  • @return {Object} resultObject; The result object.
  • @property {boolean} result.isSuccess; If the function was a success.

Capis API Function: CapisControl.removeEventListener(protocolId, eventId, listener, listenerOptions)

Return type: Object. {removeCount: 1}

Details here.

Function info: (parameter list, return value, etc.)
  • @param {string} protocolId; The id of the protocol. Example: "remere".
  • @param {string} eventId; The event to listen for. Example: "loginStatusChange" or "all"
  • @param {Object/function} listener; The listener object to receive notification. (Contains function to be executed.)
  • @param {Object} listenerOptions; Additional options when to fire the event.
  • @property {string} listenerOptions.stageName; The stage name. Ex: "build", "send", "eval". (i.e. Before or after the event is sent to the RP.)
  • @property {boolean} listenerOptions.capture; To capture the event BEFORE it is executed.
  • @return {Object} resultObject; The result object.
  • @property {boolean} result.isSuccess; If the function was a success.

Capis API Function: CapisControl.sendRequestToService(svReqContext, fetchInfo)

Return type: Promise(Object).

Sends the RML Request to the Remote Service.

Sends the requestData object to the RP endpoint. In whatever manner the RP designated in the Bisc Site Document.

Function info: (parameter list, return value, etc.)
  • @param {Object} svReqContext; The service request context. buildContext from buildServiceRequest.
  • @property {string} svReqContext.buildId; The unique identifier for the build.
  • @property {string} svReqContext.protocolId; The unique identifier for the protocol.
  • @property {string} svReqContext.opId; The operation the service should perform. Ex: "login"
  • @param {Object} fetchInfo; The fetch info.
  • @property {string} fetchInfo.uri; The URI address to send the request to.
  • @property {string} fetchInfo.method; The HTTP method. "GET" or "POST".
  • @property {Array} fetchInfo.queryParamList; The list of data to be sent to the RP service.
  • Example: paramItem = {name:"xxx", type:"json_object", value:{prop1:"xxx", prop2:"yyy"} }
  • @property {string} fetchInfo.contentEncodingType; The contentEncodingType. "JSON".
  • @property {Object} fetchInfo.data; The data to be sent to the RP service. Contains the "proof of identity", etc.
  • @return {Promise(Object)} svResponse; The response from the RP service.
  • @property {boolean} svResponse.statusOK; If the fetch was a success.
  • @property {Object} svResponse.jsonData; The data returned from the service.
  • @property {string} svResponse.url; The URL that was contacted by the request.
  • @property {Object} svResponse.fetchResponse; The wrapped fetch response object.
Example implementation code.
// example implementation
function sendRequestToService(svReqContext, fetchInfo) {
  let transport_response = {};
  let opId = svReqContext.opId;
/*
  let biscProfile = svReqContext.biscProfile;
  let pContents = biscProfile.pContents;
  let sapId = biscProfile.sapId;
    let buildValues = CLD_getBuildValues(svReqContext.buildId);
    let lipId = buildValues.lipId;
    let lomaId = buildValues.lomaId;
*/
  let requestData = fetchInfo.data;
  return Promise.resolve("yyy")
  .then( mmm_respose => {
    // itemRecordDatabase.recordAction(lomaId, lipId, actionOptions);
    let sUri = fetchInfo.uri;
    let dataParamList = fetchInfo.queryParamList;
    if (!(fetchInfo.method === undefined)) { fetchInfo.method = "POST";}
    let fetch_url;
    let fetch_init;
    let http_method = fetchInfo.method;
    if (http_method == "POST") {
      fetch_url = sUri;
      if (http_method == "POST") {} // Use fetchInfo.contentEncodingType.
      let body_data = {};
      dataParamList.forEach( (item,index) => { body_data[item.name] = item.value; });
      fetch_init = {method:"POST", body: body_data};
      fetch_init.headers = { 'content-type': 'application/json' };
    } else if (http_method == "GET") {
      // let query_str = createQueryString(dataParamList);
      let query_str = "";
      dataParamList.forEach( (item,index) => {
        if (index != 0) query_str += "&";
        query_str += encodeURIComponent(item.name) + "=" + encodeURIComponent(JSON.stringify(item.value));
      });
      fetch_url = sUri + "?" + query_str;
      fetch_init = {method:"GET"};
    } else {
      throw new Error("Cannot send request. Invalid protocol=" + http_method);
    }
    // Fetch API, not supported by older browsers.
    return fetch(fetch_url, fetch_init);
  }).then( fetch_response => {
    transport_response.svRequestId = svReqContext.buildId; // TODO this is the svRequestId.
    transport_response.fetchResponse = fetch_response;
    transport_response.url = fetch_response.url;
    transport_response.statusCode = fetch_response.status;
    transport_response.statusOK = false;
    if (!fetch_response.ok) {
      return undefined;
    }
    return fetch_response.json();
  }).then( json_response => {
    if (json_response !== undefined) {
      transport_response.jsonData = json_response;
      transport_response.statusOK = true;
    }
    return transport_response;
  }).catch(error => {
    console.log("Error in sendRequestToService. error=" + error.message);
    return Promise.reject(error);
  });
}

Capis API Function: LoginManager.getPassbookList()

Return type: Promise(Object).

Gets the list of all the Passbook in the LoginManager.

Function info: (parameter list, return value, etc.)
  • @return {Promise(Object)} passbookList_response; The response object.
  • The response object can contain an "error" property instead of result data.
  • @property {Object} response.error; The error object.
  • @property {Array} response.passbookList; The list of the Passbook info.
  • @property {string} item.id; The Passbook identifier. Example: "p2"
  • @property {string} item.name; The name of the Passbook. Example: "John's Work"

Capis API Function: LoginManager.createPassbook(passbookInfo)

Return type: Promise(Object).

Creates a new Passbook with the specified properties. (i.e. The passbook name.)

Function info: (parameter list, return value, etc.)
  • @param {Object} passbookInfo; The collection of passbook properties.
  • @property {string} passbookInfo.name; The name to give to the passbook.
  • @return {Promise(Object)} passbookInfo_response; The response object.
  • The response object can contain an "error" property instead of result data.
  • @property {Object} response.error; The error object.
  • @property {string} response.passbookId; The Passbook identifier. Example: "p2"
  • @property {integer} response.selectionGrade; The priority (weight) of the Passbook.

Capis API Function: LoginManager.setPassbookDetails(passbookId, passbookInfo)

Return type: Promise(Object).

Sets the info of the Passbook. Primarily, this sets the name of the Passbook.

Function info: (parameter list, return value, etc.)
  • @param {string} passbookId; The Passbook identifier. Example: "p2"
  • @param {Object} passbookInfo; The collection of passbook properties.
  • @property {string} passbookInfo.name; The new passbook name.
  • @property {integer} passbookInfo.selectionGrade; The priority (weight) of the Passbook.
  • @return {Promise(Object)} passbookInfo_response; The response object.
  • The response object can contain an "error" property instead of result data.
  • @property {Object} response.error; The error object.
  • @property {string} response.passbookId; The Passbook identifier. Example: "p2"

Capis API Function: LoginManager.collectUserLogins(filterOptions, rapId)

Return type: Promise(Object). Contains some javascript arrays (does NOT return a promise??)

Gets a list of User Logins, a list of Passbooks, and their match grade.

Searches the Login Manager for User Logins that meet the RP requirements. (i.e. For User Logins that can be used at the RP.) It takes the sapIdSpec and altLoginSourceList as input, and restricts its results based on the rapId.

One item in the list will be the "default". (pre-selected for the user) This is usually the most-recently used login for the website. The caller can use the result list of User Login in a dialog box that is displayed to the user, asking which User Login to use.

Function info: (parameter list, return value, etc.)
  • @param {Object} filterOptions; The filter criteria. To limit the returned list of User Logins.
  • @property {string} filterOptions.sapId; The Source Application identifier. Example: "login.example.com/1577836800"
  • @property {Array} filterOptions.altLoginSourceList; A list of alternate ulSource items.
  • @object_example ulSourceItem = {"sapId":"example.com/svApp2.json", "colMode":"SSO"}
  • @property {Object} filterOptions.clientProtocolCfg; The collection of ProtocolConfig values.
  • @property {string} opId; The method (function name) to be performed. ("login", "setActiveCredentials", etc.)
  • @param {string} rapId; The Requesting Application identifier. Example: "login.example.com" (limits access to only some RP)
  • @return {Promise(Object)} query_response; The response object. Contains two lists of User Logins.
  • @property {Array} response.qualUserLoginList; The list of qualified User Logins. (That survived filtering.)
  • @property {Array} response.unqualUserLoginList; The list of un-qualified User Logins. (That were filtered out.)
  • @property {Array} response.allPassbookList; The list of Passbooks. Each passbook contains a list of registered User Login.
  • Returns a list of the User Logins. And a list of all Passbooks in the LoginManager.
Example API use.
// Example javascript using a BiscProfile
let altLoginSourceList = [
      {"sapId":"login.example.com/svApp2.json", "colMode":"SSO"},
      {"sapId":"example.com/svApp3.json", "colMode":"SSO"} ];
let filterOptions = { altLoginSourceList: altLoginSourceList, clientProtocolCfg: mmm };
let lomaQResultItem = {};
  return LoginManager.collectUserLogins(filterOptions, rapId)
  .then( findUL_response => {
    lomaQResultItem.qualList = findUL_response.qualUserLoginList;
    lomaQResultItem.unqualList = findUL_response.unqualUserLoginList;
  });

Capis API Function: LoginManager.importUserLogin(passbookId, exportedLogin, importOptions)

Return type: Promise(Object).

Imports a User Login into the browser. (How to import?)

Attempts to import a User Login into the Passbook. The UserLogin data was previously exported from a (different) LoginManager.

This function returns a Promise. It can fail. The User Login can be malformed, or the protocol can be unknown or unsupported.

// Adds a User Login to the browser. (How to import?) Callback asks for the private key?
Function info: (parameter list, return value, etc.)
  • @param {string} passbookId; The Passbook identifier. Example: "p2" (Where to store the import.)
  • @param {Object} exportedLogin; The exported User Login to import.
  • @property {string} exportedLogin.userIdRaw; The userId value in the UserLogin.
  • @property {string} exportedLogin.sapId; The Source Application identifier. Example: "login.example.com/1577836800"
  • @property {Array} exportedLogin.credSrcExportList; A list of exported "Credential Source" objects.
  • @object_example credSrcExportItem = { cci: "834", type: "public-key", alg_COSE: -7}
  • @property {string} exportedLogin.disambigName; The disambiguation name.
  • @property {integer} exportedLogin.creationDate; The timestamp when created.
  • @property {integer} exportedLogin.lastLoginDate; The timestamp of the last login.
  • @property {Array} exportedLogin.tagList; The list of "tags" to add to the UserLogin.
  • @param {Object} importOptions; The User Login import options.
  • @property {Object} importOptions.rpClientData; The collected client data. {opId, challenge, ancPolicy, rpOrigin}
  • @property {Object} importOptions.rpEntityInfo; The RP entity information. (For credential creation.)
  • @property {Array} importOptions.credSourceCreationList; A list of "Credential Source creation" objects.

Capis API Function: LoginManager.createUserLogin(passbookId, sapId, userLoginCreation, rapId, rpClientData)

Return type: Promise(Object).

Creates a new User Login that is associated with the sapId. Adds it to the specified Passbook. Creates all the requested credentials for the User Login.

Takes the sapIdSpec as the sapId argument. Returns an object that contains the lipId of the new User Login. On error, returns an error object.

Note that only certain rapId are allowed to create User Logins that user certain sapId. See sapIdSpec.

Function info: (parameter list, return value, etc.)
  • @param {string} passbookId; The Passbook identifier. Example: "p2" (Where to store the new User Login.)
  • @param {string} sapId; The Source Application identifier. Example: "login.example.com/1577836800"
  • @param {Object} userLoginCreation; Object containing other creation options.
  • @property {string} userLoginCreation.disambigName; The disambiguation name. (If needed)
  • @property {string} userLoginCreation.initUserId; The initial User Id. Requested by the client.
    Warning: This only sets the *original* userId. (Before the request to the RP.) (Example: If using userid_creation.claim_ms_ulc.)
  • @property {Array} userLoginCreation.credSourceCreationList; A list of "Credential Source creation" objects.
    Example: credCreationInfo_item = { "cci":"834", "type":"public-key", "alg_COSE": -7}
  • @property {Array} userLoginCreation.allowedRapIdList; The list of rapIds (Foreign?) allowed to use the UserLogin.
    Example: allowedRapIdList: [{"rapId":"example.com"}, {"rapId":"arc.example.com"}]
  • @property {Object} userLoginCreation.rpEntityInfo; The RP entity information. (For credential creation.)
  • @param {string} rapId; The Requesting Application identifier. Example: "login.example.com"
  • @param {Object} rpClientData; The collected client data. {opId, challenge, ancPolicy, rpOrigin}
  • @property {string} rpClientData.opId; The operation id. Example: "login", "registerUserLogin"
  • @property {string} rpClientData.challenge; The RP nonce value. base64url encoded.
  • @property {string} rpClientData.ancPolicy; The ancestor policy. Example: "allowSOWA"
  • @property {string} rpClientData.rpOrigin; The origin of the RP. Example: "example.com"
  • @return {Promise(Object)} createUserLogin_response; The response object.
  • @property {string} response.lipId; The LoginItem Permanent Id. Example: "u34"
  • @property {integer} response.creationDate; The date the UserLogin was created. (Unix currentTS)
  • @property {Array} response.createdCredentialList; The list of credentials that were created.
    Example: createdCredential_item = { id: "cd2", cci: "834", type: "public-key" }
  • The response object can contain an "error" property instead of result data.
  • @property {Object} response.error; The error object.
Internal steps:
  • Call generateKeyPair()

Capis API Function: LoginManager.getUserLoginDetails(lipId, rapId)

Return type: Promise(Object). The User Login object.

Gets the specified User Login and the contained credential list.

Returns undefined if the lipId is invalid. If there is no User Login for that lipId. (Or if the access restrictions are wrong.)

This does not return the actual credentials. It only returns a list of the credential information. Their ID, type and public keyHandle (if applicable).

Function info: (parameter list, return value, etc.)
  • @param {string} lipId; The LoginItem Permanent Id. Example: "u34"
  • @param {string} rapId; The Requesting Application identifier. Example: "login.example.com" (limits access to only some RP)
  • @return {Promise(Object)} userLoginDetails_response; Will be undefined if the User Login is not found.
  • @property {boolean} ulDetails.isRpRegistered; Is true if the User Login has been registered with the RP.
  • @property {string} ulDetails.sapId; The Source Application identifier. Example: "login.example.com/1577836800"
  • @property {string} ulDetails.passbookId; The Passbook identifier. Example: "p2".
  • @property {string} ulDetails.enc_user_id; The encrypted UserId. Example: "qi:A:H:1:K8h3_TfXr6ZtLq7d1m8k".
  • @property {string} ulDetails.displayName; The name to display. Only used if multiple User Logins for the same RP.
  • @property {integer} ulDetails.creationDate; The date the User Login was created. (Unix timestamp)
  • @property {integer} ulDetails.modifiedDate; The date the User Login was modified. (Unix timestamp)
  • @property {integer} ulDetails.lastLoginDate; The date the User Login was last used. (Unix timestamp)
  • @property {integer} ulDetails.rpRegDate; The date the User Login was registered at RP. (Unix timestamp)
  • (There are only 3 kinds of modification. Change enc_user_id, displayName, or credential list.)
  • @property {Array} ulDetails.activeCredentialIdList; The array of active credential Ids.
  • @object_example activeCredentialIdList = [ "cd2", "cd15", "cd3" ] Composed of only credential ids.
  • @property {Array} ulDetails.activeCredentialDetailList; The array of active credentials.
  • @object_example activeDetailItem = {id:"cd2", type: "public-key"}
  • @property {Array} ulDetails.stagedCredentialIdList; The array of staged credentials.
  • @object_example stagedCredentialIdList = [ "cd2", "cd15", "cd3" ] Composed of only credential ids.
  • @property {Array} ulDetails.completeCredentialList; All the existing credentials for the User Login.
  • @object_example completeList_item = {id:"cd2", type: "public-key", COSE_alg: -7}

Capis API Function: LoginManager.setUserLoginDetails(lipId, newProperties, rapId)

Return type: Promise(Object). Object containing boolean "isSuccess" property.

Updates the User Login with the new info. Can change only 6 things, the "assigned" UserId, the display_name, the passbookId, the "staging" list of credentials, the "confirmed" list of credentials and the "addTagList".

The newProperties can contain the following properties. "updatedUserId", "displayName", "passbookId", "toBeStagedCredentialIdList", "credConfirmList", "addTagList" and "removeTagList".

Function info: (parameter list, return value, etc.)
  • @param {string} lipId; The LoginItem Permanent Id. Example: "u34"
  • @param {Object} newProperties; The new property values.
  • @property {string} newProperties.displayName; The new display name, set by the user. (Only used if a Passbook contains multiple User Logins for the same RP.)
  • @property {string} newProperties.passbookId; The Passbook identifier. Example: "p2".
  • @property {Array} newProperties.toBeStagedCredentialIdList; The (existing) credentials to be staged.
  • @object_example toBeStagedCredentialIdList = [ "cd2", "cd15", "cd3" ] Composed of only credential ids.
  • @property {Array} newProperties.addTagList; The list of "tags" to add to the User Login.
  • @property {Array} newProperties.removeTagList; The list of "tags" to remove from the User Login.
  • @param {string} rapId; The Requesting Application identifier. Example: "login.example.com" (limits access to only some RP)
  • @return {Promise(Object)} userLogin_info; The response object.
  • The response object can contain an "error" property instead of result data.
  • @property {Object} response.error; The error object.
  • @property {string} response.lipId; The LoginItem Permanent Id. Example: "u34"

Capis API Function: LoginManager.updateUserLoginWithServiceResult(lipId, svUlUpdate, rapId)

Return type: Promise(Object). Object containing boolean "isSuccess" property.

Updates the User Login with the new info. Can change only 6 things, the "assigned" UserId, the display_name, the passbookId, the "staging" list of credentials, the "confirmed" list of credentials and the "addTagList".

The svUlUpdate can contain the following properties. "updatedUserId", "confOpId", "credConfirmList".

Function info: (parameter list, return value, etc.)
  • @param {string} lipId; The LoginItem Permanent Id. Example: "u34"
  • @param {Object} svUlUpdate; The UserLogin update. From the RP service. After the requested operation.
  • @property {string} svUlUpdate.updatedUserId; The new user id. May be encrypted. Usually given by the RP. (in assignedUserId.)
  • @property {Array} svUlUpdate.credConfirmList; The credential confirm results from the RP.
    Example: credentialConfirmItem = {id: "cd2", error:"invalid"}
  • @property {string} svUlUpdate.confOpId; The Confirmation Operation Id. Ex: confOpId = "registerUserLogin".
    Must be one of "registerUserLogin", "setActiveCred", "login", "importUserLogin". (Result after RP registration or login.)
  • @param {string} rapId; The Requesting Application identifier. Example: "login.example.com" (limits access to only some RP)
  • @return {Promise(Object)} ulUpdateResponse; The ulUpdate response object.
  • The response object can contain an "error" property instead of result data.
  • @property {Object} response.error; The error object.
  • @property {string} response.lipId; The LoginItem Permanent Id. Example: "u34"

Capis API Function: LoginManager.createCredentialSources(lipId, credentialOptions, rapId)

Return type: Promise(Object).
Function info: (parameter list, return value, etc.)
  • @param {string} lipId; The LoginItem Permanent Id. Example: "u34"
  • @param {Object} credentialOptions; Credential creation options.
  • @property {Object} credentialOptions.rpClientData; The collected client data. {opId, challenge, ancPolicy, rpOrigin}
  • @property {Object} credentialOptions.rpEntityInfo; The RP entity information. (For credential creation.)
  • @property {Array} credentialOptions.credSrcCreationList; A list of "Credential Source creation" objects.
    @object_example credSrcCreationItem = { "cci":"834", "type":"public-key", "alg_COSE": -7}
  • @property {string} rpClientData.challenge; The RP nonce value. base64url encoded.
    The challenge may be needed for the newly created credentials to have proper attestation data. The challenge is optional. It is only needed for WebAuthn, where it proves "freshness" of the attestation data.
  • @param {string} rapId; The Requesting Application identifier. Example: "login.example.com" (limits access to only some RP)
  • @return {Promise(Object)} createCred_response; The response object.

Capis API Function: LoginManager.stageActiveCredentials(lipId, credentialOptions, rapId)

Return type: Promise(Object).

Sets the "first stage" of the active credentials. This is the first step in setting the "active" credentials at the RP. After this function is called, the RP must be sent a "setActiveCredentials" RML Request. If the RP responds with a success, then the browser will update the "active" credentials in the Login Manager. (The RemereDirector.evaluateServiceResponse() function calls LoginManager.setUserLoginDetails(lipId, newProperties, rapId).)

The input must specify which credentials to use. This is actually two lists, (1) a list of existing credential IDs and (2) a list of new credentials to be created. For each specified new-credential-info, the Login Manager will create a new credential source for use with the specified User Login, and add the credential ID to the "createdCredentialList" that is returned. (The credential sources are kept secret internally to the User Login. The credential ID and type are returned.)

Returns an object containing two lists. (1) a list of the "created" credential info objects. This list items contain the credential id, the type, and other public settings. (i.e. the algorithm) (2) a list of the "selected" credentials. This contains the credential IDs for credentials that were not created, and previously existed.

Function info: (parameter list, return value, etc.)
  • @param {string} lipId; The LoginItem Permanent Id. Example: "u34"
  • @param {Object} credentialOptions; Credential selection and creation options.
  • @property {Object} credentialOptions.rpClientData; The collected client data. {opId, challenge, ancPolicy, rpOrigin}
  • @property {Object} credentialOptions.rpEntityInfo; The RP entity information. (For credential creation.)
  • @property {Array} credentialOptions.credSourceCreationList; A list of "Credential Source creation" objects.
    @object_example credCreationInfo_item = { "cci":"834", "type":"public-key", "alg_COSE": -7}
  • @property {Array} credentialOptions.existingCredentialIdList; A list of which existing credentials to use.
  • @object_example existingCredentialIdList = [ "cd2", "cd15", "cd3" ] Composed of only credential ids.
  • @param {string} rapId; The Requesting Application identifier. Example: "login.example.com" (limits access to only some RP)
  • @return {Promise(Object)} setCred_response; The response object.
  • @property {Array} response.createdCredentialList; The list of credentials that were created. (id, type)
  • @object_example createdCredItem = { id: "cd14", cci: "834", type: "public-key" }
  • @property {Array} response.selectedCredentialIdList; The list of staged credentials that already existed.
  • @object_example selectedCredentialIdList = [ "cd2", "cd15", "cd3" ] Composed of only credential ids.

Will create the requested new credentials listed in the "credSourceCreationList".

For new public key attestation, the RP needs a single bit of information about any registration: was this public-key generated in a certified device or not?

Capis API Function: LoginManager.createUserLoginProofForRp(lipId, opId, rpClientData, buildOptions)

Return type: Promise(Object). The user can quit or cancel the login. The success callback receives a "proof-of-identity" container object. Or null.

Creates a User Authentication service request, for delivery to an RP. Created to meet the RP's requirements. It will contain a proof-of-identity.

This function uses the provided "sapId" as the "aud" (audience) field in the proof-of-identity.

Returns a promise. The success callback receives a "proof-of-identity" container object. It contains UP TO 4 items. Either the proof-of-identity, or the UserId Assertion and the values for the UserId certificate.

Function info: (parameter list, return value, etc.)
  • @param {string} lipId; The LoginItem Permanent Id. Example: "u34"
  • @param {string} opId; The method (function name) for the service to perform. (Ex: "login", "setActiveCredentials", etc.)
  • @param {Object} rpClientData; The collected client data. {opId, challenge, ancPolicy, rpOrigin}
  • @property {string} rpClientData.opId; The operation id. Example: "login", "registerUserLogin"
  • @property {string} rpClientData.challenge; The RP nonce value. base64url encoded.
  • @property {string} rpClientData.ancPolicy; The ancestor policy. Example: "allowSOWA"
  • @property {string} rpClientData.rpOrigin; The origin of the RP. Example: "example.com"
  • @param {Object} buildOptions; Other options.
  • @property {string} buildOptions.sapId; The Source Application identifier. (Used as the "audience".)
  • @property {string} buildOptions.rapId; The Requesting Application identifier. Example: "login.example.com"
  • @property {Object} buildOptions.biscProfileId; The id of the BiscProfile. Example: "sg_1.remere_1"
  • @property {string} buildOptions.reqUserId; The client requested UserId string.
    Used when opId="registerUserLogin" or "setUserId". (Example: If using userid_creation.claim_ms_ulc.)
  • @property {Object} buildOptions.sessionNotes; Anything special the RP requires from the session.
Internal steps:
  • Determine if the JWS will need a credential_registration section. (This is the case for opId "registerUserLogin" and "setActiveCredentials".)
  • If credential_registration is required, then call createNonPublicKeyProofItems.
  • If credential_registration is required, then determine if backup keys are needed.
  • Create the payload. Include the fields that the RP requires.
  • Look up the private key(s) for the User Login.
  • Sign the proof-of-identity with the private keys.

Additional option. As part of the process, it may be desirable to create a new key-pair and send the public key to the RP as part of the proof. This key may be used to secure session communication between the browser and the RP. If this is done, the private key must be stored internally to the browser. Example: {lipId:"u34", RP_domainName:"123done.org", private_key:"xxxx"}

Example Javascript use:
// Example javascript using "createUserLoginProofForRp"
lipId = "u34"
resolvedOptions
buildOptions = {op:"login", bip:"remere_1", for_future_use:"something..."}

// return value:
a Promise

// Promise resolves to:
proof_assertion = {
uid_cert_chain:[{uic.format:"JWS", uic.csvm:"OIDCD", "ucv": { "payload":"82h7vb...", "signatures": [...] } }]
}
Example implementation code.
// example implementation
function createUserLoginProofForRp(lipId, opId, rpClientData, buildOptions) {
  let sapId = buildOptions.sapId;
  let callOptions = buildOptions.callOptions;
  let opId = buildOptions.op; // Example: "login"
  let biscProfileId = buildOptions.bip; // Example: "remere_1"
  let signInput = buildOptions.signInput;
  let active_values = credentialStore_getActiveValues(); // created previously from the options and page settings.
  let service_info = active_values.service_info;
  let proof = {};
  let payload = {};
  let signatures = [];
  proof.payload = payload;
  proof.signatures = signatures;
  payload.biscProfileId = buildOptions.biscProfileId; // "remere_1";
  payload.opIdReq = opId;
  // payload.nonce = rpClientData.challenge
  payload.challenge = rpClientData.challenge
  payload.cht = rpClientData.challengeTime;
  payload.redirectUri = callOptions.redirectUri;
  payload.iat = new Date().getTime();
  let ulCreationCfg = callOptions.ulCreationCfg;
  // payload.uid.clientReqUserId = ulCreationCfg.userIdConfig;
  // payload.uic.format = ?;
  // payload.uid_cert_chain = [];
  return Promise.resolve("yyy")
  .then( yyy_response => {
    let signInput2 = payload
    return bLoginManager.createNonPublicKeyProofItems(lipId, rpClientData, signInput2, buildOptions);
  }).then( assert_response => {
    let proof_list = assert_response.assertion.cpl;
    // proof.signatures = proof_list;
    proof_list.forEach( function(item, index, array) {
      let m2 = { header: { kid: item.cid_p}, protected: {typ_p: item.typ_p, fmt_p: item.fmt_p}, signature: item.val_p};
      signatures.push(m2);
    });
    credentialStore_storeUserLoginHistory(lipId);
    return proof;
  });
}

Capis API Function: RemereLogin.performServiceOp(biscProfileId, opId, callOptions)

Return type: Promise(Object). The user can quit or cancel the requested opId.
Example implementation code.
  • @param {string} biscProfileIdFull; The id of the BiscProfile. Example: "sg_1.remere_1"
  • @param {string} opId; The method (function name) for the service to perform. (Ex: "login", "setActiveCredentials", etc.)
  • @param {Object} callOptions; The configuration options for the RP service call.
  • @property {string} callOptions.redirectUri; The URI to redirect to after the opId.
  • @return {Promise(Object)} prHandlerResponse; The Protocol Handler response object.
  • @property {Object} phResponse.buildResponse; The data that was built.
  • @property {Object} buildResponse.requestData; The request that was built.
  • @property {Object} phResponse.svResponse; The response from the service.
  • @property {boolean} svResponse.statusOK; If the fetch was a success.
  • @property {Object} svResponse.jsonData; The data returned from the service.
  • @property {Object} phResponse.evalResponse; The response from the evaluation.
// example implementation
function RML_performServiceOp(biscProfileId, opId, callOptions) {
  // Return an "prHandlerResponse". This may contain (probably contains) a svResponse.
  let prHandlerResponse = {};
  prHandlerResponse.callOptions = callOptions;
  let buildContext;
  return this.buildServiceRequest(biscProfileId, opId, callOptions)
  .then( buildResponse => {
    prHandlerResponse.buildResponse = buildResponse.buildResponse;
    buildContext = buildResponse;
    return this.sendRequestToService(buildResponse, buildResponse.requestData);
  }).then( svResponse => {
    prHandlerResponse.svResponse = svResponse;
    CLW_fireEvent("sendRequest", opId, false, callOptions);
    if (!svResponse.statusOK) {
      // Error connecting to the service.
      let url = svResponse.url;
      let statusCode = svResponse.fetch_response.status; // For debug
      let statusText = svResponse.fetch_response.statusText;
      throw new Error("Bad response from service. statusCode=" + statusCode + " statusText=" + statusText + " url=" + url);
    } else {
      return RML_evaluateServiceResponse(buildContext, svResponse);
    }
  }).then( evaluate_response => {
    prHandlerResponse.evalResponse = evaluate_response;
    CLW_fireEvent("evaluateResponse", opId, false, callOptions);
    let eval_success = true; // evaluate_response.statusOK
    if (eval_success) {
      // Notify the user that the opId succeeded.
      // Can refresh the page or navigate to a different page.
      // location.reload(); or location.href = callOptions.redirectUri;
    }
    return prHandlerResponse;
  }).catch(error => {
    if (!error.message.startsWith("Action canceled")) {
      se8_debug.log("Error in RLP.performServiceOp error=" + error.message);
    }
    return Promise.reject(error);
  });
}

Capis API Function: RemereLogin.buildServiceRequest(biscProfileId, opId, callOptions)

Return type: Promise(Object). The user can quit or cancel the login.

This function is a small wrapper for RemereDirector.buildServiceRequest(biscProfileId, opId, callOptions, callerCfg, rpClientData). It exists to allow browser extensions a place to implement additional functionality before calling the "unmodifiable" RemereDirector functions.

Installed extensions can redefine this function. Since this function returns a promise, the new functionality can even include an online API call. For example, it could query an online storage system that stores identities for the user. And the online API call could be done only if the original function fails.

Function info: (parameter list, return value, etc.)
  • @param {string} biscProfileIdFull; The id of the BiscProfile. Example: "sg_1.remere_1"
  • @param {string} opId; The method (function name) for the service to perform. (Ex: "login", "setActiveCredentials", etc.)
  • @param {Object} callOptions; The configuration options for the RP service call.
  • @property {string} callOptions.redirectUri; The URI to redirect the user to after the opId.
  • @property {Object} callOptions.criteriaChangeSet; The changes to make to the UIC. Only used with opId "registerUserLogin", "setActiveCredentials"
  • @return {Promise(Object)} buildResponse.
  • @property {Object} response.requestData; The request that was built.
  • @object_example requestData = { JWA: {payload:"xxx", signatures:[{mm:"xx"}] } }

!!!!This function can show popup dialogs or redirect the user.!!!!

Internal steps:
  • Call CapisControl.ensurePageConfig() to get the "BiscGroup repository".
  • Create a local rpClientData object.
  • Call RemereDirector.buildServiceRequest(biscProfileId, opId, callOptions, callerCfg, rpClientData)
Example implementation code.
// example implementation
function RML_buildServiceRequest(biscProfileId, opId, callOptions) {
  // let rpClientData = {rpOrigin: window.location.origin, pathname: window.location.pathname};
  return capisControl_api.ensurePageConfig()
  .then( pageConfig => {
    let biscGroupList = pageConfig.biscGroupList;
    let biscProfile = RML_getBiscProfile(biscProfileId, pageConfig);
    let baseRpClientData = pageConfig.baseRpClientData;
    let rpClientData = JSON.parse(JSON.stringify(baseRpClientData)); // copy
    let sgContents = biscProfile.biscGroupInfo.sgContents;
    rpClientData.challenge = sgContents.challenge;
    rpClientData.challengeTime = sgContents.challengeTime;
    // rpClientData.ancPolicy = "allowSOWA"; // isSameOriginWithAncestors
    // rpClientData.rpOrigin = rpOrigin;
    // rpClientData.rapId = rapId;
    let sapId = biscProfile.sapIdBase;
    let callerCfg = {};
    callerCfg.rapId = rpClientData.rapId;
    callerCfg.biscProfile = biscProfile;
    callerCfg.pageConfig = pageConfig;
    // callerCfg.opId = opId;
    // callerCfg.rpClientData = rpClientData;
    return pRemereDirector_api.buildServiceRequest(biscProfileId, opId, callOptions, callerCfg, rpClientData);
  }).then( buildResponse => {
    // check values
    return buildResponse;
  });
}

Capis API Function: RemereLogin.sendRequestToService(svReqContext, requestData)

Return type: Promise(Object).

Sends the requestData object to the RP endpoint. In whatever manner the RP designated in the Bisc Site Document.

Function info: (parameter list, return value, etc.)
  • @param {Object} svReqContext; The service request context. (The buildResponse from buildServiceRequest.)
  • @property {string} svReqContext.buildId; The unique identifier for the build.
  • @property {string} svReqContext.opId; The operation the service should perform. Ex: "login"
  • @param {Object} requestData; The data to be sent to the RP service. Contains the "proof of identity", etc.
  • @return {Promise(Object)} svResponse; The response from the RP service.
  • @property {boolean} svResponse.statusOK; If the fetch was a success.
  • @property {Object} svResponse.jsonData; The data returned from the service.
  • @property {string} svResponse.url; The URL that was contacted by the request.
  • @property {Object} svResponse.fetchResponse; The wrapped fetch response object.
Example Javascript use:
// Example javascript using "sendRequestToService"
let callOptions = {
  "protocolId": "remere",
  "opIdReq": "login",
uid_cert_chain:[{ uic.format:"JWS", uic.csvm:"OIDCD", "ucv": { "payload":"82h7vb...", "signatures": [...] } }],
redirectUri:"http://example.com/some/path/page.html" }; function doSomething(arg1) { // Could call remereLogin_api.performServiceOp("login", arg1); return remereLogin_api.buildServiceRequest(biscProfileId, "login", callOptions) .then( buildResponse => { let requestData = buildResponse.requestData; return remereLogin_api.sendRequestToService(buildResponse, requestData); }).then( svResponse => { if (svResponse.statusOK) ... }); }
Example implementation code.
// example implementation
function RML_sendRequestToService(svReqContext, requestData) {
  let svResponse;
  let opId = svReqContext.opId;
  let bip = "remere_1";
  return pRemereDirector_api.sendRequestToService(svReqContext, requestData)
  .then(svResponse => {
    CLW_fireEvent("sendRequest", opId, false, svResponse);
    let jsonData = svResponse.jsonData;
    let statusOK = svResponse.statusOK;
    return svResponse;
  }).catch(error => {
    console.log("Error in sendRequestToService. error=" + error.message);
    return Promise.reject(error);
  });
}

Capis API Function: RemereLogin.evaluateServiceResponse(svReqContext, svResponse)

Return type: Object.

Update the Remere Login Status at the RP, add the result to history.

Function info: (parameter list, return value, etc.)
  • @param {Object} svReqContext; The service request context. Used to create the request to the RP service.
  • @property {Object} svReqContext.clientContext; The context of the client. Ex: The HTML page that made the call.
  • @param {Object} svResponse; The response from the RP service.
  • @property {boolean} svResponse.statusOK; If the fetch was a success.
  • @property {Object} svResponse.jsonData; The data returned from the service.
  • @return {Promise(Object)} evalResponse; The response from the evaluation.
  • @property {Object} evalResponse.svResponse; The svResponse object that was passed in as an argument.
// example implementation
function RML_evaluateServiceResponse(svReqContext, svResponse) {
  return pRemereDirector_api.evaluateServiceResponse(svReqContext, svResponse)
  .then( eval_response => {
    CL_fireEvent(...);
    return eval_response;
  });
}

Capis API Function: RemereLogin.getLoginStatus()

Return type: Object.

Gets the current Remere Login Status at the RP, the biscProfile, etc. (Which service was used to login.) This function does NOT return the lipId. It does not return the raw UserId.

Function info: (parameter list, return value, etc.)
  • @internal {string} sapId; The Source Application identifier. Example: "login.example.com/1577836800"
  • @return {Object} ulStatus; Contains the User Login status info.
  • @property {string} ulStatus.sapId; The Source Application identifier. Example: "login.example.com/1577836800"
  • @property {string} ulStatus.lipId; The LoginItem Permanent Id is NOT available. Example: "u34"
  • @property {string} ulStatus.lomaId; The LoginManager identifier is NOT available. Example: "m1"
  • @property {string} ulStatus.userId; The userId is NOT available. Example: "f234"
  • @property {string} ulStatus.sessionUserId; The temporary UserId that is logged in.
  • @property {integer} ulStatus.statusCode; Example: 2 = logged_out
  • @property {boolean} ulStatus.hasError; If there is an error.
  • @property {string} ulStatus.errorCode; If there is an error. 1=unknown sapId. 2=missingRecord.
  • @property {boolean} ulStatus.noRecord; There is no record for the given sapId. (uninitialized).
  • @object_example loginStatus = {sapId:sapId, sessionUserId:"none", statusCode:2} (2="logged_out")

The login status is a number. 1 = logged_in, 2 = logged_out.

This function does NOT return the lipId or the raw UserId, because that information is secret / protected. The lipId MUST NOT be known to the RP. Because the RP can use it to identify the Authenticator. (The lipId for the RP is unique to the Authenticator.) For added security, the raw UserId SHOULD not be known to the browser User Agent, as a modified user agent can record the UserId. (And not delete it after use.) As a potential security precaution, a sessionUserId is created and used in the proof of identity, so that the raw UserId is not revealed to the User Agent. If the sessionUserId were not used, then a browser would be given the real UserId that is used to login to the RP. An insecure or modified browser could record the UserId and/or transmit it to a third party, etc. Once a UserId is known, various means can be attempted to compromise the password / private key.

// example implementation
function RML_getLoginStatus() {
  let sapId = CLP_getStoredSapId();
  if (sapId === undefined) {
    let attemptRecovery = false;
    if (attemptRecovery) {
      let biscProfileId = RML_activeValues.activeBiscProfileId; // Ex: "sg_1.remere_99"
      let pageConfig = capisControl_api.getPageConfig();
      let biscProfile = CCI_getBiscProfileFromPageConfig(biscProfileId, pageConfig);
      sapId = biscProfile.sapIdBase;
    }
    return {hasError: true, errorMsg: "Not initialized. The current sapId is unknown.", isLoggedIn: undefined};
  }
  let loginStatusInfo = pRemereDirector_api.getLoginStatus(sapId);
  CL_fireEvent(...);
  return loginStatusInfo;
}

Capis API Function: RemereLogin.logoutAll()

Return type: Promise(Object)??.

Sends a logout request to all logged-in "auth" websites. This function is callable by users via the toolbar, etc. (calls logout on all logged-in websites)

Example Javascript use:
// Example javascript using "logoutAll"
remereLogin_api.logoutAll(); // Note the function does not take callOptions as an argument.

Capis API Function: RemereLogin.addEventListener(eventId, listener, listenerOptions)

Return type: Object. {failureReason: "alreadyExists"}

Adds a javascript event listener.

The listener callback function will be called with an eventObject as the first parameter. The eventObject will contain "eventId", "protocolId", "isBefore" (used when listenerOptions.capture=true), and other properties.

Function info: (parameter list, return value, etc.)
  • @param {string} eventId; The event to listen for. Example: "loginStatusChange" or "all"
  • @param {Object/function} listener; The listener object to receive notification. (Contains function to be executed.)
  • @param {Object} listenerOptions; Additional options when to fire the event.
  • @property {string} listenerOptions.stageName; The stage name. Ex: "build", "send", "eval". (i.e. Before or after the event is sent to the RP.)
  • @property {boolean} listenerOptions.capture; To capture the event BEFORE it is executed.
  • @return {Object} resultObject; The result object.
  • @property {boolean} response.isSuccess; If the function was a success.

Capis API Function: RemereLogin.removeEventListener(eventId, listener, listenerOptions)

Return type: Object. {removeCount: 1}

Details here.

Function info: (parameter list, return value, etc.)
  • @param {string} eventId; The event to listen for. Example: "loginStatusChange" or "all"
  • @param {Object/function} listener; The listener object to receive notification. (Contains function to be executed.)
  • @param {Object} listenerOptions; Additional options when to fire the event.
  • @property {string} listenerOptions.stageName; The stage name. Ex: "build", "send", "eval". (i.e. Before or after the event is sent to the RP.)
  • @property {boolean} listenerOptions.capture; To capture the event BEFORE it is executed.
  • @return {Object} resultObject; The result object.
  • @property {boolean} response.isSuccess; If the function was a success.

Capis API Function: RemereLogin.importUserLogin(lomaId, passbookId, exportedLogin, importOptions)

Return type: Promise(Object).

Imports a User Login into the browser. (How to import?)

Attempts to add a User Login to the internal Passbook.

This function returns a Promise. It can fail. The User Login can be malformed, or the protocol can be unknown or unsupported.

Note, installed extensions can redirect this function to add identities to an online storage system.

Function info: (parameter list, return value, etc.)
  • @param {string} lomaId; The LoginManager identifier. Example: "m1" (Where to store the import.)
  • @param {string} passbookId; The Passbook identifier. Example: "p2" (Where to store the import.)
  • @param {Object} exportedLogin; The exported User Login to import.
  • @property {Array} exportedLogin.tagList; The list of "tags" to add to the UserLogin.
  • @param {Object} importOptions; The User Login import options.
  • @property {Object} importOptions.rpClientData; The collected client data. {opId, challenge, ancPolicy, rpOrigin}
  • @property {Object} importOptions.rpEntityInfo; The RP entity information. (For credential creation.)
  • @property {Object} importOptions.credSourceCreationList; A list of "Credential Source creation" objects.
  • @return {Promise(Object)} import_response; The response object.
  • @property {boolean} response.isSuccess; If the function was a success.
Example implementation code.
// example implementation
function RML_importUserLogin(lomaId, passbookId, exportedLogin, importOptions) {
  let sapId;
  return capisControl_api.ensurePageConfig()
  .then( pageConfig => {
    // let pageConfig = capisControl_api.getPageConfig();
    let biscProfile = CCI_getBiscProfileFromPageConfig(biscProfileId, pageConfig);
    sapId = biscProfile.sapIdBase;
    return pRemereDirector_api.importUserLogin(sapId, x, y, z);
  }).then( import_response => {
    CL_fireEvent(...);
    return import_response;
  });
}

Capis API Function: RemereLogin.setBrowserUser(browserUser)

Return type: Promise(Object).

Change the currently active user in the browser. This will perform a "logoutAll" to close all active login sessions. Then it will change the current User profile used to login to RPs. It does NOT call RemereLogin.connectLoginManagers.

This does NOT authenticate the user or connect to any LoginManagers. During authentication, the specified user's authentication prompt is displayed.

Capis API Function: RemereLogin.connectLoginManagers(browserUser)

Return type: Promise(Object).

Display the browser's popup dialog, asking the user to connect to any LoginManagers. The argument "browserUser" is optional. If it is not supplied, then the default_browser_user is used.

Function info: (parameter list, return value, etc.)
  • @param {string} browserUser; The current user that is logged into the browser.
  • @return {Promise(Object)} connectToLoma_response; The response object.
  • @property {boolean} response.isSuccess; If the function was a success.

Capis API Function: RemereLogin.disconnectLoginManagers(lomaIdList)

Return type: Promise(Object).
Function info: (parameter list, return value, etc.)
  • @param {Array} lomaIdList; The list of LoginManager IDs to disconnect.
    The lomaIdList can also be the special value "all".
  • @return {Promise(Object)} disconnectLomaList_response; The response object.
  • @property {boolean} response.isSuccess; If the function was a success.

Capis API Function: RemereLogin.acquireNewUserIdCertificate(UserId)

Return type: Promise(Object).

Get a new User Id Certificate, from the Identity Provider. This will probably require the user to re-prove themselves to the IdP. (re-enter their password, etc.)

Capis API Function: RemereLogin.getUserIdCertificate(UserId)

Return type: Promise(Object).

Get the cached User Id Certificate from the browser.

Capis API Function: RemereDirector.buildServiceRequest(biscProfileId, opId, callOptions, callerCfg, rpClientData)

Return type: Promise(Object). The user can quit or cancel the login.

This function is a small wrapper for LoginManager.createUserLoginProofForRp(). It exists to allow browser extensions a place to implement additional functionality before calling the "unmodifiable" LoginManager functions.

Function info: (parameter list, return value, etc.)
  • @param {string} biscProfileIdFull; The id of the BiscProfile. Example: "sg_1.remere_1"
  • @param {string} opId; The method (function name) for the service to perform. (Ex: "login", "setActiveCredentials", etc.)
  • @param {Object} callOptions; The configuration options for the RP service call.
  • @property {string} callOptions.redirectUri; The URI to redirect the user to after the opId.
  • @property {Object} callOptions.criteriaChangeSet; The changes to make to the UIC. Only used with opId "registerUserLogin", "setActiveCredentials"
  • @param {Object} callerCfg; The config values in the HTML page. (BiscGroups, etc.)
  • @property {string} callerCfg.sapIdBase; The Source Application identifier. Example: "login.example.com/1577836800"
  • @property {Object} callerCfg.rapId; The Requesting Application identifier. Example: "login.example.com"
  • @property {Object} callerCfg.biscProfile; The active BiscProfile.
  • @property {Object} callerCfg.pageConfig.rpEntityInfo; The PageConfig values RP entity information. (For UserLogin creation.)
  • @param {Object} rpClientData; The collected client data. {opId, challenge, ancPolicy, rpOrigin}
  • @property {string} rpClientData.opId; The operation id. Example: "login", "registerUserLogin"
  • @property {string} rpClientData.challenge; The RP nonce value. base64url encoded.
  • @property {string} rpClientData.ancPolicy; The ancestor policy. Example: "allowSOWA"
  • @property {string} rpClientData.rpOrigin; The origin of the RP. Example: "example.com"
  • @return {Promise(Object)} buildResponse.
  • @property {Object} response.requestData; The request that was built.
  • @object_example requestData = { JWA: {payload:"xxx", signatures:[{mm:"xx"}] } }

!!!!This function can show popup dialogs or redirect the user.!!!!

Internal steps:
Example implementation code.
// example implementation
function RLD_buildServiceRequest(biscProfileId, opId, callOptions, callerCfg, rpClientData) {
  let lipId;
  let lomaId;
  let biscProfile = callerCfg.biscProfile;
  // let pageConfig = callerCfg.pageConfig;
  // let biscProfile = CCI_getBiscProfileFromPageConfig(biscProfileId, pageConfig);
  let sapId = biscProfile.sapIdBase;
  let opId2 = opId; // One of "login", "setActiveCredentials", etc.
  let rapId = callerCfg.rapId;
  return Promise.resolve("yyy_response")
  .then( yyy_response => {
    if (opId == "login") {
      let filterOptions = {};
      filterOptions.stuff = "some_stuff";
      filterOptions.biscProfile = biscProfile;
      filterOptions.sapId = biscProfile.sapId;
      filterOptions.callOptions = callOptions;
      return this.selectUserLogin(filterOptions, rapId);
    } else { ... }
  }).then( selection_response => {
    lipId = selection_response.lipId;
    lomaId = selection_response.lomaId;
    let buildOptions = {};
    buildOptions.callOptions = callOptions;
    buildOptions.sapId = biscProfile.sapId;
    let loginManager_api = A2_getLoginManager(lomaId);
    return loginManager_api.createUserLoginProofForRp(lipId, opId, rpClientData, buildOptions);
  }).then( proof => {
    // check values
    let build_response = {};
    // build_response.requestData = proof;
    build_response.requestData = { JWS: proof.JWS};
    build_response.biscProfile = buildOptions.biscProfile;
    build_response.callOptions = callOptions;
    build_response.opId = opId;
    return build_response;
  });
}

Capis API Function: RemereDirector.sendRequestToService(svReqContext, requestData)

Return type: Promise(Object).

Sends the RML Request to the Remote Service.

Sends the requestData object to the RP endpoint. In whatever manner the RP designated in the Bisc Site Document.

Function info: (parameter list, return value, etc.)
  • @param {Object} svReqContext; The service request context. buildContext from buildServiceRequest.
  • @property {Object} svReqContext.biscProfile; The active BiscProfile.
  • @property {string} svReqContext.buildId; The unique identifier for the build.
  • @property {string} svReqContext.opId; The operation the service should perform. Ex: "login"
  • @property {Object} svReqContext.rpClientData; The collected client data. {opId, challenge, ancPolicy, rpOrigin}
  • @param {Object} requestData; The data to be sent to the RP service. Contains the "proof of identity", etc.
  • @return {Promise(Object)} svResponse; The response from the RP service.
  • @property {boolean} svResponse.statusOK; If the fetch was a success.
  • @property {Object} svResponse.jsonData; The data returned from the service.
  • @property {string} svResponse.url; The URL that was contacted by the request.
  • @property {Object} svResponse.fetchResponse; The wrapped fetch response object.
Example implementation code.
// example implementation
function sendRequestToService(svReqContext, requestData) {
  let transport_response = {};
  let opId = svReqContext.opId;
  let biscProfile = svReqContext.biscProfile;
  let pContents = biscProfile.pContents;
  let sapId = biscProfile.sapId;
  return Promise.resolve("yyy")
  .then( mmm_respose => {
    let buildValues = CLD_getBuildValues(svReqContext.buildId);
    let lipId = buildValues.lipId;
    let lomaId = buildValues.lomaId;
    // itemRecordDatabase.recordAction(lomaId, lipId, actionOptions);
    let active_endpoint = pContents.endpointList[0];
    let sUri = active_endpoint.sUri;
    // Note: Different implementations may split the requestData up into multiple parameters.
    let templateList = [{name:"capis_request", type:"json_object"}];
    let item_0 = Object.assign({}, templateList[0], {value: requestData});
    let dataParamList = [item_0];
    if (!(active_endpoint.method === undefined)) { active_endpoint.method = "POST"}
    let fetchInfo = {method:"GET", contentEncodingType: "JSON"};
    fetchInfo.uri = sUri;
    fetchInfo.queryParamList = dataParamList;
    return capisControl_api.sendRequestToService(svReqContext, fetchInfo);
  }).catch(error => {
    console.log("Error in sendRequestToService. error=" + error.message);
    return Promise.reject(error);
  });
}

Capis API Function: RemereDirector.evaluateServiceResponse(svReqContext, svResponse)

Return type: Object.

Evaluates the RML Response, sent to the browser in response to the RML Request.

Update the Remere Login Status at the RP, add the result to history. Calls the thisRemereDirector_api.updateLoginStatusValues function.

If the opId is "registerUserLogin" (or "setActiveCredentials"), this function call LoginManager.updateUserLoginWithServiceResult(lipId, svUlUpdate, rapId).

Function info: (parameter list, return value, etc.)
  • @param {Object} svReqContext; The service request context. Used to create the request to the RP service.
  • @property {Object} svReqContext.biscProfile; The active BiscProfile.
  • @property {Object