Security
Harmonix on AWS is built on the Backstage open source project and, thus, inherits the security considerations applicable to the platform.
The sections below capture details about the Harmonix on AWS reference implementation to help you understand the out-of-the-box implementations related to security. Many of the configurations can easily be changed to meet your specific access control needs.
It is strongly recommended that you read the Backstage Threat Model documentation to familiarize yourself with the trust model and integrator responsibilities to secure access.
Authentication
The Backstage Authentication system provides for sign-in and identification of users. The Harmonix on AWS reference implementation is pre-configured to use Okta as an authentication provider. This demonstrates one type of authentication provider; however, it can easily be changed to other common identity providers such as Active Directory and other OAuth 2 supported providers.
Multiple providers are supported by Backstage. For the complete list, consult the Backstage "Included providers" documentation
Organizational data
Backstage provides support to map organizational data such as users and groups into entities in the Backstage catalog. The Harmonix on AWS reference implementation is pre-configured to use the OktaOrgEntityProvider
from the catalog-backend-module-okta plugin from Roadie. This plugin will read Okta Users and Groups from a configured Okta instance and create entities in the catalog. Once they are populated in the catalog, user and group entities can be used for creating relationships (e.g. "ownedBy") with other entities. User and Group entities can also be used in the Backstage permission framework to enforce allow/deny policy decisions.
Alternatives for organizational data ingestion can be configured for OpenLDAP, GitHub, GitLab, and more. Consult the Backstage Integrations documentation and Backstage plugin directory for additional options and details.
AWS Security
Introduction
While there are different methodologies when it comes to security in the cloud, we adopted some of the approaches we have seen at our financial customers. These include:
- Segregation of access controls
- Use of temporary credentials
- Separation of duties and the least privileges principle
- Use of different AWS accounts to ensure default restrictions
- Separation of production/staging environments from development/sandbox environments
The above principles are not a replacement for organization-level preventive and detective controls. It is recommended to use services like AWS Control Tower and Service Control Policies (SCPs) to have multiple layers of security from the developer platform throughout the organization governance and controls.
Environments and access to AWS services
We define an environment as a "place" in AWS. Granting access to an environment will allow a user or process to gain access only to the resources of that environment, but not to other environments.
Definition of AWS Environment Provider:
- Include all of the supporting software artifacts to run a particular type of workload (Container-based, Serverless, AI/ML etc..).
- Must reside within an AWS Account and a region.
- Must provide at least two roles to gain access to the environment resources: a Provisioning role and an Operations role.
- Mutually exclusive by design - One provider cannot access resources from another provider, even if they are configured to use the same AWS account and region.
There are several methods for a user to gain access to an environment:
- Indirect access - throughout the developer platform and pipeline, a developer can perform actions on an allowed target environment. The platform/pipeline will assume the target environment roles and get temporary credentials to perform the actions on behalf of the user.
- Direct access - a user can assume credentials directly to the target environment access roles (Provisioning roles, operations role)
- Resource specific access - a user can assume access to a particular shared resource by the environment, such as: kubectl
Environment provider authors can reason about the required set of permissions for provisioning and operating applications for this environment. Harmonix on AWS provides sample templates for Amazon ECS, Amazon EKS, and Serverless environment providers.
Diving deep to access roles trust policy
As described above, Harmonix on AWS provides a pattern of assuming access to particular AWS environments. Out of the box, when provisioning a new environment provider, the provisioning role and operations role are created and their trust policy is modified to enable the platform role and pipeline role respectively.
example of: commercial-us-commercial-dev-provisioning-role - Assumed by gitlab pipeline role
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"AWS": "arn:aws:iam::123456789012:role/opa-platform-GitlabRunnerConstructGitlabRunnerIamR"
},
"Action": "sts:AssumeRole"
}
]
}
example of: commercial-us-commercial-dev-operations-role - Assumed by the platform role
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"AWS": "arn:aws:iam::123456789012:role/backstage-master-role"
},
"Action": "sts:AssumeRole"
}
]
}
You can also configure these roles with federation to grant access to your users based on their membership in certain group that is set up for your identity provider. This can be done with SAML or WebIdentity - for more information, read here.