README

This is part of HEPTACOM solutions for medium and large enterprise

Shopware plugin to allow external login provider in the administration

This Shopware 6 plugin allows to add "Login with" functionality into the Shopware administration login page and password confirmation dialogs.

Features

login to Shopware 6 administration using an external identity provider (IDP)
various providers already preconfigured - Microsoft, Google, Okta, Keycloak, ...
support for third-party IDPs supporting OpenID Connect
- easy setup using the provider's metadata document (.well-known/openid-configuration)
support for third-party IDPs supporting SAML2
- easy setup using the provider's metadata xml
promote users automatically to administrators
set roles and permissions based on rules
disable the password login and automatically redirect users to the identity provider

Security

The login to the Shopware administration is a critical part. Security vulnerabilities in this part allow attackers access to the whole shop.

Therefore, we check our plugin critically for potential risks before merging pull requests.

In addition, our OpenId Connect implementation also checks the signature of JWT tokens, whenever possible. When using a pre-configured OpenID Connect provider or when providing a OIDC metadata document, the JWKS keys are automatically fetched from the IDP.

Supported providers

We support a variety of identity providers out of the box. If your identity provider is not listed below but offers OpenID Connect support, you can configure it manually using the OpenID Connect provider. In any other case feel free to create a pull request.

Provider	supports language sync	supports timezone sync	supports role assignment by roles/groups	more info
Atlassian Jira	❌	✅	❌	Read more here.
cidaas	❌	❌	⚠️	Read more here.
Google Cloud	✅	❌	⚠️	Read more here.
JumpCloud	depends on configuration	depends on configuration	✅	Read more here.
Keycloack	✅	depends on configuration	⚠️	Read more here.
Microsoft Entra ID	❌	❌	✅	Read more here.
Okta	✅	✅	⚠️	Read more here.
OneLogin	✅	❌	⚠️	Read more here.
OpenID Connect	depends on configuration	depends on configuration	⚠️	Try any OpenID Connect provider, that we did not explicitly prepare an optimized configuration for.
SAML2	depends on configuration	depends on configuration	✅	Try any SAML2 provider, that we did not explicitly prepare an optimized configuration for.

⚠️ supported using authorized request rule

SAML2 - Technical requirements

In case you want to use a SAML2 provider, your IdP must meet the following requirements:

include AuthnRequest in the SAML response
sign the returned assertions
support HTTP-POST binding for the Assertion Consumer Service (ACS)
return the user's email address as attribute (all other attributes are optional)

OpenID Connect - Authenticated request rule

When using an OpenID Connect based provider, you can assign roles that depend on an authenticated GET request, done with the user's access token. This way you can get any further information from the IDP, that is relevant for your specific case. For some providers a preset for retrieving the user's groups is already available.

In case you want to create more complex rules, you can build your own queries within the rule builder. The queries get the JSON, returned by the specified endpoint, as input.

Authenticated request

Your specified endpoint will be called as follows:

GET https://my-company.idp.com/api/groups
Authorization: Bearer <access_token>
Accept: application/json

The request must be encrypted (HTTPS) and will timeout after 5 seconds. In case of a timeout or a none successful response code, the condition will be evaluated as false.

In case you have multiple conditions, depending on the same endpoint, the request will only be done once. The response is cached in memory for the duration of the rule evaluation.

Processing the response

You can then use a JMESPath query to validate if the input JSON matches your rule.

It is recommended that your query results in a boolean. In case it results in a different type, the condition will be validated as follows:

Output type	Output value	Validation result
`boolean`	`true`	`true`
`boolean`	`false`	`false`
`string`	empty	`false`
`string`	non-empty	`true`
`number`	`0`	`false`
`number`	`1` (or grater)	`true`
`array`	empty	`false`
`array`	non-empty	`true`
`object`	empty	`false`
`object`	non-empty	`true`
`null`	`null`	`false`

Pagination

In case of larger responses, you might need to paginate through the results. When using an OData compatible endpoint, you can use the "Authenticated OData request" instead. If the validation result on the current result page is false, the next page will be automatically requested.

OpenID Connect - ID Token rule

Most OpenID Connect based providers issue an identity token while authentication. Depending on your use-case, this token might contain data that is relevant for the permission assignment.

You can use the ID Token for rules by running a JMESPath query on the payload. For details on the JMESPath query evaluation, see the authenticated request rule documentation.

Adding your own rule actions

In most scenarios you only need to assign roles based on rules. However, for some use cases you might want to add your own actions. As a plugin developer you can simply add your own rule actions. The rules will evaluate while the login process synchronously and the appropriate action will be executed.

Adding a new rule action

To add a new rule action, you need to create a service that implements RuleActionInterface. The service must be tagged with heptacom_open_auth.rule_action.

Thereafter, your action should already be visible in the client configuration.

Service

<?php

namespace Heptacom\MyCustomPlugin\HeptacomOpenAuth;

use Heptacom\AdminOpenAuth\Contract\OAuthRuleScope;
use Heptacom\AdminOpenAuth\Contract\RuleActionInterface;
use Heptacom\AdminOpenAuth\Database\ClientRuleEntity;

class CustomRuleAction implements RuleActionInterface
{
    public static function getName(): string
    {
        return 'heptacom_my_custom_action';
    }
    
    public function getActionConfigurationComponent(): string
    {
        return 'heptacom-my-custom-action-config';
    }
    
    public function preResolveUser(ClientRuleEntity $rule, OAuthRuleScope $ruleScope): void {
        // your business logic here
    }
    
    public function postResolveUser(ClientRuleEntity $rule, OAuthRuleScope $ruleScope): void {
        // your business logic here
    }
}

Administration Snippet

{
    "heptacom-admin-open-auth-client": {
        "actions": {
            "heptacom_my_custom_action": {
                "label": "My custom action"
            }
        }
    }
}

Adding a configurable action to the administration

Now we can already see our action in the client configuration. Although we can already add rules, we are not able to configure what action should be executed if a rule matches. To do so, we need to add a new component to the administration.

The component receives the client and the current configuration as props.

In the following example we will simply set a configurable text.

import template from './heptacom-my-custom-action-config.html.twig';

export default {
    template,

    props: {
        client: {
            type: Object,
            required: true,
        },
        actionConfig: {
            type: Object,
            required: true,
        },
    }
}

<sw-text-field
    v-model:value="actionConfig.myText"
    label="Enter a text"
    required
></sw-text-field>

Adding the business logic for an action

Now, that your action is configurable, you need to define what should happen if the rule matches. To do so, you need to implement the execute method of your action.

For this example we will only log the configured text.

<?php

namespace Heptacom\MyCustomPlugin\HeptacomOpenAuth;

use Heptacom\AdminOpenAuth\Contract\RuleActionInterface;
use Heptacom\AdminOpenAuth\Contract\OAuthRuleScope;
use Heptacom\AdminOpenAuth\Database\ClientRuleEntity;
use Psr\Log\LoggerInterface;

class CustomRuleAction implements RuleActionInterface
{
    public function __construct(
        private readonly LoggerInterface $logger
    ) {
    }
    
    // ...
    
    public function preResolveUser(ClientRuleEntity $rule, OAuthRuleScope $ruleScope): void {
        $this->logger->info(sprintf(
            'My custom action (preResolveUser) was executed with text: %s',
            $rule->getActionConfig()['myText']
        ));
    }
    
    public function postResolveUser(ClientRuleEntity $rule, OAuthRuleScope $ruleScope): void {
        $this->logger->info(sprintf(
            'My custom action (postResolveUser) was executed with text: %s',
            $rule->getActionConfig()['myText']
        ));
    }
}

Changes

View the CHANGELOG file attached to this project.

Contributing

Thank you for considering contributing to this package! Be sure to sign the CLA after creating the pull request.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 or see the local copy.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Trademarks and Logos

All logos, available in this project are protected under copyright. Most of them also are registered trademarks. Therefore, the usage is only permitted when corresponding trademark/branding guidelines are fulfilled. You can find an archived link to these guidelines below.

Atlassian Jira

cidaas

https://www.cidaas.com/branding/

Google

Keycloak

Microsoft Entra ID

https://learn.microsoft.com/de-de/entra/identity-platform/howto-add-branding-in-apps

Okta

https://www.okta.com/terms-of-use-for-okta-content/

OneLogin

The One Identity logo is a registered trademark of One Identity, Inc.

https://www.oneidentity.com/docs/one-identity-trademark-usage-guidelines-legal-142035.pdf

heptacom / shopware-platform-admin-open-auth

Maintainers

Details