9.9 KiB
Cisco FT SecureX Simplified Registration
- Functional Spec
- Technical Plan
- tags
- Auth
- source
- https://github.com/advthreat/response/issues/821
- dashboard
- https://github.com/advthreat/iroh/projects/32
Functional Spec
Response issues:
Figma: https://www.figma.com/file/Bz3m25kpWXpdct7AnhmNsW/SXSO-Registeration?node-id=759%3A5926
Technical Plan
Support private email vs public emails
DONE
Estimate: 1 release cycles after the list is provided.
The solution is to use a blacklist of domains where any user could create multiple email accounts pseudo-anonymously.
Details: https://github.com/advthreat/response/issues/979
CANCELED Support allow-list exceptions for some Cisco user.
- State "CANCELED" from "HOLD" [2022-01-17 Mon 10:57]
This only concern new account creation. User with gmail account could still login.
Estimate: 1 release cycles after the list is provided.
Typically we should allow some users with an email like some-user+XXX@gmail.com
Support, search admin with same email domain
Estimate: 1 release cycle. Note: Work in progress
We should be able given an email from a user, to find all the orgs for which at least one of its admin has a matching domain name.
- Most efficient: add an invisible field
email-domain
to all users. This should be lower-case, and we will need a migration. Doing this we could have a faster match than using string related queries.
Problems, users can login in the same user, with the same public email with different emails. This should be rare.
- Search via text match.
The algorithm should look a bit like:
;; only when this is an unknown user
;; so a single approval will prevent the user to see this page.
(let [user-email ,,,
domain (string/replace user-email #".*@" "")
users (matching-admins domain) ;; returns a potentially big list of admin users
indexed-orgs (group-by :org-id users)]
(vals indexed-orgs))
Once this list of orgs is found. We should also check the list of pending or rejected OrgAccessRequest for this user in order to prevent the user to request access multiple time.
Support Org request to admins
Estimate: 4 release cycles
We need to create another Entity for access request to an Org.
(s/defschema OrgAccessRequest
(st/merge
{:id UUID
:idp-mapping IdPMapping
:user-email s/Str
:org-id s/Str
:status (s/enum :pending :accepted :rejected)
:created-at DateTime}
(st/optional-keys
{:user-name s/Str
:user-nick s/Str
:approver-id UserId
:approver-email UserEmail ;; email of the approver
:updated-at DateTime
})))
When a user request access to an organization. We should create this object in DB.
New UI Sync
Estimate: 5 release cycles
We should find a way to hand the UI work to the UI team. Right now, the page are all generated in IROH.
To reach that ideally we should sync the source code as a jar in IROH.
In order to give the UI the ability to make a front-end application, we should create news APIS that support a new UserIdentity-level JWT
New Auth APIs
Continue to use the /code
route of iroh-auth.
But instead of returning a Session Token, it will return a UserIdentity Token.
This is a JWT with the important data from the IdP:
- idp-id
- user-identity-id
- user-email
- etc…
When the user is redirected to an HTML generated page, we should add the
code
in the anchor parameter of the route so the UI will be able to use
that code to retrieve a UserIdentity Token.
New API JWT middleware
Estimate: 1 release cycle
We need to change the configuration of the check JWT middleware to support UserIdentity Token instead. And use this configuration for this new API.
The user-identity-jwt
should contain enough data to retrieve:
idp-mapping
user-email
- all other metas, as user-name, user-nick, etc…
New IROH-Auth API
Estimate: 3 release cycle
This new API should only work with UserIdentity JWT.
POST /iroh/registration/org-access/:org-id ;; request access to a matching org
POST /iroh/registration/hide-org/:org-id ;; ability to hide an org-access
GET /iroh/registration/matching-accounts ;; list all the matching accounts
GET /iroh/registration/matching-orgs ;; list all the matching orgs
GET /iroh/registration/pending-invites ;; list all the pending invites
GET /iroh/registration/registration-view ;; helper to make a single http call
Request Org Access
POST /iroh/registration/org-access/:org-id ;; request access to a matching org
POST /iroh/registration/org-access/:org-id
Accept: application/json
Content-Type: application/json
User-Agent: ob-http
Authorization: Bearer ${user-identity-jwt}
With this, and if every check matches:
- There is a known active admin of this org with an email with the same domain name
- The org is active
We should:
- create a new
OrgAccessRequest
object in DB. - Send emails (see next section)
Hide Org
POST /iroh/registration/hide-org/:org-id
Accept: application/json
Content-Type: application/json
User-Agent: ob-http
Authorization: Bearer ${user-identity-jwt}
Should save in the user identity store a new org-id to hide. This impacts the call to `matching-orgs` such that orgs marked as hidden should not be displayed when calling the `matching-org` route.
List Matching Accounts
GET /iroh/registration/matching-accounts
Accept: application/json
Content-Type: application/json
User-Agent: ob-http
Authorization: Bearer ${user-identity-jwt}
It should return a list of object with the following schema sorted by last logged in time by the user:
{:user User
:org Org
:last-login-date DateTime
:relative-last-login s/Str
:org-created-at DateTime
:relative-org-created-at s/Str
:activated? s/Bool
:org-nb-users s/Int}
List Matching Orgs
GET /iroh/registration/matching-orgs
Should return a list of objects with the following schema (sort to be defined):
{:org Org
:org-nb-users s/Int}
List Pending Invites
GET /iroh/registration/pending-invites
Here is an example value:
{:role "admin",
:org-id "org-1",
:expires-in-nb-days 7,
:status "pending",
:invitee-email "chuck@example.org",
:inviter-user-id "org-1-admin-1"}
Registration View
GET /iroh/registration/registration-view
Should return the same result as the union of the calls to
matching-accounts
, matching-orgs
and pending-invites
.
{:matching-accounts [,,,]
:matching-orgs [,,,]
:pending-invites [,,,]}
New IROH Auth Store UserIdentity
We should keep track of some user identity state in a new user-identity store. The store should contain values similar to the one in the user-identity JWT. And also some state like the list of matching orgs to hide. This will probably be a good place to put any kind of state for the UI.
Email Notification of Org Request Accesses
Estimate: 4 release cycle after email+html templates
- List all the admins of the requested org.
2.a. If there is fewer admins than a number that could be configured in the node configuration. Then we send an email to all admins. 2.b. If there are more admins than this specific number, then we randomly chose this maximal number of admins and send them an email notification.
TODO Have an email template (both HTML and Text)
Notes
Need to be able to trigger a new request to join after 7 days.
Org Requests CRUD API for Admins of the Orgs
Estimate: 3 release cycle after mail templates + text
There should be a CRUD API restricted to the admin/user-mgmt/org-requests
scope:
GET /iroh/user-mgmt/org-requests
list pending org access requestsGET /iroh/user-mgmt/org-requests/<id>
read a single org access requestPOST /iroh/user-mgmt/org-requests/<id>/accept
Grant the accessPOST /iroh/user-mgmt/org-requests/<id>/reject
Reject the access
List
GET /iroh/user-mgmt/org-requests
If no parameter is provided, only list pending OrgAccessRequests
of the org
of the caller.
Otherwise we could pass the query-parameter status
with the following
value(s):
pending
accepted
rejected
Note we should probably support duplicate statuses. Ex:
GET /iroh/user-mgmt/org-requests?status=accepted&status=pending
Read
GET /iroh/user-mgmt/org-requests/org-request-id
Should returns a 404 if not found or the single Org Access Request object.
Accept the Org Access
POST /iroh/user-mgmt/org-requests/<id>/accept
Grant the access
The body should contain the role (either admin
or user
) with the following schema:
{"role":"admin"}
During the call, should:
- Create a new user with:
{:user-id (gen-uuid)
:org-id (:org-id org-access-request)
:user-email (:user-email org-access-request)
:idp-mappings [(:idp-mapping org-access-request)]
:user-name (:user-name org-access-request)
:user-nick (:user-nick org-access-request)
:role (get-in request [:body :role])
:enabled? true
}
- Send an email to user confirming his access was granted.
TODO have an email template + text.
Reject the Org Access
POST /iroh/user-mgmt/org-requests/<id>/reject
Reject the access
This call should update the OrgAccessRequest
object by patching with:
{:udpated-at (now)
:approver-id (get-in req [:identity :user :id])
:approver-email (get-in req [:identity :user :email])
:status :rejected}
Then send an email to user confirming his access was denied.
TODO have an email template + text.