Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,14 @@ GUARD_ARGS=--ssl-insecure -v

### Authentication

By default MISP shows its builtin email/password login form alongside any external provider. To disable the form and enforce external authentication, set:

```bash
AUTH_ENFORCED=true
```

This maps to MISP's `Security.auth_enforced` setting and applies to any configured external provider (OIDC/LDAP/AAD/CustomAuth).

#### LDAP Authentication

You can configure LDAP authentication in MISP using 2 methods:
Expand Down Expand Up @@ -274,6 +282,27 @@ Valid options for `OIDC_AUTH_METHOD` are:
- `client_secret_jwt`: _not tested_
- `private_key_jwt`: _not tested_

#### AAD (Entra) Authentication

AAD (Azure AD / Microsoft Entra) authentication is implemented through the MISP AaAAuth plugin. See upstream plugin docs for the full [Entra app registration walkthrough](https://github.com/MISP/MISP/blob/2.4/app/Plugin/AadAuth/README.md).

```bash
AAD_ENABLE=true
AAD_CLIENT_ID="<application (client) ID>"
AAD_TENANT_ID="<directory (tenant) ID>"
AAD_CLIENT_SECRET="<client secret>"
AAD_REDIRECT_URI="https://misp.mydomain.com/users/login" # (same value in Azure AD)
AAD_PROVIDER="https://login.microsoftonline.com/"
AAD_PROVIDER_USER="https://graph.microsoft.com/"
# Entra group names mapped to MISP roles
AAD_MISP_USER="Misp Users"
AAD_MISP_ORGADMIN="Misp Org Admins"
AAD_MISP_SITEADMIN="Misp Site Admins"
AAD_CHECK_GROUPS=false
```

> Unlike OIDC/LDAP, AAD currently has no per-plugin auth toggle. For AAD only login combine the above with `AUTH_ENFORCED=true` (see above).

#### CustomAuth

You can add authentication using the `Plugin.CustomAuth` plugin as described here https://www.circl.lu/doc/misp/appendices/#appendix-a-external-authentication. It will use a user provided http header to authenticate the user. This is useful where MISP runs behind an authenticating reverse proxy server.
Expand Down
1 change: 1 addition & 0 deletions core/files/entrypoint.sh
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ export GPG_PASSPHRASE=${GPG_PASSPHRASE:-passphrase}
export MISP_MODULES_FQDN=${MISP_MODULES_FQDN:-http://misp-modules}
export ATTACHMENTS_DIR=${ATTACHMENTS_DIR:-/var/www/MISP/app/files}

export AUTH_ENFORCED=${AUTH_ENFORCED:-false}
export AUTOCONF_GPG=${AUTOCONF_GPG:-true}
export AUTOGEN_ADMIN_KEY=${AUTOGEN_ADMIN_KEY:-${AUTOCONF_ADMIN_KEY:-true}}
export OIDC_ENABLE=${OIDC_ENABLE:-false}
Expand Down
3 changes: 3 additions & 0 deletions core/files/etc/misp-docker/initialisation.envars.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,8 @@
"default_value": "${SALT}",
"command_args": "-f",
"blank_protection": true
},
"Security.auth_enforced": {
"default_value": "${AUTH_ENFORCED}"
}
}
1 change: 1 addition & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,7 @@ services:
- "DISABLE_IPV6=${DISABLE_IPV6}"
- "DISABLE_SSL_REDIRECT=${DISABLE_SSL_REDIRECT}"
- "ENABLE_DB_SETTINGS=${ENABLE_DB_SETTINGS}"
- "AUTH_ENFORCED=${AUTH_ENFORCED}"
- "ENABLE_BACKGROUND_UPDATES=${ENABLE_BACKGROUND_UPDATES}"
- "ENCRYPTION_KEY=${ENCRYPTION_KEY}"
- "SALT=${SALT}"
Expand Down
6 changes: 6 additions & 0 deletions template.env
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,11 @@ SYNCSERVERS_1_PULL_RULES=
# Disable CA refresh
# DISABLE_CA_REFRESH=true

# Enforce external authentication, disabling the builtin login form.
# Applies to any external provider (OIDC/LDAP/AAD/CustomAuth)
# WARNING: enable only after the external method is verified working, else you'll need to disable via the cli (cake)
# AUTH_ENFORCED=true

# Enable OIDC authentication, according to https://github.com/MISP/MISP/blob/2.5/app/Plugin/OidcAuth/README.md
# OIDC_ENABLE=true
# OIDC_PROVIDER_URL=
Expand Down Expand Up @@ -250,6 +255,7 @@ SYNCSERVERS_1_PULL_RULES=
# LDAPAUTH_LDAPTLSPROTOCOLMIN="LDAP_OPT_X_TLS_PROTOCOL_TLS1_2"

# Enable Azure AD (Entra) authentication, according to https://github.com/MISP/MISP/blob/2.4/app/Plugin/AadAuth/README.md
# Note: AAD has no per plugin mixedAuth toggle. For AAD-only login set AUTH_ENFORCED=true
# AAD_ENABLE=true
# AAD_CLIENT_ID=
# AAD_TENANT_ID=
Expand Down