HSPC user identities, IAM, and existing systems.
Following 14th general meeting, the Platform team has agreed to unify user authentication with a common OAuth Identity Provider (IDP). This is a DRAFT document for team comment. Written in the present tense using RFC 2119 terms.
Field | Value |
---|---|
Code Name | HSPC-ID |
Curator | |
Status | Initial Draft |
Problem
HSPC user accounts have not historically been centrally managed, with individual services maintaining their own user database for which it was authoritative. While this is common for startup-phase organizations, it becomes immensely problematic during growth. Core symptoms of poor IAM include:
- Confusion and frustration with on-boarding of staff and members. (E.g. "Oh, to access service X, email Alice. For Y, email Bob.")
- Inconsistent access permissions for members of equivalent role. (E.g. Alice and Bob have different access permissions despite sharing the same job.)
- Inability to fully disable accounts. (E.g. Charlie ended membership last year but still has an active login.)
Additionally, sharing of resources inter-organizationally is not always achievable with manager-managed authorization. That is, HSPC MAY want to allow individual members to define who can/cannot access a service or resource directly, without going through formalized governance procedures with HSPC leadership for each resource instance. This is particularly important in health care scenarios involving patients' ability to define the 3rd parties users and systems able to access resources "owned" by said user.
Objectives
For HSPC to mature and grow, a centralized IAM system became necessary to:
- Establish an single sign-on (SSO) authority upon which all “Platform” systems, tools, and services may authenticate and authorize users.
- Allow HSPC staff to centrally manage member and non-member access to digital content in services in a role-based, manner.
- Provide a standards-based identity provider (IDP) for partners and cloud services to support HSPC member logins into 3rd-party systems.
- Enable integrated account self-service for administrative membership functions.
- Flexibly account for wide-ranging unknown future usage scenarios.
Solution
The HSPC ID (Identity) system allows HSPC members to create and use an HSPC-managed identity across both HSPC-managed services and partner-managed services configured to accept HSPC logins.
Business Qualities & Requirements
HSPC IDs SHALL be free and open for individuals to self-register, regardless of current or intended membership status. Manual approval of IDs by HSPC management SHALL NOT be required; however, email addresses MUST be verified prior to ID activation, as is acceptance of the HSPC Terms of Service agreement. A CAPTCHA SHOULD be used, as well. Usernames MUST be unique within the HSPC ID namespace. An active HSPC ID is required for:
- Membership self-management on the website.
- Access to digital downloads requiring RBAC.
- Logging into the freely available public FHIR Sandbox system.
- Marketing email list opt-in/opt-out management.
- Access to JIRA, Confluence and Atlassian tools.
- Usage of members-only tools and services such as the HSP Marketplace, Terminology Server and other .
All HSPC members and staff MUST have an HSPC ID to use any service requiring authentication. To allow for the plausibility of usernames being used for email purposes in be future, a blacklist of externally-used names SHOULD be maintained. (E.g. "platform@hspconsortium.org", "roadmap@hspconsortium.org" etc)
Functional Requirements
SHOULD allow for two-factor authentication in the future.
Non-Functional Requirements
- MUST be a "buy/license" product, as opposed to "build".
- SHOULD be available as a F/OSS license
- Technology
In terms of software and infrastructure, HSPC ID is an instance of Gluu Server Open Source
Implications
e
Identity Provider
To avoid confusion and use correct semantics, the HSPC IDP "issuer" and URI/URL SHALL be: https://id.hspconsortium.org . This cannot be trivially changed, and SHOULD be treated as a permanent, immutable decision. OAuth "subject" identifiers similarly need to be treated as immutable.
Identity Issuance Requirements
During registration, users:
- MUST provide a first name, last name, email, and username.
- MUST complete an email verification step.
- MUST NOT choose a blacklisted username to avoid potential conflicts with local system accounts and reserved words.
- SHOULD provide additional contact information.
- SHOULD use an email registered with a Gravatar profile.
@hspconsortium.org email namespace
Initial Consolidation Plan
- Either set up a new common IDP or use one of the existing instances.
- Migrate HSPC Sandbox to the new IDP.
- Reconfigure the WEBSITE to use the IDP in additional to local authentication.
- Install membership management
- eee
All existing members will have accounts created.