...

...

...

...

...

...

...

...

IDSYS documents are JSON-formatted objects and are specific to the back-end identity management system: Active Directory, LDAP, and Linux PAM.

...

Common IDSYS Fields

Below are the common fields within all IDSYS documents. Fields specific to the back-end identity management system are broken out into separate sections.

¹ For details regarding token-based authentication, see see Token-Based Authentication.

When a user authenticates to the Gateway using HTTP Basic authentication (not token-based authentication and not S3 HMAC), the user's password is stored in the normal field for LDAP or PAM and it may be hashed in whatever formats are supported by the system. For LDAP, this field is normally userPassword; for PAM with the traditional Unix authentication mechanism, it is the second field in the /etc/shadow file.

LDAP and AD Examples

These are examples of IDSYS documents for LDAP and Active Directory. They contain fields specific to LDAP as well as fields common to all IDSYS documents.

...

{"ldap": {
    "name": "idsys-ad",
    "description": "Active Directory example configuration",
​
    "protocol" : "ldaps",
    "ldaphost": "ad.mycompany.com",
    "ldapport": "636",
​
    "adminDN": "cn=BINDUSER,ou=Applications,dc=mycompany,dc=com",
    "adminPassword": "BINDPASSWORD",
​
    "userBase":  "ou=Users,dc=mycompany,dc=com",
    "groupBase": "ou=Groups,dc=mycompany,dc=com",
​
    "uidAttribute":"sAMAccountName",
    "userFilter":"objectclass=*",
    "groupMemberDNAttr": "member",
​
    "cookieName": "token",
    "tokenPath": "/.TOKEN/",
    "tokenAdmin" : "caringoadmin@"
} }

LDAP and AD Fields

These are the fields within the IDSYS document specific to the LDAP or Active Directory back-end identity management system.

¹ The groupMemberUidAttr and groupMemberDNAttr parameters are mutually exclusive and one must be defined in IDSYS.

...

PAM Example

There are no fields within the IDSYS document specific to the PAM back-end identity management system. Follow this process to implement identity management if using PAM:

1. Because the root user (uid=0) on this Content Gateway server cannot be used to authenticate to the Gateway, create another user (such as superuser@admindomain.example.com) on this server for this purpose. 

2. Copy and paste this example into the IDSYS document: /etc/caringo/cloudscaler/idsys.json.

   Code Block
   language xml
   {"pam": { "name" : "idsys-pam", "description": "PAM identity management configuration", "cookieName": "token", "tokenPath": "/.TOKEN/", "tokenAdmin": "superuser@admindomain.example.com" } }

3. Update the tokenAdmin to match the authentication user.

Modifying IDSYS

The root IDSYS configuration is stored in the idsys.json file on the Gateway server's disk so it is always available and an administrator can always modify it. This prevents locking oneself out of the storage cluster. Changes to the local file take effect without the need to restart the Gateway.

See Defined ETC Documents for modifying a tenant or storage domain's sub-resource through the management API.

See See SCSP Context Sub-resources for details on modifying a storage domain's sub-resource through the storage API.

The entire JSON document with all fields must be provided in the update request, even if one field is being modified when updating an IDSYS sub-resource through the management API or the storage API.

IDSYS Precedence Model

The identity system is described by IDSYS documents can exist at the root, tenant, and storage domain within the system. The lowest level overrides the higher levels when IDSYS documents exist at multiple levels in the hierarchy. It inherits from a higher level when a lower level lacks an IDSYS.

...

The IDSYS inheritance also works at the field level. Tenant and storage domain IDSYS documents can choose to override specific fields. The value is inherited by the tenant and domain levels if tokenAdmin is defined in the Root IDSYS and not in the tenant or domain IDSYS. The Root IDSYS may define the LDAP adminDN and adminPassword and allows the tenant and domain IDSYS documents to override the userBase and groupBase values.

Single Company

• In this scenario, the company has one identity management system, there is one tenant per business unit, and each business unit has one or more storage domains. This scenario is likely with a private cloud serving a single company. The configuration in this scenario is the Root IDSYS defining the configuration of the identity management system and there are no IDSYS definitions for the tenants and storage domains. Therefore, the tenants and storage domains inherit from the Root IDSYS using a single source of users and groups.

Service Provider/Distributed Company

• In this scenario, a storage MSP, or a large company with business units each with separate identity management systems and multiple user/group sources. The configuration in this scenario is the Root IDSYS defining the cluster administrator users and groups and the Tenant IDSYS documents defining the users and groups for each client or business unit. The storage domains do not define an IDSYS so they inherit the definition from the tenant and share the users and groups with the other storage domains owned by the tenant.

Service Provider with Resellers

• This is an extension of the previous scenario except each tenant can be a reseller offering storage domains to separate, unrelated companies. In this case, each storage domain defined an IDSYS that overrides the Tenant IDSYS allowing a different set of users and groups for each storage domain. This scenario is not mutually exclusive with the previous one: a hybrid of the two is possible where some domains override the IDSYS of the tenant, and others do not.

Qualifying User and Group Names

It may be required to fully qualify the user and group principal names to verify correct policy resolution. In access control policies and x-owner-meta headers, a "fully qualified" principal has a tenant name or storage domain appended directly to the name:

The name in the policies may remain unqualified (no @domain or +tenant suffix on principal names) if a principal (user/group) authenticates from the same IDSYS as the resource they are accessing. 

Gateway uses the default assignment of the x-owner-meta header value to fully qualify the principal (such as user@domain or user+tenant) if a principal authenticates from a different IDSYS from the one used by the resource. Applications can also assign object ownership across domains, where the IDSYS of the storage domain differs from the user from another domain. There is no limit on the number of cross-domain relationships that exist, but all must be within the same Swarm cluster.

Tokens — Tokens: Tokens are bound to the IDSYS of the context both where and when they are created. The token has to take the root scope if creating a tenant-level token but the tenant does not have an IDSYS. All requests using this token authenticate using the root IDSYS (and likely fail, not finding the user there), even if a correct tenant-level IDSYS is added later. The token must ignore any domain-level IDSYS, current or future if creating a tenant-level token with a tenant IDSYS. Either create a tenant-level IDSYS and use inherit at the domain-level or create tokens at the domain-level if domain-level controls over tokens is desired.