Compare commits
86 Commits
v1.2.2
...
v1.4.0-alp
Author | SHA1 | Date | |
---|---|---|---|
|
ee21f051fb | ||
|
6cc17abf2c | ||
|
a7b5accd75 | ||
|
6bb0c93f57 | ||
|
9abdcc15ba | ||
|
eb903bf226 | ||
|
1cbb0a135b | ||
|
1587103c0a | ||
|
838d79ae15 | ||
|
96c47ecf76 | ||
|
c5cea933a4 | ||
|
57c7e4a91d | ||
|
1dce59a02e | ||
|
de840b9d00 | ||
|
53c85d2248 | ||
|
254dc5684f | ||
|
de92e98f7d | ||
|
d5f9137056 | ||
|
1307e3aa43 | ||
|
dfedde0df6 | ||
|
93bd7354c2 | ||
|
c302789898 | ||
|
96155c1876 | ||
|
95ee328281 | ||
|
72a1794cc3 | ||
|
37ddd0e588 | ||
|
4d63bba251 | ||
|
aadfae2965 | ||
|
2f7e5e4025 | ||
|
77dc75d383 | ||
|
f3b528d1ba | ||
|
91e5e08e70 | ||
|
acd8c7d7c5 | ||
|
249cc0ea92 | ||
|
99697d7c75 | ||
|
e133e120d7 | ||
|
e39d6bfa10 | ||
|
217bc423ed | ||
|
8f0654c34e | ||
|
8afdb3ed83 | ||
|
bd4ccbc5e5 | ||
|
6d1c6ed109 | ||
|
1619f5311c | ||
|
6fa36ea092 | ||
|
471e06536b | ||
|
3a6b75996c | ||
|
566e4f3137 | ||
|
a4c18dee5d | ||
|
8d6850d346 | ||
|
67bc18af7d | ||
|
5c660fdcaf | ||
|
fbbafeb769 | ||
|
559f6a7401 | ||
|
3bebb33147 | ||
|
3e240fe34d | ||
|
635f6fdbe7 | ||
|
4237eeb3b6 | ||
|
a0e91e7896 | ||
|
aab0b86646 | ||
|
3e22301af7 | ||
|
2b202323c0 | ||
|
4ec05f518e | ||
|
6da68298b0 | ||
|
aecaafdeca | ||
|
d885932f45 | ||
|
c689a3f161 | ||
|
7805112548 | ||
|
3e89f0bc5e | ||
|
c6b8f7d48e | ||
|
83377ebee0 | ||
|
2aa6e4d142 | ||
|
82a1a3df68 | ||
|
7ec11ba8cf | ||
|
9317c11434 | ||
|
b257a0275f | ||
|
2aaa04062f | ||
|
54c3014568 | ||
|
c3ca73f576 | ||
|
4185b644b7 | ||
|
ace5918342 | ||
|
7ad985fead | ||
|
6a376db322 | ||
|
950f7c931c | ||
|
d160a44509 | ||
|
05493da27c | ||
|
df44428a85 |
1
.gitignore
vendored
1
.gitignore
vendored
@@ -7,6 +7,7 @@ out/
|
||||
.idea/
|
||||
|
||||
# Local dev config
|
||||
/mxisd.yaml
|
||||
/application.yaml
|
||||
|
||||
# Local dev storage
|
||||
|
@@ -14,4 +14,5 @@ ENV SQLITE_DATABASE_PATH="/var/mxisd/mxisd.db"
|
||||
CMD [ "/start.sh" ]
|
||||
|
||||
ADD src/docker/start.sh /start.sh
|
||||
ADD build/libs/mxisd.jar /mxisd.jar
|
||||
ADD src/script/mxisd /app/mxisd
|
||||
ADD build/libs/mxisd.jar /app/mxisd.jar
|
||||
|
27
README.md
27
README.md
@@ -8,18 +8,20 @@ mxisd - Federated Matrix Identity Server
|
||||
- [Getting Started](#getting-started)
|
||||
- [Support](#support)
|
||||
- [Contribute](#contribute)
|
||||
- [Powered by mxisd](#powered-by-mxisd)
|
||||
- [FAQ](#faq)
|
||||
- [Contact](#contact)
|
||||
|
||||
# Overview
|
||||
mxisd is a Federated Matrix Identity server for self-hosted Matrix infrastructures with [enhanced features](#features).
|
||||
As an enhanced Identity service, it implements the [Matrix Identity service API](https://kamax.io/matrix/api/identity_service/unstable.html)
|
||||
As an enhanced Identity service, it implements the [Identity service API](https://matrix.org/docs/spec/identity_service/r0.1.0.html)
|
||||
and several [extra features](#features) that greatly enhance user experience within Matrix.
|
||||
It is the one stop shop for anything regarding Authentication, Directory and Identity management in Matrix built in a
|
||||
single coherent product.
|
||||
|
||||
mxisd is specifically designed to connect to an existing on-premise Identity store (AD/Samba/LDAP, SQL Database,
|
||||
Web services/app, etc.) and ease the integration of a Matrix infrastructure within an existing one.
|
||||
Check [our FAQ entry](docs/faq.md#what-kind-of-setup-is-mxisd-really-designed-for) to know if mxisd is a good fit for you.
|
||||
|
||||
The core principle of mxisd is to map between Matrix IDs and 3PIDs (Third-Party IDentifiers) for the Homeserver and its
|
||||
users. 3PIDs can be anything that uniquely and globally identify a user, like:
|
||||
@@ -32,15 +34,15 @@ users. 3PIDs can be anything that uniquely and globally identify a user, like:
|
||||
If you are unfamiliar with the Identity vocabulary and concepts in Matrix, **please read this [introduction](docs/concepts.md)**.
|
||||
|
||||
# Features
|
||||
[Identity](docs/features/identity.md): As a [regular Matrix Identity service](https://kamax.io/matrix/api/identity_service/unstable.html#general-principles):
|
||||
[Identity](docs/features/identity.md): As a [regular Matrix Identity service](https://matrix.org/docs/spec/identity_service/r0.1.0.html#general-principles):
|
||||
- Search for people by 3PID using its own Identity stores
|
||||
([Spec](https://kamax.io/matrix/api/identity_service/unstable.html#association-lookup))
|
||||
([Spec](https://matrix.org/docs/spec/identity_service/r0.1.0.html#association-lookup))
|
||||
- Invite people to rooms by 3PID using its own Identity stores, with notifications to the invitee (Email, SMS, etc.)
|
||||
([Spec](https://kamax.io/matrix/api/identity_service/unstable.html#post-matrix-identity-api-v1-store-invite))
|
||||
([Spec](https://matrix.org/docs/spec/identity_service/r0.1.0.html#post-matrix-identity-api-v1-store-invite))
|
||||
- Allow users to add 3PIDs to their settings/profile
|
||||
([Spec](https://kamax.io/matrix/api/identity_service/unstable.html#establishing-associations))
|
||||
([Spec](https://matrix.org/docs/spec/identity_service/r0.1.0.html#establishing-associations))
|
||||
- Register accounts on your Homeserver with 3PIDs
|
||||
([Spec](https://kamax.io/matrix/api/identity_service/unstable.html#establishing-associations))
|
||||
([Spec](https://matrix.org/docs/spec/identity_service/r0.1.0.html#establishing-associations))
|
||||
|
||||
As an enhanced Identity service:
|
||||
- [Federation](docs/features/federation.md): Use a recursive lookup mechanism when searching and inviting people by 3PID,
|
||||
@@ -51,6 +53,7 @@ As an enhanced Identity service:
|
||||
- Central Matrix Identity servers
|
||||
- [Session Control](docs/threepids/session/session.md): Extensive control of where 3PIDs are transmitted so they are not
|
||||
leaked publicly by users
|
||||
- [Registration control](docs/features/registration.md): Control and restrict user registration based on 3PID patterns or criterias, like a pending invite
|
||||
- [Authentication](docs/features/authentication.md): Use your Identity stores to perform authentication in [synapse](https://github.com/matrix-org/synapse)
|
||||
via the [REST password provider](https://github.com/kamax-io/matrix-synapse-rest-auth)
|
||||
- [Directory search](docs/features/directory.md) which allows you to search for users within your organisation,
|
||||
@@ -66,15 +69,18 @@ As an enhanced Identity service:
|
||||
- Users can directly find each other using whatever attribute is relevant within your Identity store
|
||||
- Federate your Identity server so you can discover others and/or others can discover you
|
||||
|
||||
Also, check [our FAQ entry](docs/faq.md#what-kind-of-setup-is-mxisd-really-designed-for) to know if mxisd is a good fit for you.
|
||||
|
||||
# Getting started
|
||||
See the [dedicated document](docs/getting-started.md)
|
||||
|
||||
# Support
|
||||
## Troubleshooting
|
||||
A basic troubleshooting guide is available [here](docs/troubleshooting.md).
|
||||
|
||||
## Community
|
||||
Over Matrix: [#mxisd:kamax.io](https://matrix.to/#/#mxisd:kamax.io) ([Preview](https://view.matrix.org/room/!NPRUEisLjcaMtHIzDr:kamax.io/))
|
||||
|
||||
For more high-level discussion about the Identity Server architecture/API, go to [#matrix-identity:kamax.io](https://matrix.to/#/#matrix-identity:kamax.io)
|
||||
|
||||
## Commercial
|
||||
If you would prefer professional support/custom development for mxisd and/or for Matrix in general, including other open
|
||||
source technologies/products:
|
||||
@@ -96,6 +102,11 @@ You can contribute as an organisation/corporation by:
|
||||
maintained regularly and you get direct access to the support team.
|
||||
- Sponsoring new features or bug fixes. [Get in touch](#contact) so we can discuss it further.
|
||||
|
||||
# Powered by mxisd
|
||||
The following projects use mxisd under the hood for some or all their features. Check them out!
|
||||
- [matrix-docker-ansible-deploy](https://github.com/spantaleev/matrix-docker-ansible-deploy)
|
||||
- [matrix-register-bot](https://github.com/krombel/matrix-register-bot)
|
||||
|
||||
# FAQ
|
||||
See the [dedicated document](docs/faq.md)
|
||||
|
||||
|
@@ -1,114 +0,0 @@
|
||||
# Sample configuration file explaining the minimum required keys to be set to run mxisd
|
||||
#
|
||||
# For a complete list of options, see https://github.com/kamax-matrix/mxisd
|
||||
|
||||
#######################
|
||||
# Matrix config items #
|
||||
#######################
|
||||
# Matrix domain, same as the domain configure in your Homeserver configuration.
|
||||
# (note: in Synapse Homeserver, the Matrix domain may be defined as 'server_name' in configuration file).
|
||||
#
|
||||
# This is used to build the various identifiers for identity, auth and directory.
|
||||
matrix.domain: ''
|
||||
|
||||
|
||||
################
|
||||
# Signing keys #
|
||||
################
|
||||
# Absolute path for the Identity Server signing key.
|
||||
# During testing, /var/tmp/mxisd.key is a possible value
|
||||
#
|
||||
# For production, recommended location shall be one of the following:
|
||||
# - /var/opt/mxisd/sign.key
|
||||
# - /var/local/mxisd/sign.key
|
||||
# - /var/lib/mxisd/sign.key
|
||||
#
|
||||
# The signing key is auto-generated during execution time if not present.
|
||||
key.path: ''
|
||||
|
||||
|
||||
############################
|
||||
# Persistence config items #
|
||||
############################
|
||||
|
||||
# Configure the storage backend, usually a DB
|
||||
# Possible built-in values:
|
||||
# sqlite SQLite backend, default
|
||||
#
|
||||
#storage.backend: 'sqlite'
|
||||
|
||||
# Path to the SQLite DB file
|
||||
#
|
||||
# Examples:
|
||||
# - /var/opt/mxisd/mxisd.db
|
||||
# - /var/local/mxisd/mxisd.db
|
||||
# - /var/lib/mxisd/mxisd.db
|
||||
#
|
||||
storage.provider.sqlite.database: '/path/to/mxisd.db'
|
||||
|
||||
|
||||
####################
|
||||
# Fallback servers #
|
||||
####################
|
||||
#
|
||||
# Root/Central servers to be used as final fallback when performing lookups.
|
||||
# By default, for privacy reasons, matrix.org servers are not enabled anymore.
|
||||
# See the following issue: https://github.com/kamax-matrix/mxisd/issues/76
|
||||
#
|
||||
# If you would like to use them and trade away your privacy for convenience, uncomment the following option:
|
||||
#
|
||||
#forward.servers: ['matrix-org']
|
||||
|
||||
|
||||
################
|
||||
# LDAP Backend #
|
||||
################
|
||||
# If you would like to integrate with your AD/Samba/LDAP server,
|
||||
# see https://github.com/kamax-matrix/mxisd/blob/master/docs/stores/ldap.md
|
||||
|
||||
|
||||
###############
|
||||
# SQL Backend #
|
||||
###############
|
||||
# If you would like to integrate with a MySQL/MariaDB/PostgreQL/SQLite DB,
|
||||
# see https://github.com/kamax-matrix/mxisd/blob/master/docs/stores/sql.md
|
||||
|
||||
|
||||
################
|
||||
# REST Backend #
|
||||
################
|
||||
# If you would like to integrate with an existing web service/webapp,
|
||||
# see https://github.com/kamax-matrix/mxisd/blob/master/docs/stores/rest.md
|
||||
|
||||
|
||||
#################################################
|
||||
# Notifications for invites/addition to profile #
|
||||
#################################################
|
||||
# If you would like to change the content,
|
||||
# see https://github.com/kamax-matrix/mxisd/blob/master/docs/threepids/notification/template-generator.md
|
||||
#
|
||||
#### E-mail invite sender
|
||||
#
|
||||
# SMTP host
|
||||
threepid.medium.email.connectors.smtp.host: "smtp.example.org"
|
||||
|
||||
# SMTP port
|
||||
threepid.medium.email.connectors.smtp.port: 587
|
||||
|
||||
# TLS mode for the connection.
|
||||
#
|
||||
# Possible values:
|
||||
# 0 Disable TLS entirely
|
||||
# 1 Enable TLS if supported by server (default)
|
||||
# 2 Force TLS and fail if not available
|
||||
#
|
||||
#threepid.medium.email.connectors.smtp.tls: 1
|
||||
|
||||
# Login for SMTP
|
||||
threepid.medium.email.connectors.smtp.login: "matrix-identity@example.org"
|
||||
|
||||
# Password for the account
|
||||
threepid.medium.email.connectors.smtp.password: "ThePassword"
|
||||
|
||||
# The e-mail to send as.
|
||||
threepid.medium.email.identity.from: "matrix-identity@example.org"
|
106
build.gradle
106
build.gradle
@@ -21,9 +21,11 @@
|
||||
import java.util.regex.Pattern
|
||||
|
||||
apply plugin: 'java'
|
||||
apply plugin: 'org.springframework.boot'
|
||||
apply plugin: 'application'
|
||||
apply plugin: 'com.github.johnrengelman.shadow'
|
||||
apply plugin: 'idea'
|
||||
|
||||
def confFileName = "application.example.yaml"
|
||||
def confFileName = "mxisd.example.yaml"
|
||||
def distDir = "${project.buildDir}/dist"
|
||||
|
||||
def debBinPath = "/usr/lib/mxisd"
|
||||
@@ -31,7 +33,8 @@ def debConfPath = "/etc/mxisd"
|
||||
def debDataPath = "/var/lib/mxisd"
|
||||
def debSystemdPath = "/etc/systemd/system"
|
||||
|
||||
def debConfFileName = "mxisd-sample.yaml"
|
||||
def debConfFileName = confFileName
|
||||
def debStartScriptFilename = "mxisd"
|
||||
|
||||
def debBuildBasePath = "${project.buildDir}/tmp/debian"
|
||||
def debBuildDebianPath = "${debBuildBasePath}/DEBIAN"
|
||||
@@ -43,6 +46,9 @@ def debBuildSystemdPath = "${debBuildBasePath}${debSystemdPath}"
|
||||
def dockerImageName = "kamax/mxisd"
|
||||
def dockerImageTag = "${dockerImageName}:${mxisdVersion()}"
|
||||
|
||||
group = 'io.kamax'
|
||||
mainClassName = 'io.kamax.mxisd.MxisdStandaloneExec'
|
||||
|
||||
String mxisdVersion() {
|
||||
def versionPattern = Pattern.compile("v(\\d+\\.)?(\\d+\\.)?(\\d+)(-.*)?")
|
||||
|
||||
@@ -59,38 +65,41 @@ String gitVersion() {
|
||||
commandLine = ['git', 'describe', '--tags', '--always', '--dirty']
|
||||
standardOutput = out
|
||||
}
|
||||
return out.toString().replace(System.lineSeparator(), '');
|
||||
return out.toString().replace(System.lineSeparator(), '')
|
||||
}
|
||||
|
||||
buildscript {
|
||||
repositories {
|
||||
mavenCentral()
|
||||
jcenter()
|
||||
}
|
||||
|
||||
dependencies {
|
||||
classpath 'org.springframework.boot:spring-boot-gradle-plugin:1.5.3.RELEASE'
|
||||
classpath 'com.github.jengelman.gradle.plugins:shadow:4.0.3'
|
||||
}
|
||||
}
|
||||
|
||||
repositories {
|
||||
mavenCentral()
|
||||
jcenter()
|
||||
maven { url "https://kamax.io/maven/releases/" }
|
||||
maven { url "https://kamax.io/maven/snapshots/" }
|
||||
}
|
||||
|
||||
dependencies {
|
||||
// Logging
|
||||
compile 'org.slf4j:slf4j-simple:1.7.25'
|
||||
|
||||
// Easy file management
|
||||
compile 'commons-io:commons-io:2.5'
|
||||
|
||||
// Spring Boot - standalone app
|
||||
compile 'org.springframework.boot:spring-boot-starter-web:1.5.10.RELEASE'
|
||||
|
||||
// Thymeleaf for HTML templates
|
||||
compile "org.springframework.boot:spring-boot-starter-thymeleaf:1.5.10.RELEASE"
|
||||
// Config management
|
||||
compile 'org.yaml:snakeyaml:1.23'
|
||||
|
||||
// Matrix Java SDK
|
||||
compile 'io.kamax:matrix-java-sdk:0.0.14-8-g0e57ec6'
|
||||
|
||||
// ORMLite
|
||||
compile 'com.j256.ormlite:ormlite-jdbc:5.0'
|
||||
|
||||
// ed25519 handling
|
||||
compile 'net.i2p.crypto:eddsa:0.1.0'
|
||||
|
||||
@@ -107,15 +116,12 @@ dependencies {
|
||||
compile 'com.googlecode.libphonenumber:libphonenumber:8.7.1'
|
||||
|
||||
// E-mail sending
|
||||
compile 'com.sun.mail:javax.mail:1.6.2'
|
||||
compile 'javax.mail:javax.mail-api:1.6.2'
|
||||
compile 'com.sun.mail:javax.mail:1.6.2'
|
||||
|
||||
// Google Firebase Authentication backend
|
||||
compile 'com.google.firebase:firebase-admin:5.3.0'
|
||||
|
||||
// ORMLite
|
||||
compile 'com.j256.ormlite:ormlite-jdbc:5.0'
|
||||
|
||||
// Connection Pool
|
||||
compile 'com.mchange:c3p0:0.9.5.2'
|
||||
|
||||
@@ -123,7 +129,7 @@ dependencies {
|
||||
compile 'org.xerial:sqlite-jdbc:3.20.0'
|
||||
|
||||
// PostgreSQL
|
||||
compile 'org.postgresql:postgresql:42.1.4'
|
||||
compile 'org.postgresql:postgresql:42.2.5'
|
||||
|
||||
// MariaDB/MySQL
|
||||
compile 'org.mariadb.jdbc:mariadb-java-client:2.1.2'
|
||||
@@ -137,37 +143,39 @@ dependencies {
|
||||
// ZT-Exec for exec identity store
|
||||
compile 'org.zeroturnaround:zt-exec:1.10'
|
||||
|
||||
// HTTP server
|
||||
compile 'io.undertow:undertow-core:2.0.16.Final'
|
||||
|
||||
// Command parser for AS interface
|
||||
implementation 'commons-cli:commons-cli:1.4'
|
||||
|
||||
testCompile 'junit:junit:4.12'
|
||||
testCompile 'com.github.tomakehurst:wiremock:2.8.0'
|
||||
testCompile 'com.unboundid:unboundid-ldapsdk:4.0.9'
|
||||
testCompile 'com.icegreen:greenmail:1.5.9'
|
||||
}
|
||||
|
||||
springBoot {
|
||||
executable = true
|
||||
|
||||
embeddedLaunchScriptProperties = [
|
||||
confFolder: "/etc/default"
|
||||
]
|
||||
}
|
||||
|
||||
processResources {
|
||||
doLast {
|
||||
copy {
|
||||
from('build/resources/main/application.yaml') {
|
||||
rename 'application.yaml', 'mxisd.yaml'
|
||||
}
|
||||
into 'build/resources/main'
|
||||
}
|
||||
jar {
|
||||
manifest {
|
||||
attributes(
|
||||
'Implementation-Version': mxisdVersion()
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
task buildDeb(dependsOn: build) {
|
||||
shadowJar {
|
||||
baseName = project.name
|
||||
classifier = null
|
||||
version = null
|
||||
}
|
||||
|
||||
task debBuild(dependsOn: shadowJar) {
|
||||
doLast {
|
||||
def v = mxisdVersion()
|
||||
println "Version for package: ${v}"
|
||||
String debVersion = mxisdVersion()
|
||||
println "Version for package: ${debVersion}"
|
||||
mkdir distDir
|
||||
mkdir debBuildBasePath
|
||||
mkdir "${debBuildBasePath}/DEBIAN"
|
||||
mkdir debBuildDebianPath
|
||||
mkdir debBuildBinPath
|
||||
mkdir debBuildConfPath
|
||||
mkdir debBuildDataPath
|
||||
@@ -178,10 +186,10 @@ task buildDeb(dependsOn: build) {
|
||||
into debBuildBinPath
|
||||
}
|
||||
|
||||
ant.chmod(
|
||||
file: "${debBuildBinPath}/mxisd.jar",
|
||||
perm: 'a+x'
|
||||
)
|
||||
copy {
|
||||
from "${project.file("src/script/" + debStartScriptFilename)}"
|
||||
into debBuildBinPath
|
||||
}
|
||||
|
||||
copy {
|
||||
from(project.file(confFileName)) {
|
||||
@@ -190,16 +198,16 @@ task buildDeb(dependsOn: build) {
|
||||
into debBuildConfPath
|
||||
}
|
||||
|
||||
ant.replaceregexp(
|
||||
ant.replaceregexp( // FIXME adapt to new config format
|
||||
file: "${debBuildConfPath}/${debConfFileName}",
|
||||
match: "key.path:(.*)",
|
||||
replace: "key.path: '${debDataPath}/signing.key'"
|
||||
match: "key:\\R path:(.*)",
|
||||
replace: "key:\n path: '${debDataPath}/keys'"
|
||||
)
|
||||
|
||||
ant.replaceregexp(
|
||||
ant.replaceregexp( // FIXME adapt to new config format
|
||||
file: "${debBuildConfPath}/${debConfFileName}",
|
||||
match: "storage.provider.sqlite.database:(.*)",
|
||||
replace: "storage.provider.sqlite.database: '${debDataPath}/mxisd.db'"
|
||||
match: "storage:\\R provider:\\R sqlite:\\R database:(.*)",
|
||||
replace: "storage:\n provider:\n sqlite:\n database: '${debDataPath}/store.db'"
|
||||
)
|
||||
|
||||
copy {
|
||||
@@ -210,7 +218,7 @@ task buildDeb(dependsOn: build) {
|
||||
ant.replace(
|
||||
file: "${debBuildDebianPath}/control",
|
||||
token: 'Version: 0',
|
||||
value: "Version: ${v}"
|
||||
value: "Version: ${debVersion}"
|
||||
)
|
||||
|
||||
ant.replace(
|
||||
@@ -246,7 +254,7 @@ task buildDeb(dependsOn: build) {
|
||||
}
|
||||
}
|
||||
|
||||
task dockerBuild(type: Exec, dependsOn: build) {
|
||||
task dockerBuild(type: Exec, dependsOn: shadowJar) {
|
||||
commandLine 'docker', 'build', '-t', dockerImageTag, project.rootDir
|
||||
|
||||
doLast {
|
||||
|
@@ -5,6 +5,7 @@
|
||||
- Installation
|
||||
- [Debian package](install/debian.md)
|
||||
- [ArchLinux](install/archlinux.md)
|
||||
- [NixOS](install/nixos.md)
|
||||
- [Docker](install/docker.md)
|
||||
- [From source](install/source.md)
|
||||
- [Architecture overview](architecture.md)
|
||||
|
@@ -1 +1 @@
|
||||
theme: jekyll-theme-cayman
|
||||
theme: jekyll-theme-hacker
|
@@ -17,9 +17,8 @@ cd mxisd
|
||||
./gradlew build
|
||||
```
|
||||
|
||||
Create a new configuration file by coping `application.example.yaml` to `application.yaml` and edit to your needs.
|
||||
Create a new configuration file by coping `mxisd.example.yaml` to `mxisd.yaml` and edit to your needs.
|
||||
For advanced configuration, see the [Configure section](configure.md).
|
||||
**NOTE**: `application.yaml` is also called `mxisd.yaml` in some specific installations.
|
||||
|
||||
Start the server in foreground to validate the build and configuration:
|
||||
```bash
|
||||
@@ -29,12 +28,14 @@ java -jar build/libs/mxisd.jar
|
||||
Ensure the signing key is available:
|
||||
```bash
|
||||
$ curl 'http://localhost:8090/_matrix/identity/api/v1/pubkey/ed25519:0'
|
||||
|
||||
{"public_key":"..."}
|
||||
```
|
||||
|
||||
Test basic recursive lookup (requires Internet connection with access to TCP 443):
|
||||
```bash
|
||||
$ curl 'http://localhost:8090/_matrix/identity/api/v1/lookup?medium=email&address=mxisd-federation-test@kamax.io'
|
||||
|
||||
{"address":"mxisd-federation-test@kamax.io","medium":"email","mxid":"@mxisd-lookup-test:kamax.io",...}
|
||||
```
|
||||
|
||||
@@ -57,7 +58,7 @@ Requirements:
|
||||
|
||||
[Build mxisd](#build) then:
|
||||
```bash
|
||||
./gradlew buildDeb
|
||||
./gradlew debBuild
|
||||
```
|
||||
You will find the debian package in `build/dist`.
|
||||
Then follow the instruction in the [Debian package](install/debian.md) document.
|
||||
|
@@ -1,7 +1,6 @@
|
||||
# Configuration
|
||||
- [Concepts](#concepts)
|
||||
- [Syntax](#syntax)
|
||||
- [Variables](#variables)
|
||||
- [Matrix](#matrix)
|
||||
- [Server](#server)
|
||||
- [Storage](#storage)
|
||||
@@ -11,36 +10,15 @@
|
||||
|
||||
## Concepts
|
||||
### Syntax
|
||||
The configuration file is [YAML](http://yaml.org/) based, allowing two types of syntax.
|
||||
|
||||
Properties-like:
|
||||
```yaml
|
||||
my.config.item: 'value'
|
||||
```
|
||||
|
||||
Object-like:
|
||||
The configuration file is [YAML](http://yaml.org/) based:
|
||||
```yaml
|
||||
my:
|
||||
config:
|
||||
item: 'value'
|
||||
|
||||
```
|
||||
These can also be combined within the same file.
|
||||
Both syntax will be used interchangeably in these documents.
|
||||
|
||||
### Variables
|
||||
It is possible to copy the value of a configuration item into another using the syntax `${config.key.item}`.
|
||||
Example that will copy the value of `matrix.domain` into `server.name`:
|
||||
```yaml
|
||||
matrix:
|
||||
domain: 'example.org'
|
||||
|
||||
server:
|
||||
name: '${matrix.domain}'
|
||||
```
|
||||
|
||||
**WARNING:** mxisd might overwrite/adapt some values during launch. Those changes will not be reflected into copied keys.
|
||||
|
||||
When referencing keys in all documents, a property-like shorthand will be used. The shorthand for the above example would be `my.config.item`
|
||||
|
||||
## Matrix
|
||||
`matrix.domain`
|
||||
@@ -53,17 +31,19 @@ Namespace to create arbitrary list of Identity servers, usable in other parts of
|
||||
|
||||
Example:
|
||||
```yaml
|
||||
matrix.identity.servers:
|
||||
myOtherServers:
|
||||
- 'https://other1.example.org'
|
||||
- 'https://other2.example.org'
|
||||
matrix:
|
||||
identity:
|
||||
servers:
|
||||
myOtherServers:
|
||||
- 'https://other1.example.org'
|
||||
- 'https://other2.example.org'
|
||||
```
|
||||
Create a list under the label `root` containing a single Identity server, `https://matrix.org`
|
||||
Create a list under the label `myOtherServers` containing two Identity servers: `https://other1.example.org` and `https://other2.example.org`.
|
||||
|
||||
## Server
|
||||
- `server.name`: Public hostname of mxisd, if different from the Matrix domain.
|
||||
- `server.port`: HTTP port to listen on (unencrypted)
|
||||
- `server.publicUrl`: Defaults to `https://${server.name}`
|
||||
- `server.publicUrl`: Defaults to `https://{server.name}`
|
||||
|
||||
## Storage
|
||||
### SQLite
|
||||
@@ -82,19 +62,23 @@ See the dedicated documents:
|
||||
|
||||
Example:
|
||||
```yaml
|
||||
notification.handler.email: 'sendgrid'
|
||||
notification.handler.msisdn: 'raw'
|
||||
notification:
|
||||
handler:
|
||||
email: 'sendgrid'
|
||||
msisdn: 'raw'
|
||||
```
|
||||
- Emails notifications would use the `sendgrid` handler, which define its own configuration under `notification.handlers.sendgrid`
|
||||
- Phone notification would use the `raw` handler, basic default built-in handler of mxisd
|
||||
- Phone notification would use the `raw` handler, basic default built-in handler in mxisd
|
||||
|
||||
### Handlers
|
||||
- `notification.handers.<handler ID>`: Handler-specific configuration for the given handler ID. Repeatable.
|
||||
|
||||
Example:
|
||||
```yaml
|
||||
notification.handlers.raw: ...
|
||||
notification.handlers.sendgrid: ...
|
||||
notification:
|
||||
handlers:
|
||||
raw: ...
|
||||
sendgrid: ...
|
||||
```
|
||||
|
||||
Built-in:
|
||||
|
22
docs/faq.md
22
docs/faq.md
@@ -16,6 +16,18 @@ of the Matrix protocol is required for some advanced features.
|
||||
If all fails, come over to [the project room](https://matrix.to/#/#mxisd:kamax.io) and we'll do our best to get you
|
||||
started and answer questions you might have.
|
||||
|
||||
### What kind of setup is mxisd really designed for?
|
||||
mxisd is primarily designed for setups that:
|
||||
- [Care for their privacy](https://github.com/kamax-matrix/mxisd/wiki/mxisd-and-your-privacy)
|
||||
- Have their own [domains](https://en.wikipedia.org/wiki/Domain_name)
|
||||
- Use those domains for their email addresses and all other services
|
||||
- Already have an [Identity store](stores/README.md), typically [LDAP-based](stores/ldap.md).
|
||||
|
||||
If you meet all the conditions, then you are the prime use case we designed mxisd for.
|
||||
|
||||
If you meet some of the conditions, but not all, mxisd will still be a good fit for you but you won't fully enjoy all its
|
||||
features.
|
||||
|
||||
### Do I need to use mxisd if I run a Homeserver?
|
||||
No, but it is strongly recommended, even if you don't use any Identity store or integration.
|
||||
|
||||
@@ -23,9 +35,6 @@ In its default configuration, mxisd uses other federated public servers when per
|
||||
It can also [be configured](features/identity.md#lookups) to use the central matrix.org servers, giving you access to at
|
||||
least the same information as if you were not running it.
|
||||
|
||||
It will also give your users a choice to make their 3PIDs available publicly, ensuring they are made aware of the
|
||||
privacy consequences, which is not the case with the central Matrix.org servers.
|
||||
|
||||
So mxisd is like your gatekeeper and guardian angel. It does not change what you already know, just adds some nice
|
||||
simple features on top of it.
|
||||
|
||||
@@ -47,13 +56,14 @@ Accounts cannot currently migrate/move from one server to another.
|
||||
See a [brief explanation document](concepts.md) about Matrix and mxisd concepts and vocabulary.
|
||||
|
||||
### I already use the synapse LDAP3 auth provider. Why should I care about mxisd?
|
||||
The [synapse LDAP3 auth provider](https://github.com/matrix-org/matrix-synapse-ldap3) is not longer maintained and
|
||||
only handles on specific flow: validate credentials at login.
|
||||
The [synapse LDAP3 auth provider](https://github.com/matrix-org/matrix-synapse-ldap3) is not longer maintained despite
|
||||
saying so and only handles on specific flow: validate credentials at login.
|
||||
|
||||
It does not:
|
||||
- Auto-provision user profiles
|
||||
- Integrate with Identity management
|
||||
- Integrate with Directory searches
|
||||
- Integrate with Profile data
|
||||
|
||||
mxisd is a replacement and enhancement of it, offering coherent results in all areas, which the LDAP3 auth provider
|
||||
does not.
|
||||
@@ -74,7 +84,7 @@ No.
|
||||
In its default configuration, mxisd does not talk to the central Identity server matrix.org to avoid leaking your private
|
||||
data and those of people you might know.
|
||||
|
||||
mxisd [can be configured](features/identity.md#lookups) to talk to the central Identity servers if you wish.
|
||||
[You can configure it](features/identity.md#lookups) to talk to the central Identity servers if you wish.
|
||||
|
||||
### So mxisd is just a big hack! I don't want to use non-official features!
|
||||
mxisd primary concerns are your privacy and to always be compatible with the Matrix ecosystem and the Identity service API.
|
||||
|
@@ -21,7 +21,7 @@ It allows to use Identity stores configured in mxisd to authenticate users on yo
|
||||
|
||||
Authentication is divided into two parts:
|
||||
- [Basic](#basic): authenticate with a regular username.
|
||||
- [Advanced](#advanced): same as basic with extra ability to authenticate using a 3PID.
|
||||
- [Advanced](#advanced): same as basic with extra abilities like authenticate using a 3PID or do username rewrite.
|
||||
|
||||
## Basic
|
||||
Authentication by username is possible by linking synapse and mxisd together using a specific module for synapse, also
|
||||
@@ -145,15 +145,60 @@ Your VirtualHost should now look similar to:
|
||||
</VirtualHost>
|
||||
```
|
||||
|
||||
##### nginx
|
||||
|
||||
The specific configuration to add under the relevant `server`:
|
||||
|
||||
```nginx
|
||||
location /_matrix/client/r0/login {
|
||||
proxy_pass http://localhost:8090;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Forwarded-For $remote_addr;
|
||||
}
|
||||
```
|
||||
|
||||
Your `server` section should now look similar to:
|
||||
|
||||
```nginx
|
||||
server {
|
||||
listen 443 ssl;
|
||||
server_name matrix.example.org;
|
||||
|
||||
# ...
|
||||
|
||||
location /_matrix/client/r0/login {
|
||||
proxy_pass http://localhost:8090;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Forwarded-For $remote_addr;
|
||||
}
|
||||
|
||||
location /_matrix/identity {
|
||||
proxy_pass http://localhost:8090/_matrix/identity;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Forwarded-For $remote_addr;
|
||||
}
|
||||
|
||||
location /_matrix {
|
||||
proxy_pass http://localhost:8008/_matrix;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Forwarded-For $remote_addr;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### DNS Overwrite
|
||||
|
||||
Just like you need to configure a reverse proxy to send client requests to mxisd, you also need to configure mxisd with
|
||||
the internal IP of the Homeserver so it can talk to it directly to integrate its directory search.
|
||||
|
||||
To do so, put the following configuration in your mxisd configuration:
|
||||
```yaml
|
||||
dns.overwrite.homeserver.client:
|
||||
- name: 'example.org'
|
||||
value: 'http://localhost:8008'
|
||||
dns:
|
||||
overwrite:
|
||||
homeserver:
|
||||
client:
|
||||
- name: 'example.org'
|
||||
value: 'http://localhost:8008'
|
||||
```
|
||||
`name` must be the hostname of the URL that clients use when connecting to the Homeserver.
|
||||
You can use `${server.name}` to auto-populate the `value` using the `server.name` configuration option and avoid duplicating it.
|
||||
@@ -162,6 +207,12 @@ In case the hostname is the same as your Matrix domain and `server.name` is not
|
||||
|
||||
`value` is the base internal URL of the Homeserver, without any `/_matrix/..` or trailing `/`.
|
||||
|
||||
### Optional features
|
||||
|
||||
The following features are available after you have a working Advanced setup:
|
||||
|
||||
- Username rewrite: Allows you to rewrite the username of a regular login/pass authentication to a 3PID, that then gets resolved using the regular lookup process. Most common use case is to allow login with numerical usernames on synapse, which is not possible out of the box.
|
||||
|
||||
#### Username rewrite
|
||||
In mxisd config:
|
||||
```yaml
|
||||
|
@@ -5,16 +5,19 @@ to 3PID queries if no mapping was found, allowing seamless bridging to a network
|
||||
This is performed by implementing a specific endpoint on the bridge to map a 3PID lookup to a virtual user.
|
||||
|
||||
**NOTE**: This document is incomplete and might be misleading. In doubt, come in our Matrix room.
|
||||
You can also look at our [Email Bridge README](https://github.com/kamax-io/matrix-appservice-email#mxisd) for an example
|
||||
You can also look at our [Email Bridge README](https://github.com/kamax-matrix/matrix-appservice-email#mxisd) for an example
|
||||
of working configuration.
|
||||
|
||||
## Configuration
|
||||
```yaml
|
||||
lookup.recursive.bridge.enabled: <boolean>
|
||||
lookup.recursive.bridge.recursiveOnly: <boolean>
|
||||
lookup.recursive.bridge.server: <URL to the bridge endpoint for all 3PID medium>
|
||||
lookup.recursive.bridge.mappings:
|
||||
<3PID MEDIUM HERE>: <URL to dedicated bridge for that medium>
|
||||
lookup:
|
||||
recursive:
|
||||
bridge:
|
||||
enabled: <boolean>
|
||||
recursiveOnly: <boolean>
|
||||
server: <URL to the bridge endpoint for all 3PID medium>
|
||||
mappings:
|
||||
<3PID MEDIUM HERE>: <URL to dedicated bridge for that medium>
|
||||
|
||||
```
|
||||
|
||||
|
@@ -123,27 +123,31 @@ the internal IP of the Homeserver so it can talk to it directly to integrate its
|
||||
|
||||
To do so, use the following configuration:
|
||||
```yaml
|
||||
dns.overwrite.homeserver.client:
|
||||
- name: 'example.org'
|
||||
value: 'http://localhost:8008'
|
||||
dns:
|
||||
overwrite:
|
||||
homeserver:
|
||||
client:
|
||||
- name: 'example.org'
|
||||
value: 'http://localhost:8008'
|
||||
```
|
||||
`name` must be the hostname of the URL that clients use when connecting to the Homeserver.
|
||||
In case the hostname is the same as your Matrix domain, you can use `${matrix.domain}` to auto-populate the value using
|
||||
the `matrix.domain` configuration option and avoid duplicating it.
|
||||
|
||||
`value` is the base internal URL of the Homeserver, without any `/_matrix/..` or trailing `/`.
|
||||
- `name` must be the hostname of the URL that clients use when connecting to the Homeserver.
|
||||
- `value` is the base internal URL of the Homeserver, without any `/_matrix/..` or trailing `/`.
|
||||
|
||||
## Next steps
|
||||
### Homeserver results
|
||||
You can configure if the Homeserver should be queried at all when doing a directory search.
|
||||
To disable Homeserver results, set the following in mxisd configuration file:
|
||||
```yaml
|
||||
directory.exclude.homeserver: true
|
||||
directory:
|
||||
exclude:
|
||||
homeserver: true
|
||||
```
|
||||
|
||||
### 3PID exclusion in search
|
||||
You can configure if the 3PID should also be included when doing a directory search.
|
||||
By default, a search is performed on the 3PIDs. If you would like to not include them:
|
||||
```yaml
|
||||
directory.exclude.threepid: true
|
||||
directory:
|
||||
exclude:
|
||||
threepid: true
|
||||
```
|
||||
|
@@ -1,65 +1,65 @@
|
||||
# Integration as an Application Service
|
||||
# Application Service
|
||||
**WARNING:** These features are currently highly experimental. They can be removed or modified without notice.
|
||||
All the features requires a Homeserver capable of connecting Application Services.
|
||||
All the features requires a Homeserver capable of connecting [Application Services](https://matrix.org/docs/spec/application_service/r0.1.0.html).
|
||||
|
||||
## Email notification for Room invites by Matrix ID
|
||||
This feature allows for users found in Identity stores to be instantly notified about Room Invites, regardless if their
|
||||
account was already provisioned on the Homeserver.
|
||||
The following capabilities are provided in this feature:
|
||||
- [Admin commands](#admin-commands)
|
||||
- [Email Notification about room invites by Matrix IDs](#email-notification-about-room-invites-by-matrix-ids)
|
||||
- [Auto-reject of expired 3PID invites](#auto-reject-of-expired-3pid-invites)
|
||||
|
||||
### Requirements
|
||||
- [Identity store(s)](../../stores/README.md) supporting the Profile feature
|
||||
- At least one email entry in the identity store for each user that could be invited.
|
||||
## Setup
|
||||
> **NOTE:** Make sure you are familiar with [configuration format and rules](../../configure.md).
|
||||
|
||||
Integration as an Application service is a three steps process:
|
||||
1. Create the baseline mxisd configuration to allow integration.
|
||||
2. Integrate with the homeserver.
|
||||
3. Configure the specific capabilities, if applicable.
|
||||
|
||||
### Configuration
|
||||
In your mxisd config file:
|
||||
#### Variables
|
||||
Under the `appsvc` namespace:
|
||||
|
||||
| Key | Type | Required | Default | Purpose |
|
||||
|-----------------------|---------|----------|---------|----------------------------------------------------------------|
|
||||
| `enabled` | boolean | No | `true` | Globally enable/disable the feature |
|
||||
| `user.main` | string | No | `mxisd` | Localpart for the main appservice user |
|
||||
| `endpoint.toHS.url` | string | Yes | *None* | Base URL to the Homeserver |
|
||||
| `endpoint.toHS.token` | string | Yes | *None* | Token to use when sending requests to the Homeserver |
|
||||
| `endpoint.toAS.url` | string | Yes | *None* | Base URL to mxisd from the Homeserver |
|
||||
| `endpoint.toAS.token` | string | Yes | *None* | Token for the Homeserver to use when sending requests to mxisd |
|
||||
|
||||
#### Example
|
||||
```yaml
|
||||
matrix:
|
||||
listener:
|
||||
url: '<URL TO THE CS API OF THE HOMESERVER>'
|
||||
localpart: 'appservice-mxisd'
|
||||
token:
|
||||
hs: 'HS_TOKEN_CHANGE_ME'
|
||||
|
||||
synapseSql:
|
||||
enabled: false ## Do not use this line if Synapse is used as an Identity Store
|
||||
type: '<DB TYPE>'
|
||||
connection: '<DB CONNECTION URL>'
|
||||
appsvc:
|
||||
endpoint:
|
||||
toHS:
|
||||
url: 'http://localhost:8008'
|
||||
token: 'ExampleTokenToHS-ChangeMe!'
|
||||
toAS:
|
||||
url: 'http://localhost:8090'
|
||||
token: 'ExampleTokenToAS-ChangeMe!'
|
||||
```
|
||||
|
||||
The `synapseSql` section is used to retrieve display names which are not directly accessible in this mode.
|
||||
For details about `type` and `connection`, see the [relevant documentation](../../stores/synapse.md).
|
||||
If you do not configure it, some placeholders will not be available in the notification, like the Room name.
|
||||
|
||||
You can also change the default template of the notification using the `generic.matrixId` template option.
|
||||
See [the Template generator documentation](../../threepids/notification/template-generator.md) for more info.
|
||||
|
||||
### Homeserver integration
|
||||
### Integration
|
||||
#### Synapse
|
||||
Create a new appservice registration file. Futher config will assume it is in `/etc/matrix-synapse/appservice-mxisd.yaml`
|
||||
Under the `appsvc.registration.synapse` namespace:
|
||||
|
||||
| Key | Type | Required | Default | Purpose |
|
||||
|--------|--------|----------|--------------------|--------------------------------------------------------------------------|
|
||||
| `id` | string | No | `appservice-mxisd` | The unique, user-defined ID of this application service. See spec. |
|
||||
| `file` | string | Yes | *None* | If defined, the synapse registration file that should be created/updated |
|
||||
|
||||
##### Example
|
||||
```yaml
|
||||
id: "appservice-mxisd"
|
||||
url: "http://127.0.0.1:8090"
|
||||
as_token: "AS_TOKEN_CHANGE_ME"
|
||||
hs_token: "HS_TOKEN_CHANGE_ME"
|
||||
sender_localpart: "appservice-mxisd"
|
||||
namespaces:
|
||||
users:
|
||||
- regex: "@*"
|
||||
exclusive: false
|
||||
aliases: []
|
||||
rooms: []
|
||||
appsvc:
|
||||
registration:
|
||||
synapse:
|
||||
file: '/etc/matrix-synapse/mxisd-appservice-registration.yaml'
|
||||
```
|
||||
`id`: An arbitrary unique string to identify the AS.
|
||||
`url`: mxisd to reach mxisd. This ideally should be HTTP and not going through any reverse proxy.
|
||||
`as_token`: Arbitrary value used by mxisd when talking to the HS. Not currently used.
|
||||
`hs_token`: Arbitrary value used by synapse when talking to mxisd. Must match `token.hs` in mxisd config.
|
||||
`sender_localpart`: Username for the mxisd itself on the HS. Default configuration should be kept.
|
||||
`namespaces`: To be kept as is.
|
||||
|
||||
Edit your `homeserver.yaml` and add a new entry to the appservice config file, which should look something like this:
|
||||
```yaml
|
||||
app_service_config_files:
|
||||
- '/etc/matrix-synapse/appservice-mxisd.yaml'
|
||||
- '/etc/matrix-synapse/mxisd-appservice-registration.yaml'
|
||||
- ...
|
||||
```
|
||||
|
||||
@@ -68,5 +68,54 @@ Restart synapse when done to register mxisd.
|
||||
#### Others
|
||||
See your Homeserver documentation on how to integrate.
|
||||
|
||||
### Test
|
||||
## Capabilities
|
||||
### Admin commands
|
||||
#### Setup
|
||||
Min config:
|
||||
```yaml
|
||||
appsvc:
|
||||
feature:
|
||||
admin:
|
||||
allowedRoles:
|
||||
- '+aMatrixCommunity:example.org'
|
||||
- 'SomeLdapGroup'
|
||||
- 'AnyOtherArbitraryRoleFromIdentityStores'
|
||||
```
|
||||
|
||||
#### Use
|
||||
The following steps assume:
|
||||
- `matrix.domain` set to `example.org`
|
||||
- `appsvc.user.main` set to `mxisd` or not set
|
||||
|
||||
1. Invite `@mxisd:example.org` to a new direct chat
|
||||
2. Type `!help` to get all available commands
|
||||
|
||||
### Email Notification about room invites by Matrix IDs
|
||||
This feature allows for users found in Identity stores to be instantly notified about Room Invites, regardless if their
|
||||
account was already provisioned on the Homeserver.
|
||||
|
||||
#### Requirements
|
||||
- [Identity store(s)](../../stores/README.md) supporting the Profile feature
|
||||
- At least one email entry in the identity store for each user that could be invited.
|
||||
|
||||
#### Configuration
|
||||
In your mxisd config file:
|
||||
```yaml
|
||||
synapseSql:
|
||||
enabled: false ## Do not use this line if Synapse is used as an Identity Store
|
||||
type: '<DB TYPE>'
|
||||
connection: '<DB CONNECTION URL>'
|
||||
```
|
||||
|
||||
The `synapseSql` section is optional. It is used to retrieve display names which are not directly accessible in this mode.
|
||||
For details about `type` and `connection`, see the [relevant documentation](../../stores/synapse.md).
|
||||
If you do not configure it, some placeholders will not be available in the notification, like the Room name.
|
||||
|
||||
You can also change the default template of the notification using the `generic.matrixId` template option.
|
||||
See [the Template generator documentation](../../threepids/notification/template-generator.md) for more info.
|
||||
|
||||
#### Test
|
||||
Invite a user which is part of your domain while an appropriate Identity store is used.
|
||||
|
||||
### Auto-reject of expired 3PID invites
|
||||
*TBC*
|
||||
|
@@ -40,10 +40,12 @@ The port must be HTTPS capable which is what you get in a regular setup with a r
|
||||
If you would like to disable outbound federation and isolate your identity server from the rest of the Matrix network,
|
||||
use the following mxisd configuration options:
|
||||
```yaml
|
||||
lookup.recursive.enabled: false
|
||||
invite.resolution.recursive: false
|
||||
session.policy.validation.forLocal.toRemote.enabled: false
|
||||
session.policy.validation.forRemote.toRemote.enabled: false
|
||||
lookup:
|
||||
recursive:
|
||||
enabled: false
|
||||
invite:
|
||||
resolution:
|
||||
recursive: false
|
||||
```
|
||||
|
||||
There is currently no way to selectively disable federation towards specific servers, but this feature is planned.
|
||||
|
@@ -1,20 +1,96 @@
|
||||
# Identity
|
||||
**WARNING**: This document is incomplete and can be missleading.
|
||||
Implementation of the [Identity Service API r0.1.0](https://matrix.org/docs/spec/identity_service/r0.1.0.html).
|
||||
|
||||
Implementation of the [Unofficial Matrix Identity Service API](https://kamax.io/matrix/api/identity_service/unstable.html).
|
||||
- [Lookups](#lookups)
|
||||
- [Invitations](#invitations)
|
||||
- [Expiration](#expiration)
|
||||
- [Policies](#policies)
|
||||
- [Resolution](#resolution)
|
||||
- [3PIDs Management](#3pids-management)
|
||||
|
||||
## Lookups
|
||||
If you would like to use the central matrix.org Identity server to ensure maximum discovery at the cost of potentially
|
||||
leaking all your contacts information, add the following to your configuration:
|
||||
```yaml
|
||||
forward.servers:
|
||||
- 'matrix-org'
|
||||
forward:
|
||||
servers:
|
||||
- 'matrix-org'
|
||||
```
|
||||
**NOTE:** You should carefully consider enabling this option, which is discouraged.
|
||||
For more info, see the [relevant issue](https://github.com/kamax-matrix/mxisd/issues/76).
|
||||
|
||||
## Room Invitations
|
||||
Resolution can be customized using the following configuration:
|
||||
## Invitations
|
||||
### Expiration
|
||||
#### Overview
|
||||
Matrix does not provide a mean to remove/cancel pending 3PID invitations with the APIs. The current reference
|
||||
implementations also do not provide any mean to do so. This leads to 3PID invites forever stuck in rooms.
|
||||
|
||||
To provide this functionality, mxisd uses a workaround: resolve the invite to a dedicated User ID, which can be
|
||||
controlled by mxisd or a bot/service that will then reject the invite.
|
||||
|
||||
If this dedicated User ID is to be controlled by mxisd, the [Application Service](experimental/application-service.md)
|
||||
feature must be configured and integrated with your Homeserver, as well as the *Auto-reject 3PID invite capability*.
|
||||
|
||||
#### Configuration
|
||||
```yaml
|
||||
invite:
|
||||
expiration:
|
||||
enabled: true/false
|
||||
after: 5
|
||||
resolveTo: '@john.doe:example.org'
|
||||
```
|
||||
`enabled`
|
||||
- Purpose: Enable or disable the invite expiration feature.
|
||||
- Default: `true`
|
||||
|
||||
`after`
|
||||
- Purpose: Amount of minutes before an invitation expires.
|
||||
- Default: `10080` (7 days)
|
||||
|
||||
`resolveTo`
|
||||
- Purpose: Matrix User ID to resolve the expired invitations to.
|
||||
- Default: Computed from `appsvc.user.inviteExpired` and `matrix.domain`
|
||||
|
||||
### Policies
|
||||
3PID invite policies are the companion feature of [Registration](registration.md). While the Registration feature acts on
|
||||
requirements for the invitee/register, this feature acts on requirement for the one(s) performing 3PID invites, ensuring
|
||||
a coherent system.
|
||||
|
||||
It relies on only allowing people with specific [Roles](profile.md) to perform 3PID invites. This would typically allow
|
||||
a tight-control on a server setup with is "invite-only" or semi-open (relying on trusted people to invite new members).
|
||||
|
||||
It's a middle ground between a closed server, where every user must be created or already exists in an Identity store,
|
||||
and an open server, where anyone can register.
|
||||
|
||||
#### Integration
|
||||
Because Identity Servers do not control 3PID invites as per Matrix spec, mxisd needs to intercept a set of Homeserver
|
||||
endpoints to apply the policies.
|
||||
|
||||
##### Reverse Proxy
|
||||
###### nginx
|
||||
**IMPORTANT**: Must be placed before your global `/_matrix` entry:
|
||||
```nginx
|
||||
location ~* ^/_matrix/client/r0/rooms/([^/]+)/invite$ {
|
||||
proxy_pass http://127.0.0.1:8090;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Forwarded-For $remote_addr;
|
||||
}
|
||||
```
|
||||
|
||||
#### Configuration
|
||||
The only policy currently available is to restrict 3PID invite to users having a specific (set of) role(s), like so:
|
||||
|
||||
```yaml
|
||||
invite:
|
||||
policy:
|
||||
ifSender:
|
||||
hasRole:
|
||||
- '<THIS_ROLE>'
|
||||
- '<OR_THIS_ROLE>'
|
||||
```
|
||||
|
||||
### Resolution
|
||||
Resolution of 3PID invitations can be customized using the following configuration:
|
||||
|
||||
`invite.resolution.recursive`
|
||||
- Default value: `true`
|
||||
@@ -27,5 +103,5 @@ Resolution can be customized using the following configuration:
|
||||
- Default value: `1`
|
||||
- Description: How often, in minutes, mxisd should try to resolve pending invites.
|
||||
|
||||
## 3PID addition to user profile
|
||||
## 3PIDs Management
|
||||
See the [3PID session documents](../threepids/session)
|
||||
|
111
docs/features/registration.md
Normal file
111
docs/features/registration.md
Normal file
@@ -0,0 +1,111 @@
|
||||
# Registration
|
||||
- [Overview](#overview)
|
||||
- [Integration](#integration)
|
||||
- [Reverse Proxy](#reverse-proxy)
|
||||
- [nginx](#nginx)
|
||||
- [Apache](#apache)
|
||||
- [Homeserver](#homeserver)
|
||||
- [synapse](#synapse)
|
||||
- [Configuration](#configuration)
|
||||
- [Example](#example)
|
||||
- [Usage](#usage)
|
||||
|
||||
## Overview
|
||||
**NOTE**: This feature is beta: it is considered stable enough for production but is incomplete and may contain bugs.
|
||||
|
||||
Registration is an enhanced feature of mxisd to control registrations involving 3PIDs on a Homeserver based on policies:
|
||||
- Match pending 3PID invites on the server
|
||||
- Match 3PID pattern, like a specific set of domains for emails
|
||||
- In futher releases, use 3PIDs found in Identity stores
|
||||
|
||||
It aims to help open or invite-only registration servers control what is possible to do and ensure only approved people
|
||||
can register on a given server in a implementation-agnostic manner.
|
||||
|
||||
**IMPORTANT:** This feature does not control registration in general. It only acts on endpoints related to 3PIDs during
|
||||
the registration process.
|
||||
As such, it relies on the homeserver to require 3PIDs with the registration flows.
|
||||
|
||||
This feature is not part of the Matrix Identity Server spec.
|
||||
|
||||
## Integration
|
||||
mxisd needs to be integrated at several levels for this feature to work:
|
||||
- Reverse proxy: intercept the 3PID register endpoints and act on them
|
||||
- Homeserver: require 3PID to be part of the registration data
|
||||
|
||||
Later version(s) of this feature may directly control registration itself to create a coherent experience
|
||||
### Reverse Proxy
|
||||
#### nginx
|
||||
```nginx
|
||||
location ^/_matrix/client/r0/register/[^/]/?$ {
|
||||
proxy_pass http://127.0.0.1:8090;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Forwarded-For $remote_addr;
|
||||
}
|
||||
```
|
||||
|
||||
#### apache
|
||||
> TBC
|
||||
|
||||
### Homeserver
|
||||
#### Synapse
|
||||
```yaml
|
||||
enable_registration: true
|
||||
registrations_require_3pid:
|
||||
- email
|
||||
```
|
||||
|
||||
## Configuration
|
||||
See the [Configuration](../configuration.md) introduction doc on how to read the configuration keys.
|
||||
An example of working configuration is avaiable at the end of this section.
|
||||
### Enable/Disable
|
||||
`register.allowed`, taking a boolean, can be used to enable/disable registration if the attempt is not 3PID-based.
|
||||
`false` is the default value to prevent open registration, as you must allow it on the homeserver side.
|
||||
|
||||
### For invites
|
||||
`register.invite`, taking a boolean, controls if registration can be made using a 3PID which matches a pending 3PID invite.
|
||||
`true` is the default value.
|
||||
|
||||
### 3PID-specific
|
||||
At this time, only `email` is supported with 3PID specific configuration with this feature.
|
||||
|
||||
#### Email
|
||||
**Base key**: `register.threepid.email`
|
||||
|
||||
##### Domain whitelist/blacklist
|
||||
If you would like to control which domains are allowed to be used when registrating with an email, the following sub-keys
|
||||
are available:
|
||||
- `domain.whitelist`
|
||||
- `domain.blacklist`
|
||||
|
||||
The value format is an hybrid between glob patterns and postfix configuration files with the following syntax:
|
||||
- `*<domain>` will match the domain and any sub-domain(s)
|
||||
- `.<domain>` will only match sub-domain(s)
|
||||
- `<domain>` will only match the exact domain
|
||||
|
||||
The following table illustrates pattern and maching status against example values:
|
||||
|
||||
| Config value | Matches `example.org` | Matches `sub.example.org` |
|
||||
|--------------- |-----------------------|---------------------------|
|
||||
| `*example.org` | Yes | Yes |
|
||||
| `.example.org` | No | Yes |
|
||||
| `example.org` | Yes | No |
|
||||
|
||||
### Example
|
||||
For the following example configuration:
|
||||
```yaml
|
||||
register:
|
||||
policy:
|
||||
threepid:
|
||||
email:
|
||||
domain:
|
||||
whitelist:
|
||||
- '*example.org'
|
||||
- '.example.net'
|
||||
- 'example.com'
|
||||
```
|
||||
- Users can register using 3PIDs of pending invites, being allowed by default.
|
||||
- Users can register using an email from `example.org` and any sub-domain, only sub-domains of `example.net` and `example.com` but not its sub-domains.
|
||||
- Otherwise, user registration will be denied.
|
||||
|
||||
## Usage
|
||||
Nothing special is needed. Register using a regular Matrix client.
|
@@ -6,22 +6,34 @@
|
||||
5. [Validate](#validate)
|
||||
6. [Next steps](#next-steps)
|
||||
|
||||
Following these quick start instructions, you will have a basic setup that can perform recursive/federated lookups and
|
||||
talk to the central Matrix.org Identity server.
|
||||
Following these quick start instructions, you will have a basic setup that can perform recursive/federated lookups.
|
||||
This will be a good ground work for further integration with features and your existing Identity stores.
|
||||
|
||||
---
|
||||
|
||||
If you would like a more fully integrated setup out of the box, the [matrix-docker-ansible-deploy](https://github.com/spantaleev/matrix-docker-ansible-deploy)
|
||||
project provides a turn-key full-stack solution, including LDAP and the various mxisd features enabled and ready.
|
||||
We work closely with the project owner so the latest mxisd version is always supported.
|
||||
|
||||
If you choose to use it, this Getting Started guide is not applicable - See the project documentation. You may then
|
||||
directly go to the [Next steps](#next-steps).
|
||||
|
||||
## Preparation
|
||||
You will need:
|
||||
- Working Homeserver, ideally with working federation
|
||||
- Reverse proxy with regular TLS/SSL certificate (Let's encrypt) for your mxisd domain
|
||||
|
||||
As synapse requires an HTTPS connection when talking to an Identity service, **a reverse proxy is required** as mxisd does
|
||||
not support HTTPS listener at this time.
|
||||
If you use synapse:
|
||||
- It requires an HTTPS connection when talking to an Identity service, **a reverse proxy is required** as mxisd does
|
||||
not support HTTPS listener at this time.
|
||||
- HTTPS is hardcoded when talking to the Identity server. If your Identity server URL in your client is `https://matrix.example.org/`,
|
||||
then you need to ensure `https://matrix.example.org/_matrix/identity/api/v1/...` will reach mxisd if called from the synapse host.
|
||||
In doubt, test with `curl` or similar.
|
||||
|
||||
For maximum integration, it is best to have your Homeserver and mxisd reachable via the same hostname.
|
||||
For maximum integration, it is best to have your Homeserver and mxisd reachable via the same public hostname.
|
||||
|
||||
Be aware of a [NAT/Reverse proxy gotcha](https://github.com/kamax-matrix/mxisd/wiki/Gotchas#nating) if you use the same
|
||||
hostname.
|
||||
host.
|
||||
|
||||
The following Quick Start guide assumes you will host the Homeserver and mxisd under the same hostname.
|
||||
If you would like a high-level view of the infrastructure and how each feature is integrated, see the
|
||||
@@ -38,14 +50,14 @@ Install via:
|
||||
See the [Latest release](https://github.com/kamax-matrix/mxisd/releases/latest) for links to each.
|
||||
|
||||
## Configure
|
||||
**NOTE**: please view the install instruction for your platform, as this step might be optional or already handled for you.
|
||||
> **NOTE**: Please view the install instruction for your platform, as this step might be optional or already handled for you.
|
||||
|
||||
Create/edit a minimal configuration (see installer doc for the location):
|
||||
```yaml
|
||||
matrix.domain: 'example.org'
|
||||
key.path: '/path/to/signing.key.file'
|
||||
storage.provider.sqlite.database: '/path/to/mxisd.db'
|
||||
```
|
||||
> **NOTE**: Details about configuration syntax and format are described [here](configure.md)
|
||||
|
||||
If you haven't created a configuration file yet, copy `mxisd.example.yaml` to where the configuration file is stored given
|
||||
your installation method and edit to your needs.
|
||||
|
||||
The following items must be at least configured:
|
||||
- `matrix.domain` should be set to your Homeserver domain (`server_name` in synapse configuration)
|
||||
- `key.path` will store the signing keys, which must be kept safe! If the file does not exist, keys will be generated for you.
|
||||
- `storage.provider.sqlite.database` is the location of the SQLite Database file which will hold state (invites, etc.)
|
||||
@@ -67,9 +79,9 @@ ProxyPass /_matrix/identity http://0.0.0.0:8090/_matrix/identity
|
||||
Typical configuration would look like:
|
||||
```apache
|
||||
<VirtualHost *:443>
|
||||
ServerName example.org
|
||||
ServerName matrix.example.org
|
||||
|
||||
...
|
||||
# ...
|
||||
|
||||
ProxyPreserveHost on
|
||||
ProxyPass /_matrix/identity http://localhost:8090/_matrix/identity
|
||||
@@ -91,9 +103,9 @@ Typical configuration would look like:
|
||||
```nginx
|
||||
server {
|
||||
listen 443 ssl;
|
||||
server_name example.org;
|
||||
server_name matrix.example.org;
|
||||
|
||||
...
|
||||
# ...
|
||||
|
||||
location /_matrix/identity {
|
||||
proxy_pass http://localhost:8090/_matrix/identity;
|
||||
@@ -114,17 +126,17 @@ Add your mxisd domain into the `homeserver.yaml` at `trusted_third_party_id_serv
|
||||
In a typical configuration, you would end up with something similar to:
|
||||
```yaml
|
||||
trusted_third_party_id_servers:
|
||||
- example.org
|
||||
- matrix.example.org
|
||||
```
|
||||
It is recommended to remove `matrix.org` and `vector.im` (or any other default entry) from your configuration so only
|
||||
your own Identity server is authoritative for your HS.
|
||||
It is **highly recommended** to remove `matrix.org` and `vector.im` (or any other default entry) from your configuration
|
||||
so only your own Identity server is authoritative for your HS.
|
||||
|
||||
## Validate
|
||||
**NOTE:** In case your homeserver has no working federation, step 5 will not happen. If step 4 took place, consider
|
||||
your installation validated.
|
||||
|
||||
1. Log in using your Matrix client and set `https://example.org` as your Identity server URL, replacing `example.org` by
|
||||
the relevant hostname which you configured in your reverse proxy.
|
||||
1. Log in using your Matrix client and set `https://matrix.example.org` as your Identity server URL, replacing `matrix.example.org`
|
||||
by the relevant hostname which you configured in your reverse proxy.
|
||||
2. Create a new empty room. All further actions will take place in this room.
|
||||
3. Invite `mxisd-federation-test@kamax.io`
|
||||
4. The 3PID invite should be turned into a Matrix invite to `@mxisd-lookup-test:kamax.io`.
|
||||
@@ -132,7 +144,8 @@ the relevant hostname which you configured in your reverse proxy.
|
||||
**NOTE:** You might not see a suggestion for the e-mail address, which is normal. Still proceed with the invite.
|
||||
|
||||
If it worked, it means you are up and running and can enjoy mxisd in its basic mode! Congratulations!
|
||||
If it did not work, [get in touch](../README.md#support) and we'll do our best to get you started.
|
||||
If it did not work, read the basic [troubleshooting guide](troubleshooting.md), [get in touch](../README.md#support) and
|
||||
we'll do our best to get you started.
|
||||
|
||||
## Next steps
|
||||
Once your mxisd server is up and running, there are several ways you can enhance and integrate further with your
|
||||
|
@@ -2,37 +2,43 @@
|
||||
## Instructions
|
||||
Follow the [build instructions](../build.md) then:
|
||||
|
||||
1. Prepare files and directories:
|
||||
### Prepare files and directories:
|
||||
```bash
|
||||
# Create a dedicated user
|
||||
useradd -r mxisd
|
||||
|
||||
# Create bin directory
|
||||
mkdir /opt/mxisd
|
||||
|
||||
# Create config directory and set ownership
|
||||
mkdir -p /etc/opt/mxisd
|
||||
chown -R mxisd /etc/opt/mxisd
|
||||
# Create config directory
|
||||
mkdir -p /etc/mxisd
|
||||
|
||||
# Create data directory and set ownership
|
||||
mkdir -p /var/opt/mxisd
|
||||
chown -R mxisd /var/opt/mxisd
|
||||
mkdir -p /var/lib/mxisd
|
||||
chown -R mxisd /var/lib/mxisd
|
||||
|
||||
# Copy <repo root>/build/libs/mxisd.jar to bin directory
|
||||
cp ./build/libs/mxisd.jar /opt/mxisd/
|
||||
chown mxisd /opt/mxisd/mxisd.jar
|
||||
chmod a+x /opt/mxisd/mxisd.jar
|
||||
# Create bin directory, copy the jar and launch scriot to bin directory
|
||||
mkdir /usr/lib/mxisd
|
||||
cp ./build/libs/mxisd.jar /usr/lib/mxisd/
|
||||
cp ./src/script/mxisd /usr/lib/mxisd
|
||||
chown -R mxisd /usr/lib/mxisd
|
||||
chmod a+x /usr/lib/mxisd/mxisd
|
||||
|
||||
# Create symlink for easy exec
|
||||
ln -s /opt/mxisd/mxisd.jar /usr/bin/mxisd
|
||||
ln -s /usr/lib/mxisd/mxisd /usr/bin/mxisd
|
||||
```
|
||||
2. Copy the sample config file `./application.example.yaml` to `/etc/opt/mxisd/mxisd.yaml`, edit to your needs
|
||||
3. Copy `src/systemd/mxisd.service` to `/etc/systemd/system/` and edit if needed
|
||||
4. Enable service for auto-startup
|
||||
|
||||
### Prepare config file
|
||||
Copy the configuration file you've created following the build instructions to `/etc/mxisd/mxisd.yaml`
|
||||
|
||||
### Prepare Systemd
|
||||
1. Copy `src/systemd/mxisd.service` to `/etc/systemd/system/` and edit if needed
|
||||
2. Enable service for auto-startup
|
||||
```bash
|
||||
systemctl enable mxisd
|
||||
```
|
||||
5. Start mxisd
|
||||
|
||||
### Run
|
||||
```bash
|
||||
systemctl start mxisd
|
||||
```
|
||||
|
||||
## Debug
|
||||
mxisd logs to stdout, which is normally sent to `/var/log/syslog` or `/var/log/messages`.
|
||||
|
@@ -39,7 +39,7 @@
|
||||
| [Authentication](../features/authentication.md) | Yes |
|
||||
| [Directory](../features/directory.md) | Yes |
|
||||
| [Identity](../features/identity.md) | Yes |
|
||||
| [Profile](#profile) | Yes |
|
||||
| [Profile](../features/profile.md) | Yes |
|
||||
|
||||
This Identity Store lets you run arbitrary commands to handle the various requests in each support feature.
|
||||
It is the most versatile Identity store of mxisd, allowing you to connect any kind of logic with any executable/script.
|
||||
@@ -68,7 +68,8 @@ We will use the term `Executable` for each lookup/action and `Processor` for eac
|
||||
|
||||
### Global
|
||||
```yaml
|
||||
exec.enabled: <boolean>
|
||||
exec:
|
||||
enabled: <boolean>
|
||||
```
|
||||
Enable/disable the Identity store at a global/default level. Each feature can still be individually enabled/disabled.
|
||||
|
||||
@@ -79,7 +80,9 @@ Not all features use all tokens, and each feature might also have its own specif
|
||||
They can be set within the following scope:
|
||||
|
||||
```yaml
|
||||
exec.token.<token>: '<value>'
|
||||
exec:
|
||||
token:
|
||||
<token>: '<value>'
|
||||
```
|
||||
|
||||
---
|
||||
@@ -184,16 +187,19 @@ The following types are available:
|
||||
### Examples
|
||||
#### Basic
|
||||
```yaml
|
||||
exec.auth.enabled: true
|
||||
exec.auth.command: '/opt/mxisd-exec/auth.sh'
|
||||
exec.auth.args: ['{localpart}']
|
||||
exec.auth.input.type: 'plain'
|
||||
exec.auth.input.template: '{password}'
|
||||
exec.auth.env:
|
||||
DOMAIN: '{domain}'
|
||||
exec:
|
||||
auth:
|
||||
enabled: true
|
||||
command: '/opt/mxisd-exec/auth.sh'
|
||||
args: ['{localpart}']
|
||||
input:
|
||||
type: 'plain'
|
||||
template: '{password}'
|
||||
env:
|
||||
DOMAIN: '{domain}'
|
||||
```
|
||||
With Authentication enabled, run `/opt/mxisd-exec/auth.sh` when validating credentials, providing:
|
||||
- A single command-line argument to provide the `localoart` as username
|
||||
- A single command-line argument to provide the `localpart` as username
|
||||
- A plain text string with the password token for standard input, which will be replaced by the password to check
|
||||
- A single environment variable `DOMAIN` containing Matrix ID domain, if given
|
||||
|
||||
@@ -201,26 +207,34 @@ The command will use the default values for:
|
||||
- Success exit status of `0`
|
||||
- Failure exit status of `1`
|
||||
- Any other exit status considered as error
|
||||
- The standard output processing as not processed
|
||||
- Standard output will not be processed
|
||||
|
||||
#### Advanced
|
||||
Given the fictional `placeholder` feature:
|
||||
```yaml
|
||||
exec.enabled: true
|
||||
exec.token.mxid: '{matrixId}'
|
||||
|
||||
exec.placeholder.token.localpart: '{username}'
|
||||
exec.placeholder.command: '/path/to/executable'
|
||||
exec.placeholder.args:
|
||||
- '-u'
|
||||
- '{username}'
|
||||
exec.placeholder.env:
|
||||
MATRIX_DOMAIN: '{domain}'
|
||||
MATRIX_USER_ID: '{matrixId}'
|
||||
|
||||
exec.placeholder.output.type: 'json'
|
||||
exec.placeholder.exit.success: [0, 128]
|
||||
exec.placeholder.exit.failure: [1, 129]
|
||||
exec:
|
||||
enabled: true
|
||||
token:
|
||||
mxid: '{matrixId}'
|
||||
auth:
|
||||
token:
|
||||
localpart: '{username}'
|
||||
command: '/path/to/executable'
|
||||
args:
|
||||
- '-u'
|
||||
- '{username}'
|
||||
env:
|
||||
MATRIX_DOMAIN: '{domain}'
|
||||
MATRIX_USER_ID: '{matrixId}'
|
||||
output:
|
||||
type: 'json'
|
||||
exit:
|
||||
success:
|
||||
- 0
|
||||
- 128
|
||||
failure:
|
||||
- 1
|
||||
- 129
|
||||
```
|
||||
With:
|
||||
- The Identity store enabled for all features
|
||||
@@ -243,14 +257,17 @@ See each dedicated [Feature](#features) section.
|
||||
## Authentication
|
||||
The Authentication feature can be enabled/disabled using:
|
||||
```yaml
|
||||
exec.auth.enabled: <true/false>
|
||||
exec:
|
||||
auth:
|
||||
enabled: <true/false>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
This feature provides a single *Executable* under the namespace:
|
||||
```yaml
|
||||
exec.auth:
|
||||
exec:
|
||||
auth:
|
||||
...
|
||||
```
|
||||
|
||||
@@ -294,7 +311,9 @@ Default template:
|
||||
## Directory
|
||||
The Directory feature can be enabled/disabled using:
|
||||
```yaml
|
||||
exec.directory.enabled: <true/false>
|
||||
exec:
|
||||
directory:
|
||||
enabled: <true/false>
|
||||
```
|
||||
|
||||
---
|
||||
@@ -303,13 +322,19 @@ Two search types configuration namespace are available, using the same input/out
|
||||
|
||||
By name:
|
||||
```yaml
|
||||
exec.directory.search.byName:
|
||||
...
|
||||
exec:
|
||||
directory:
|
||||
search:
|
||||
byName:
|
||||
...
|
||||
```
|
||||
By 3PID:
|
||||
```yaml
|
||||
exec.directory.search.byThreepid:
|
||||
...
|
||||
exec:
|
||||
directory:
|
||||
search:
|
||||
byThreepid:
|
||||
...
|
||||
```
|
||||
|
||||
#### Tokens
|
||||
@@ -386,8 +411,11 @@ The User ID type will default to `localpart` if:
|
||||
### Bulk lookup
|
||||
Configuration namespace:
|
||||
```yaml
|
||||
exec.identity.lookup.bulk:
|
||||
...
|
||||
exec:
|
||||
identity:
|
||||
lookup:
|
||||
bulk:
|
||||
...
|
||||
```
|
||||
|
||||
#### Tokens
|
||||
@@ -418,7 +446,9 @@ Same as the [REST Identity Store](rest.md).
|
||||
## Profile
|
||||
The Profile feature can be enabled/disabled using:
|
||||
```yaml
|
||||
exec.profile.enabled: <true/false>
|
||||
exec:
|
||||
profile:
|
||||
enabled: <true/false>
|
||||
```
|
||||
|
||||
---
|
||||
@@ -427,20 +457,26 @@ The following *Executable*s namespace are available, share the same input/output
|
||||
|
||||
Get Display name:
|
||||
```yaml
|
||||
exec.profile.displayName:
|
||||
...
|
||||
exec:
|
||||
profile:
|
||||
displayName:
|
||||
...
|
||||
```
|
||||
|
||||
Get 3PIDs:
|
||||
```yaml
|
||||
exec.profile.threePid:
|
||||
...
|
||||
exec:
|
||||
profile:
|
||||
threePid:
|
||||
...
|
||||
```
|
||||
|
||||
Get Roles:
|
||||
```yaml
|
||||
exec.profile.role:
|
||||
...
|
||||
exec:
|
||||
profile:
|
||||
role:
|
||||
...
|
||||
```
|
||||
|
||||
|
||||
|
@@ -2,12 +2,12 @@
|
||||
https://firebase.google.com/
|
||||
|
||||
## Features
|
||||
| Name | Supported? |
|
||||
|----------------|------------|
|
||||
| Authentication | Yes |
|
||||
| Directory | No |
|
||||
| Identity | Yes |
|
||||
| Profile | No |
|
||||
| Name | Supported |
|
||||
|-------------------------------------------------|-----------|
|
||||
| [Authentication](../features/authentication.md) | Yes |
|
||||
| [Directory](../features/directory.md) | No |
|
||||
| [Identity](../features/identity.md) | Yes |
|
||||
| [Profile](../features/profile.md) | No |
|
||||
|
||||
## Requirements
|
||||
This backend requires a suitable Matrix client capable of performing Firebase authentication and passing the following
|
||||
@@ -19,35 +19,41 @@ If your client is Riot, you will need a custom version.
|
||||
|
||||
## Configuration
|
||||
```yaml
|
||||
firebase.enabled: <boolean>
|
||||
firebase:
|
||||
enabled: <boolean>
|
||||
```
|
||||
Enable/disable this identity store.
|
||||
|
||||
Example:
|
||||
```yaml
|
||||
firebase.enabled: <boolean>
|
||||
firebase:
|
||||
enabled: <boolean>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
```yaml
|
||||
firebase.credentials: <string>
|
||||
firebase:
|
||||
credentials: <string>
|
||||
```
|
||||
Path to the credentials file provided by Google Firebase to use with an external app.
|
||||
|
||||
Example:
|
||||
```yaml
|
||||
firebase.credentials: '/path/to/firebase/credentials.json'
|
||||
firebase:
|
||||
credentials: '/path/to/firebase/credentials.json'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
```yaml
|
||||
firebase.database: <string>
|
||||
firebase:
|
||||
database: <string>
|
||||
```
|
||||
URL to your Firebase database.
|
||||
|
||||
Example:
|
||||
```yaml
|
||||
firebase.database: 'https://my-project.firebaseio.com/'
|
||||
firebase:
|
||||
database: 'https://my-project.firebaseio.com/'
|
||||
```
|
||||
|
@@ -8,24 +8,26 @@
|
||||
For NetIQ, replace all the `ldap` prefix in the configuration by `netiq`.
|
||||
|
||||
## Features
|
||||
| Name | Supported? |
|
||||
|----------------|------------|
|
||||
| Authentication | Yes |
|
||||
| Directory | Yes |
|
||||
| Identity | Yes |
|
||||
| Profile | Yes |
|
||||
| Name | Supported |
|
||||
|-------------------------------------------------|-----------|
|
||||
| [Authentication](../features/authentication.md) | Yes |
|
||||
| [Directory](../features/directory.md) | Yes |
|
||||
| [Identity](../features/identity.md) | Yes |
|
||||
| [Profile](../features/profile.md) | Yes |
|
||||
|
||||
## Getting started
|
||||
### Base
|
||||
To use your LDAP backend, add the bare minimum configuration in mxisd config file:
|
||||
```yaml
|
||||
ldap.enabled: true
|
||||
ldap.connection.host: 'ldapHostnameOrIp'
|
||||
ldap.connection.port: 389
|
||||
ldap.connection.bindDn: 'CN=My Mxisd User,OU=Users,DC=example,DC=org'
|
||||
ldap.connection.bindPassword: 'TheUserPassword'
|
||||
ldap.connection.baseDNs:
|
||||
- 'OU=Users,DC=example,DC=org'
|
||||
ldap:
|
||||
enabled: true
|
||||
connection:
|
||||
host: 'ldapHostnameOrIp'
|
||||
port: 389
|
||||
bindDn: 'CN=My Mxisd User,OU=Users,DC=example,DC=org'
|
||||
bindPassword: 'TheUserPassword'
|
||||
baseDNs:
|
||||
- 'OU=Users,DC=example,DC=org'
|
||||
```
|
||||
These are standard LDAP connection configuration. mxisd will try to connect on port default port 389 without encryption.
|
||||
|
||||
@@ -34,14 +36,17 @@ If you would like to use several Base DNs, simply add more entries under `baseDN
|
||||
### TLS/SSL connection
|
||||
If you would like to use a TLS/SSL connection, use the following configuration options (STARTLS not supported):
|
||||
```yaml
|
||||
ldap.connection.tls: true
|
||||
ldap.connection.port: 12345
|
||||
ldap:
|
||||
connection:
|
||||
tls: true
|
||||
port: 12345
|
||||
```
|
||||
|
||||
### Filter results
|
||||
You can also set a default global filter on any LDAP queries:
|
||||
```yaml
|
||||
ldap.filter: '(memberOf=CN=My Matrix Users,OU=Groups,DC=example,DC=org)'
|
||||
ldap:
|
||||
filter: '(memberOf=CN=My Matrix Users,OU=Groups,DC=example,DC=org)'
|
||||
```
|
||||
This example would only return users part of the group called `My Matrix Users`.
|
||||
This can be overwritten or append in each specific flow describe below.
|
||||
@@ -64,8 +69,11 @@ most certainly configure those mappings.
|
||||
|
||||
The following example would set the `sAMAccountName` attribute as a Matrix User ID localpart:
|
||||
```yaml
|
||||
ldap.attribute.uid.type: 'uid'
|
||||
ldap.attribute.uid.value: 'sAMAccountName'
|
||||
ldap:
|
||||
attribute:
|
||||
uid:
|
||||
type: 'uid'
|
||||
value: 'sAMAccountName'
|
||||
```
|
||||
|
||||
#### Display name
|
||||
@@ -73,7 +81,9 @@ Use `ldap.attribute.name`.
|
||||
|
||||
The following example would set the display name to the value of the `cn` attribute:
|
||||
```yaml
|
||||
ldap.attribute.name: 'cn'
|
||||
ldap:
|
||||
attribute:
|
||||
name: 'cn'
|
||||
```
|
||||
|
||||
#### 3PIDs
|
||||
@@ -82,13 +92,15 @@ You can also change the attribute lists for 3PID, like email or phone numbers.
|
||||
The following example would overwrite the [default list of attributes](../../src/main/resources/application.yaml#L67)
|
||||
for emails and phone number:
|
||||
```yaml
|
||||
ldap.attribute.threepid.email:
|
||||
- 'mail'
|
||||
- 'otherMailAttribute'
|
||||
|
||||
ldap.attribute.threepid.msisdn:
|
||||
- 'phone'
|
||||
- 'otherPhoneAttribute'
|
||||
ldap:
|
||||
attribute:
|
||||
threepid:
|
||||
email:
|
||||
- 'mail'
|
||||
- 'otherMailAttribute'
|
||||
msisdn:
|
||||
- 'phone'
|
||||
- 'otherPhoneAttribute'
|
||||
```
|
||||
|
||||
## Features
|
||||
@@ -101,24 +113,29 @@ configuration item is needed to get started.
|
||||
- `ldap.identity.medium`: Namespace to overwrite generated queries from the list of attributes for each 3PID medium.
|
||||
|
||||
### Authentication
|
||||
No further configuration is needed to use the Authentication feature with LDAP once globally enabled and configured.
|
||||
After you have configured and enabled the [feature itself](../features/authentication.md), no further configuration is
|
||||
needed with this identity store to make it work.
|
||||
|
||||
Profile auto-fill is enabled by default. It will use the `ldap.attribute.name` and `ldap.attribute.threepid` configuration
|
||||
options to get a lit of attributes to be used to build the user profile to pass on to synapse during authentication.
|
||||
|
||||
#### Configuration
|
||||
- `ldap.auth.filter`: Specific user filter applied during identity search. Global filter is used if blank/not set.
|
||||
- `ldap.auth.filter`: Specific user filter applied during username search. Global filter is used if blank/not set.
|
||||
|
||||
### Directory
|
||||
No further configuration is needed to use the Directory feature with LDAP once globally enabled and configured.
|
||||
After you have configured and enabled the [feature itself](../features/directory.md), no further configuration is
|
||||
needed with this identity store to make it work.
|
||||
|
||||
#### Configuration
|
||||
To set a specific filter applied during directory search, use `ldap.directory.filter`
|
||||
|
||||
If you would like to use extra attributes in search that are not 3PIDs, like nicknames, group names, employee number:
|
||||
```yaml
|
||||
ldap.directory.attribute.other:
|
||||
- 'myNicknameAttribute'
|
||||
- 'memberOf'
|
||||
- 'employeeNumberAttribute'
|
||||
ldap:
|
||||
directory:
|
||||
attribute:
|
||||
other:
|
||||
- 'myNicknameAttribute'
|
||||
- 'memberOf'
|
||||
- 'employeeNumberAttribute'
|
||||
```
|
||||
|
@@ -268,3 +268,10 @@ Structure with example values:
|
||||
}
|
||||
```
|
||||
The base `profile` key is mandatory. `display_name`, `threepids` and `roles` are only to be returned on the relevant request.
|
||||
|
||||
If there is no profile, the following response is expected:
|
||||
```json
|
||||
{
|
||||
"profile": {}
|
||||
}
|
||||
```
|
||||
|
@@ -6,28 +6,30 @@
|
||||
- SQLite
|
||||
|
||||
## Features
|
||||
| Name | Supported? |
|
||||
|----------------|------------|
|
||||
| Authentication | No |
|
||||
| Directory | Yes |
|
||||
| Identity | Yes |
|
||||
| Profile | Yes |
|
||||
| Name | Supported |
|
||||
|-------------------------------------------------|-----------|
|
||||
| [Authentication](../features/authentication.md) | No |
|
||||
| [Directory](../features/directory.md) | Yes |
|
||||
| [Identity](../features/identity.md) | Yes |
|
||||
| [Profile](../features/profile.md) | Yes |
|
||||
|
||||
Due to the implementation complexity of supporting arbitrary hashing/encoding mechanisms or auth flow, Authentication
|
||||
will be out of scope of SQL Identity stores and should be done via one of the other identity stores, typically
|
||||
the [REST Identity store](rest.md).
|
||||
the [Exec Identity Store](exec.md) or the [REST Identity Store](rest.md).
|
||||
|
||||
## Configuration
|
||||
### Basic
|
||||
```yaml
|
||||
sql.enabled: <boolean>
|
||||
sql:
|
||||
enabled: <boolean>
|
||||
```
|
||||
Enable/disable the identity store
|
||||
|
||||
---
|
||||
|
||||
```yaml
|
||||
sql.type: <string>
|
||||
sql:
|
||||
type: <string>
|
||||
```
|
||||
Set the SQL backend to use:
|
||||
- `sqlite`
|
||||
@@ -38,14 +40,16 @@ Set the SQL backend to use:
|
||||
### Connection
|
||||
#### SQLite
|
||||
```yaml
|
||||
sql.connection: <string>
|
||||
sql:
|
||||
connection: <string>
|
||||
```
|
||||
Set the value to the absolute path to the Synapse SQLite DB file.
|
||||
Example: `/path/to/sqlite/file.db`
|
||||
|
||||
#### Others
|
||||
```yaml
|
||||
sql.connection: //<HOST[:PORT]/DB?user=USER&password=PASS
|
||||
sql:
|
||||
connection: //<HOST[:PORT]/DB?user=USER&password=PASS
|
||||
```
|
||||
Set the connection info for the database by replacing the following values:
|
||||
- `HOST`: Hostname of the SQL server
|
||||
@@ -58,20 +62,23 @@ This follow the JDBC URI syntax. See [official website](https://docs.oracle.com/
|
||||
|
||||
### Directory
|
||||
```yaml
|
||||
sql.directory.enabled: false
|
||||
sql:
|
||||
directory:
|
||||
enabled: false
|
||||
```
|
||||
|
||||
|
||||
---
|
||||
|
||||
```yaml
|
||||
sql.directory.query:
|
||||
name:
|
||||
type: <string>
|
||||
value: <string>
|
||||
threepid:
|
||||
type: <string>
|
||||
value: <string>
|
||||
sql:
|
||||
directory:
|
||||
query:
|
||||
name:
|
||||
type: <string>
|
||||
value: <string>
|
||||
threepid:
|
||||
type: <string>
|
||||
value: <string>
|
||||
```
|
||||
For each query, `type` can be used to tell mxisd how to process the ID column:
|
||||
- `localpart` will append the `matrix.domain` to it
|
||||
@@ -83,17 +90,21 @@ For each query, `type` can be used to tell mxisd how to process the ID column:
|
||||
|
||||
Example:
|
||||
```yaml
|
||||
sql.directory.query:
|
||||
name:
|
||||
type: 'localpart'
|
||||
value: 'SELECT idColumn, displayNameColumn FROM table WHERE displayNameColumn LIKE ?'
|
||||
threepid:
|
||||
type: 'localpart'
|
||||
value: 'SELECT idColumn, displayNameColumn FROM table WHERE threepidColumn LIKE ?'
|
||||
sql:
|
||||
directory:
|
||||
query:
|
||||
name:
|
||||
type: 'localpart'
|
||||
value: 'SELECT idColumn, displayNameColumn FROM table WHERE displayNameColumn LIKE ?'
|
||||
threepid:
|
||||
type: 'localpart'
|
||||
value: 'SELECT idColumn, displayNameColumn FROM table WHERE threepidColumn LIKE ?'
|
||||
```
|
||||
|
||||
### Identity
|
||||
```yaml
|
||||
sql.identity.type: <string>
|
||||
sql.identity.query: <string>
|
||||
sql:
|
||||
identity:
|
||||
type: <string>
|
||||
query: <string>
|
||||
```
|
||||
|
@@ -1,27 +1,31 @@
|
||||
# Synapse Identity Store
|
||||
Synapse's Database itself can be used as an Identity store.
|
||||
Synapse's Database itself can be used as an Identity store. This identity store is a regular SQL store with
|
||||
built-in default queries that matches Synapse DB.
|
||||
|
||||
## Features
|
||||
| Name | Supported? |
|
||||
|----------------|------------|
|
||||
| Authentication | No |
|
||||
| Directory | Yes |
|
||||
| Identity | Yes |
|
||||
| Profile | Yes |
|
||||
| Name | Supported |
|
||||
|-------------------------------------------------|-----------|
|
||||
| [Authentication](../features/authentication.md) | No |
|
||||
| [Directory](../features/directory.md) | Yes |
|
||||
| [Identity](../features/identity.md) | Yes |
|
||||
| [Profile](../features/profile.md) | Yes |
|
||||
|
||||
Authentication is done by Synapse itself.
|
||||
- Authentication is done by Synapse itself.
|
||||
- Roles are mapped to communities. The Role name/ID uses the community ID in the form `+id:domain.tld`
|
||||
|
||||
## Configuration
|
||||
### Basic
|
||||
```yaml
|
||||
synapseSql.enabled: <boolean>
|
||||
synapseSql:
|
||||
enabled: <boolean>
|
||||
```
|
||||
Enable/disable the identity store
|
||||
|
||||
---
|
||||
|
||||
```yaml
|
||||
synapseSql.type: <string>
|
||||
synapseSql:
|
||||
type: <string>
|
||||
```
|
||||
Set the SQL backend to use which is configured in synapse:
|
||||
- `sqlite`
|
||||
@@ -29,14 +33,16 @@ Set the SQL backend to use which is configured in synapse:
|
||||
|
||||
### SQLite
|
||||
```yaml
|
||||
synapseSql.connection: <string>
|
||||
synapseSql:
|
||||
connection: <string>
|
||||
```
|
||||
Set the value to the absolute path to the Synapse SQLite DB file.
|
||||
Example: `/path/to/synapse/sqliteFile.db`
|
||||
|
||||
### PostgreSQL
|
||||
```yaml
|
||||
synapseSql.connection: //<HOST[:PORT]/DB?user=USER&password=PASS
|
||||
synapseSql:
|
||||
connection: //<HOST[:PORT]/DB?user=USER&password=PASS
|
||||
```
|
||||
Set the connection info for the database by replacing the following values:
|
||||
- `HOST`: Hostname of the SQL server
|
||||
|
@@ -5,12 +5,12 @@ Two types of connections are required for full support:
|
||||
- Direct SQL access
|
||||
|
||||
## Features
|
||||
| Name | Supported? |
|
||||
|----------------|------------|
|
||||
| Authentication | Yes |
|
||||
| Directory | Yes |
|
||||
| Identity | Yes |
|
||||
| Profile | No |
|
||||
| Name | Supported |
|
||||
|-------------------------------------------------|-----------|
|
||||
| [Authentication](../features/authentication.md) | Yes |
|
||||
| [Directory](../features/directory.md) | Yes |
|
||||
| [Identity](../features/identity.md) | Yes |
|
||||
| [Profile](../features/profile.md) | No |
|
||||
|
||||
## Requirements
|
||||
- [Wordpress](https://wordpress.org/download/) >= 4.4
|
||||
@@ -34,22 +34,29 @@ If this is not the case for your installation, the mxisd URL will need to be app
|
||||
### mxisd
|
||||
Enable in the configuration:
|
||||
```yaml
|
||||
wordpress.enabled: true
|
||||
wordpress:
|
||||
enabled: true
|
||||
```
|
||||
Configure the URL to your Wordpress installation - see above about added `/index.php`:
|
||||
```yaml
|
||||
wordpress.rest.base: 'http://localhost:8080'
|
||||
wordpress:
|
||||
rest:
|
||||
base: 'http://localhost:8080'
|
||||
```
|
||||
Configure the SQL connection to your Wordpress database:
|
||||
```yaml
|
||||
wordpress.sql.connection: '//127.0.0.1/wordpress?user=root&password=example'
|
||||
wordpress:
|
||||
sql:
|
||||
connection: '//127.0.0.1/wordpress?user=root&password=example'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
By default, MySQL database is expected. If you use another database, use:
|
||||
```yaml
|
||||
wordpress.sql.type: <string>
|
||||
wordpress:
|
||||
sql:
|
||||
type: <string>
|
||||
```
|
||||
With possible values:
|
||||
- `mysql`
|
||||
@@ -61,6 +68,8 @@ With possible values:
|
||||
|
||||
To configure the tables prefix for default queries, in case a custom value was set during Wordpress install:
|
||||
```yaml
|
||||
wordpress.sql.tablePrefix: <string>
|
||||
wordpress:
|
||||
sql:
|
||||
tablePrefix: <string>
|
||||
```
|
||||
By default, the value is set to `wp_`.
|
||||
|
@@ -1,19 +1,19 @@
|
||||
# Email notifications - SMTP connector
|
||||
Enabled by default.
|
||||
|
||||
Connector ID: `smtp`
|
||||
|
||||
## Configuration
|
||||
```yaml
|
||||
threepid.medium.email:
|
||||
identity:
|
||||
from: 'identityServerEmail@example.org'
|
||||
name: 'My Identity Server'
|
||||
connectors:
|
||||
smtp:
|
||||
host: 'smtpHostname'
|
||||
port: 587
|
||||
tls: 1 # 0 = no STARTLS, 1 = try, 2 = force
|
||||
login: 'smtpLogin'
|
||||
password: 'smtpPassword'
|
||||
threepid:
|
||||
medium:
|
||||
email:
|
||||
identity:
|
||||
from: 'identityServerEmail@example.org'
|
||||
name: 'My Identity Server'
|
||||
connectors:
|
||||
smtp:
|
||||
host: 'smtpHostname'
|
||||
port: 587
|
||||
tls: 1 # 0 = no STARTLS, 1 = try, 2 = force
|
||||
login: 'smtpLogin'
|
||||
password: 'smtpPassword'
|
||||
```
|
||||
|
@@ -1,11 +1,14 @@
|
||||
# SMS notifications - Twilio connector
|
||||
Enabled by default.
|
||||
|
||||
Connector ID: `twilio`
|
||||
|
||||
## Configuration
|
||||
```yaml
|
||||
threepid.medium.msisdn.connectors.twilio.accountSid: 'myAccountSid'
|
||||
threepid.medium.msisdn.connectors.twilio.authToken: 'myAuthToken'
|
||||
threepid.medium.msisdn.connectors.twilio.number: '+123456789'
|
||||
threepid:
|
||||
medium:
|
||||
msisdn:
|
||||
connectors:
|
||||
twilio:
|
||||
accountSid: 'myAccountSid'
|
||||
authToken: 'myAuthToken'
|
||||
number: '+123456789'
|
||||
```
|
||||
|
@@ -18,20 +18,23 @@ This handler can be used with the 3PID types:
|
||||
## Configuration
|
||||
Enabled by default or with:
|
||||
```yaml
|
||||
notification.handler.email: 'raw'
|
||||
notification:
|
||||
handler:
|
||||
email: 'raw'
|
||||
```
|
||||
|
||||
**WARNING:** Will be consolidated soon, prone to breaking changes.
|
||||
Structure and default values:
|
||||
```yaml
|
||||
threepid.medium:
|
||||
email:
|
||||
identity:
|
||||
from: ''
|
||||
name: ''
|
||||
connector: 'smtp'
|
||||
generator: 'template'
|
||||
msisdn:
|
||||
connector: 'twilio'
|
||||
generator: 'template'
|
||||
threepid:
|
||||
medium:
|
||||
email:
|
||||
identity:
|
||||
from: ''
|
||||
name: ''
|
||||
connector: 'smtp'
|
||||
generator: 'template'
|
||||
msisdn:
|
||||
connector: 'twilio'
|
||||
generator: 'template'
|
||||
```
|
||||
|
@@ -1,7 +1,39 @@
|
||||
# SendGrid Notification handler
|
||||
To be completed. See [raw possible configuration items](https://github.com/kamax-matrix/mxisd/blob/master/src/main/resources/application.yaml#L172).
|
||||
> **WARNING:** This section is incomplete and may be misleading. Contact us if guidance is needed.
|
||||
|
||||
Enabled with:
|
||||
Enable with:
|
||||
```yaml
|
||||
notification.handler.email: 'sendgrid'
|
||||
notification:
|
||||
handler:
|
||||
email: 'sendgrid'
|
||||
```
|
||||
|
||||
Available Configuration keys:
|
||||
```yaml
|
||||
notification:
|
||||
handlers:
|
||||
sendgrid:
|
||||
api:
|
||||
key: <API key>
|
||||
identity:
|
||||
from: <Sender email address>
|
||||
name: <Sender name>
|
||||
templates:
|
||||
invite:
|
||||
subject: <Subject of the email notification sent for room invites>
|
||||
body:
|
||||
text: <Path to file containing the raw text part of the email. Do not set to not use one>
|
||||
html: <Path to file containing the HTML part of the email. Do not set to not use one>
|
||||
session:
|
||||
validation:
|
||||
subject: <Subject of the email notification sent for 3PID sessions>
|
||||
body:
|
||||
text: <Path to file containing the raw text part of the email. Do not set to not use one>
|
||||
html: <Path to file containing the HTML part of the email. Do not set to not use one>
|
||||
unbind:
|
||||
fraudulent:
|
||||
subject: <Subject of the email notification sent for potentially fraudulent 3PID unbinds>
|
||||
body:
|
||||
text: <Path to file containing the raw text part of the email. Do not set to not use one>
|
||||
html: <Path to file containing the raw text part of the email. Do not set to not use one>
|
||||
```
|
||||
|
@@ -11,16 +11,18 @@ placeholders and also have their own individual set of placeholders.
|
||||
## Configuration
|
||||
To configure paths to the various templates:
|
||||
```yaml
|
||||
threepid.medium.<YOUR 3PID MEDIUM HERE>:
|
||||
generators:
|
||||
template:
|
||||
invite: '/path/to/invite-template.eml'
|
||||
session:
|
||||
validation:
|
||||
local: '/path/to/validate-local-template.eml'
|
||||
remote: 'path/to/validate-remote-template.eml'
|
||||
generic:
|
||||
matrixId: '/path/to/mxid-invite-template.eml'
|
||||
threepid:
|
||||
medium:
|
||||
<YOUR 3PID MEDIUM HERE>:
|
||||
generators:
|
||||
template:
|
||||
invite: '/path/to/invite-template.eml'
|
||||
session:
|
||||
validation: '/path/to/validate-template.eml'
|
||||
unbind:
|
||||
fraudulent: '/path/to/unbind-fraudulent-template.eml'
|
||||
generic:
|
||||
matrixId: '/path/to/mxid-invite-template.eml'
|
||||
```
|
||||
The `template` generator is usually the default, so no further configuration is needed.
|
||||
|
||||
@@ -49,7 +51,7 @@ This template is used when someone is invited into a room using an email address
|
||||
| `%ROOM_NAME%` | The Name of the room in which the invite took place. If not available/set, empty |
|
||||
| `%ROOM_NAME_OR_ID%` | The Name of the room in which the invite took place. If not available/set, its Matrix ID |
|
||||
|
||||
### Local validation of 3PID Session
|
||||
### Validation of 3PID Session
|
||||
This template is used when to user which added their 3PID address to their profile/settings and the session policy
|
||||
allows at least local sessions.
|
||||
|
||||
@@ -57,17 +59,5 @@ allows at least local sessions.
|
||||
| Placeholder | Purpose |
|
||||
|----------------------|--------------------------------------------------------------------------------------|
|
||||
| `%VALIDATION_LINK%` | URL, including token, to validate the 3PID session. |
|
||||
| `%VALIDATION_TOKEN%` | The token needed to validate the local session, in case the user cannot use the link |
|
||||
|
||||
### Remote validation of 3PID Session
|
||||
This template is used when to user which added their 3PID address to their profile/settings and the session policy only
|
||||
allows remote sessions.
|
||||
|
||||
**NOTE:** 3PID session always require local validation of a token, even if a remote session is enforced.
|
||||
One cannot bind a Matrix ID to the session until both local and remote sessions have been validated.
|
||||
|
||||
#### Placeholders
|
||||
| Placeholder | Purpose |
|
||||
|----------------------|--------------------------------------------------------|
|
||||
| `%VALIDATION_TOKEN%` | The token needed to validate the session |
|
||||
| `%NEXT_URL%` | URL to continue with remote validation of the session. |
|
||||
| `%VALIDATION_TOKEN%` | The token needed to validate the session, in case the user cannot use the link. |
|
||||
| `%NEXT_URL%` | URL to redirect to after the sessions has been validated. |
|
||||
|
@@ -1,86 +1,34 @@
|
||||
# Web pages for the 3PID sessions
|
||||
You can customize the various pages used during a 3PID validation using [Thymeleaf templates](http://www.thymeleaf.org/).
|
||||
You can customize the various pages used during a 3PID validation using the options below.
|
||||
|
||||
## Configuration
|
||||
Pseudo-configuration to illustrate the structure:
|
||||
```yaml
|
||||
# CONFIGURATION EXAMPLE
|
||||
# DO NOT COPY/PASTE THIS IN YOUR CONFIGURATION
|
||||
view.session.local:
|
||||
onTokenSubmit:
|
||||
success: '/path/to/session/local/tokenSubmitSuccess-page.html'
|
||||
failure: '/path/to/session/local/tokenSubmitFailure-page.html'
|
||||
view.session.localRemote:
|
||||
onTokenSubmit:
|
||||
success: '/path/to/session/localRemote/tokenSubmitSuccess-page.html'
|
||||
failure: '/path/to/session/local/tokenSubmitFailure-page.html'
|
||||
view.session.remote:
|
||||
onRequest:
|
||||
success: '/path/to/session/remote/requestSuccess-page.html'
|
||||
failure: '/path/to/session/remote/requestFailure-page.html'
|
||||
onCheck:
|
||||
success: '/path/to/session/remote/checkSuccess-page.html'
|
||||
failure: '/path/to/session/remote/checkFailure-page.html'
|
||||
view:
|
||||
session:
|
||||
onTokenSubmit:
|
||||
success: '/path/to/session/tokenSubmitSuccess-page.html'
|
||||
failure: '/path/to/session/tokenSubmitFailure-page.html'
|
||||
# CONFIGURATION EXAMPLE
|
||||
# DO NOT COPY/PASTE THIS IN YOUR CONFIGURATION
|
||||
```
|
||||
|
||||
3PID session are divided into three config sections:
|
||||
- `local` for local-only 3PID sessions
|
||||
- `localRemote` for local 3PID sessions that can also be turned into remote sessions, if the user so desires
|
||||
- `remote` for remote-only 3PID sessions
|
||||
|
||||
Each section contains a sub-key per support event. Finally, a `success` and `failure` key is available depending on the
|
||||
outcome of the request.
|
||||
|
||||
## Local
|
||||
### onTokenSubmit
|
||||
`view.session`:
|
||||
This is triggered when a user submit a validation token for a 3PID session. It is typically visited when clicking the
|
||||
link in a validation email.
|
||||
|
||||
The template should typically inform the user that the validation was successful and to go back in their Matrix client
|
||||
to finish the validation process.
|
||||
to finish the validation process, or that the validation failed.
|
||||
|
||||
#### Placeholders
|
||||
Two configuration keys are available that accept paths to HTML templates:
|
||||
- `success`
|
||||
- `failure`
|
||||
|
||||
## Placeholders
|
||||
### Success
|
||||
No object/placeholder are currently available.
|
||||
|
||||
## Local & Remote
|
||||
### onTokenSubmit
|
||||
This is triggered when a user submit a validation token for a 3PID session. It is typically visited when clicking the
|
||||
link in a validation email.
|
||||
|
||||
The template should typically inform the user that their 3PID address will not yet be publicly/globally usable. In case
|
||||
they want to make it, they should start a Remote 3PID session with a given link or that they can go back to their Matrix
|
||||
client if they do not wish to proceed any further.
|
||||
|
||||
#### Placeholders
|
||||
##### Success
|
||||
`<a th:href="${remoteSessionLink}">text</a>` can be used to display the link to start a Remote 3PID session.
|
||||
|
||||
##### Failure
|
||||
No object/placeholder are currently available.
|
||||
|
||||
## Remote
|
||||
### onRequest
|
||||
This is triggered when a user starts a Remote 3PID session, usually from a link produced in the `local.onTokenSubmit`
|
||||
view or in a remote-only 3PID notification.
|
||||
|
||||
The template should typically inform the user that the remote creation was successful, followed the instructions sent by
|
||||
the remote Identity server and, once that is done, click a link to validate the session.
|
||||
|
||||
#### Placeholders
|
||||
##### Success
|
||||
`<a th:href="${checkLink}">text</a>` can be used to display the link to validate the Remote 3PID session.
|
||||
|
||||
##### Failure
|
||||
No object/placeholder are currently available.
|
||||
|
||||
### onCheck
|
||||
This is triggered when a user attempts to inform the Identity server that the Remote 3PID session has been validated
|
||||
with the remote Identity server.
|
||||
|
||||
The template should typically inform the user that the validation was successful and to go back in their Matrix client
|
||||
to finish the validation process.
|
||||
|
||||
#### Placeholders
|
||||
### Failure
|
||||
No object/placeholder are currently available.
|
||||
|
@@ -1,9 +1,8 @@
|
||||
# 3PID Sessions
|
||||
- [Overview](#overview)
|
||||
- [Purpose](#purpose)
|
||||
- [Federation](#federation)
|
||||
- [3PID scope](#3pid-scope)
|
||||
- [Session scope](#session-scope)
|
||||
- [Restrictions](#restrictions)
|
||||
- [Bindings](#bindings)
|
||||
- [Federation](#federation)
|
||||
- [Notifications](#notifications)
|
||||
- [Email](#email)
|
||||
- [Phone numbers](#msisdn-(phone-numbers))
|
||||
@@ -11,28 +10,39 @@
|
||||
- [Configuration](#configuration)
|
||||
- [Web views](#web-views)
|
||||
- [Scenarios](#scenarios)
|
||||
- [Default](#default)
|
||||
- [Local sessions only](#local-sessions-only)
|
||||
- [Remote sessions only](#remote-sessions-only)
|
||||
- [Sessions disabled](#sessions-disabled)
|
||||
|
||||
## Overview
|
||||
When adding an email, a phone number or any other kind of 3PID (Third-Party Identifier) in a Matrix client,
|
||||
the identity server is contacted to validate the 3PID.
|
||||
|
||||
To validate the 3PID the identity server sends a message to the 3PID (e.g. an
|
||||
email) with a hyperlink back to a web-page managed by the identity server to
|
||||
confirm ownership of the 3PID.
|
||||
To validate the 3PID, the identity server creates a session associated with a secret token. That token is sent via a message
|
||||
to the 3PID (e.g. an email) with a the necessary info so the user can submit them to the Identity Server, confirm ownership
|
||||
of the 3PID.
|
||||
|
||||
Once this 3PID is validated, the Homeserver will publish the user Matrix ID on the Identity Server and
|
||||
add this 3PID to the Matrix account which initiated the request.
|
||||
Once this 3PID is validated, the Homeserver will request that the Identity Server links the provided user Matrix ID with
|
||||
the 3PID session and finally add the 3PID to its own data store.
|
||||
|
||||
This serves two purposes:
|
||||
- Add the 3PID as an administrative/login info for the Homeserver directly
|
||||
- Publish, or *Bind*, the 3PID so it can be queried from Homeservers and clients when inviting someone in a room
|
||||
- Links, called *Bind*, the 3PID so it can be queried from Homeservers and clients when inviting someone in a room
|
||||
by a 3PID, allowing it to be resolved to a Matrix ID.
|
||||
|
||||
## Federation
|
||||
## Restrictions
|
||||
### Bindings
|
||||
mxisd does not store bindings directly. While a user can see its email, phone number or any other 3PID in its
|
||||
settings/profile, it does **NOT** mean it is published/saved anywhere or can be used to invite/search the user.
|
||||
|
||||
Identity stores are the ones holding such data, irrelevant if a user added a 3PID to their profile. When queried for
|
||||
bindings, mxisd will query Identity stores which are responsible to store this kind of information.
|
||||
|
||||
Therefore, by default, any 3PID added to a user profile which is NOT within a configured and enabled Identity backend
|
||||
will simply not be usable for search or invites, **even on the same Homeserver!**
|
||||
|
||||
To have such 3PID bindings available for search and invite queries on synapse, use its dedicated
|
||||
[Identity store](../../stores/synapse.md).
|
||||
|
||||
### Federation
|
||||
In a federated set up, identity servers must cooperate to find the Matrix ID associated with a 3PID.
|
||||
|
||||
Federation is based on the principle that each server is responsible for its own (dns) domain.
|
||||
@@ -43,61 +53,15 @@ Example: a user from Homeserver `example.org` adds an email `john@example.com`.
|
||||
Federated identity servers would try to find the identity server at `example.com` and ask it for the Matrix ID of associated with `john@example.com`.
|
||||
|
||||
Nevertheless, Matrix users might add 3PIDs that are not associated to a domain, for example telephone numbers.
|
||||
Or they might even add 3PIDs associated to a different domain (such as an email address hosted by gmail).
|
||||
Such 3PIDs cannot be resolved in a federated way.
|
||||
Or they might even add 3PIDs associated to a different domain (such as an email address hosted by Gmail).
|
||||
Such 3PIDs cannot be resolved in a federated way and will not be found from other servers.
|
||||
|
||||
Example: a user from Homeserver `example.org` adds an email `john@gmail.com`.
|
||||
If a federated lookup was performed, Identity servers would try to find the 3PID bind at the `gmail.com` server, and
|
||||
not `example.org`.
|
||||
|
||||
In order to resolve such 3PIDs, i.e. 3PIDs that cannot be resolved in a Federated way, an identity server can be configured such that
|
||||
- 3PIDs that cannot be resolved locally or using federation, are fowarded to another global identity server.
|
||||
- registration of new 3PIDs that cannot be looked up in a federated fashion, is forwarded to another global identity server.
|
||||
|
||||
By forwarding a 3PIDs registration the identity creates a *Remote session* and *Remote bind*, effectively starting a new 3PID session with another Identity server on
|
||||
behalf of the user.
|
||||
|
||||
To ensure lookup works consistency within the current Matrix network, the central Matrix.org Identity Server should be
|
||||
used to store *remote* sessions and binds.
|
||||
|
||||
However, at the time of writing, the Matrix specification and the central Matrix.org servers do not allow to remote a 3PID bind.
|
||||
This means that once a 3PID is published (email, phone number, etc.), it cannot be easily removed
|
||||
and would require contacting the Matrix.org administrators for each bind individually.
|
||||
This poses a privacy, control and security concern, especially for groups/corporations that want to keep a tight control
|
||||
on where such identifiers can be made publicly visible.
|
||||
|
||||
To ensure full control, validation management relies on two concepts:
|
||||
- The scope of 3PID being validated
|
||||
- The scope of 3PID sessions that should be possible/offered
|
||||
|
||||
### 3PID scope
|
||||
3PID can either be scoped as local or remote.
|
||||
|
||||
Local means that they can be looked up using federation and that such a federation call would end up on the local
|
||||
Identity Server.
|
||||
Remote means that they cannot be lookup using federation or that a federation call would not end up on the local
|
||||
Identity Server.
|
||||
|
||||
Email addresses can either be local or remote 3PID, depending on the domain. If the address is one from the configured
|
||||
domain in the Identity server, it will be scoped as local. If it is from another domain, it will be as remote.
|
||||
|
||||
Phone number can only be scoped as remote, since there is currently no way to perform DNS queries that would lead back
|
||||
to the Identity server who validated the phone number.
|
||||
|
||||
### Session scope
|
||||
Sessions can be scoped as:
|
||||
- Local only - validate 3PIDs directly, do not allow the creation of 3PID sessions on a remote Identity server.
|
||||
- Local and Remote - validate 3PIDs directly, offer users to option to also validate and bind 3PID on another server.
|
||||
- Remote only - validate and bind 3PIDs on another server, no validation or bind done locally.
|
||||
|
||||
---
|
||||
|
||||
**IMPORTANT NOTE:** mxisd does not store bindings directly. While a user can see its email, phone number or any other
|
||||
3PID in its settings/profile, it does **NOT** mean it is published anywhere and can be used to invite/search the user.
|
||||
Identity stores are the ones holding such data.
|
||||
If you still want added arbitrary 3PIDs to be discoverable on a synapse Homeserver, use the corresponding [Identity store](../../stores/synapse.md).
|
||||
|
||||
See the [Scenarios](#scenarios) for more info on how and why.
|
||||
As mxisd is built for self-hosted use cases, mainly for orgs/corps, this is usually not a problem for emails.
|
||||
Sadly, there is currently no mechanism to make this work for phone numbers.
|
||||
|
||||
## Notifications
|
||||
3PIDs are validated by sending a pre-formatted message containing a token to that 3PID address, which must be given to the
|
||||
@@ -126,44 +90,36 @@ Connectors:
|
||||
|
||||
## Usage
|
||||
### Configuration
|
||||
The following example of configuration (incomplete extract) shows which items are relevant for 3PID sessions.
|
||||
The following example of configuration shows which items are relevant for 3PID sessions.
|
||||
|
||||
**IMPORTANT:** Most configuration items shown have default values and should not be included in your own configuration
|
||||
file unless you want to specifically overwrite them.
|
||||
```yaml
|
||||
# CONFIGURATION EXAMPLE
|
||||
# DO NOT COPY/PASTE THIS IN YOUR CONFIGURATION
|
||||
session.policy.validation.enabled: true
|
||||
session.policy.validation.forLocal:
|
||||
enabled: true
|
||||
toLocal: true
|
||||
toRemote:
|
||||
enabled: true
|
||||
server: 'configExample' # Not to be included in config! Already present in default config!
|
||||
session.policy.validation.forRemote:
|
||||
enabled: true
|
||||
toLocal: true
|
||||
toRemote:
|
||||
enabled: true
|
||||
server: 'configExample' # Not to be included in config! Already present in default config!
|
||||
# DO NOT COPY/PASTE THIS IN YOUR CONFIGURATION
|
||||
# DO NOT COPY/PASTE AS-IS IN YOUR CONFIGURATION
|
||||
|
||||
session:
|
||||
policy:
|
||||
validation:
|
||||
enabled: true
|
||||
unbind:
|
||||
fraudulent:
|
||||
sendWarning: true
|
||||
|
||||
# DO NOT COPY/PASTE AS-IS IN YOUR CONFIGURATION
|
||||
# CONFIGURATION EXAMPLE
|
||||
```
|
||||
|
||||
`session.policy.validation` is the core configuration to control what users configured to use your Identity server
|
||||
are allowed to do in terms of 3PID sessions.
|
||||
are allowed to do in terms of 3PID sessions. The policy has a global on/off switch for 3PID sessions using `.enabled`
|
||||
|
||||
The policy has a global on/off switch for 3PID sessions using `.enabled`
|
||||
It is also divided into two sections: `forLocal` and `forRemote` which refers to the 3PID scopes.
|
||||
---
|
||||
|
||||
Each scope is divided into three parts:
|
||||
- global on/off switch for 3PID sessions using `.enabled`
|
||||
- `toLocal` allowing or not local 3PID session validations
|
||||
- `toRemote` allowing or not remote 3PID session validations and to which server such sessions should be sent.
|
||||
`.server` takes a Matrix Identity server list label. Only the first server in the list is currently used.
|
||||
`unbind.fraudulent` controls warning notifications if an illegal/fraudulent 3PID removal is attempted on the Identity server.
|
||||
This is directly related to synapse disregard for privacy and new GDPR laws in Europe in an attempt to inform users about
|
||||
potential privacy leaks.
|
||||
|
||||
If both `toLocal` and `toRemote` are enabled, the user will be offered to initiate a remote session once their 3PID
|
||||
locally validated.
|
||||
For more information, see the corresponding [synapse issue](https://github.com/matrix-org/synapse/issues/4540).
|
||||
|
||||
### Web views
|
||||
Once a user click on a validation link, it is taken to the Identity Server validation page where the token is submitted.
|
||||
@@ -174,103 +130,18 @@ See [the dedicated document](session-views.md)
|
||||
on how to configure/customize/brand those pages to your liking.
|
||||
|
||||
### Scenarios
|
||||
It is important to keep in mind that mxisd does not create bindings, irrelevant if a user added a 3PID to their profile.
|
||||
Instead, when queried for bindings, mxisd will query Identity stores which are responsible to store this kind of information.
|
||||
|
||||
This has the side effect that any 3PID added to a user profile which is NOT within a configured and enabled Identity backend
|
||||
will simply not be usable for search or invites, **even on the same Homeserver!**
|
||||
mxisd does not store binds on purpose, as one of its primary goal is to ensure maximum compatibility with federation
|
||||
and the rest of the Matrix ecosystem is preserved.
|
||||
|
||||
Nonetheless, because mxisd also aims at offering support for tight control over identity data, it is possible to have
|
||||
such 3PID bindings available for search and invite queries on synapse with the corresponding [Identity store](../../stores/synapse.md).
|
||||
|
||||
See the [Local sessions only](#local-sessions-only) use case for more information on how to configure.
|
||||
|
||||
#### Default
|
||||
By default, mxisd allows the following:
|
||||
|
||||
| | Local Session | Remote Session |
|
||||
|-----------------|-------------------|----------------|
|
||||
| **Local 3PID** | Yes | Yes, offered |
|
||||
| **Remote 3PID** | No, Remote forced | Yes |
|
||||
|
||||
This is usually what people expect and will feel natural to users and does not involve further integration.
|
||||
|
||||
This allows to stay in control for e-mail addresses which domain matches your Matrix environment, still making them
|
||||
discoverable with federation but not recorded in a 3rd party Identity server which is not under your control.
|
||||
Users still get the possibility to publish globally their address if needed.
|
||||
|
||||
Other e-mail addresses and phone number will be redirected to remote sessions to ensure full compatibility with the Matrix
|
||||
ecosystem and other federated servers.
|
||||
|
||||
#### Local sessions only
|
||||
**NOTE:** This does not affect 3PID lookups (queries to find Matrix IDs). See [Federation](../../features/federation.md)
|
||||
to disable remote lookup for those.
|
||||
|
||||
This configuration ensures maximum confidentiality and privacy.
|
||||
Typical use cases:
|
||||
- Private Homeserver, not federated
|
||||
- Internal Homeserver without direct Internet access
|
||||
- Custom product based on Matrix which does not federate
|
||||
|
||||
No 3PID will be sent to a remote Identity server and all validation will be performed locally.
|
||||
On the flip side, people with *Remote* 3PID scopes will not be found from other servers.
|
||||
|
||||
Use the following values:
|
||||
```yaml
|
||||
session.policy.validation.enabled: true
|
||||
session.policy.validation.forLocal:
|
||||
enabled: true
|
||||
toLocal: true
|
||||
toRemote:
|
||||
enabled: false
|
||||
session.policy.validation.forRemote:
|
||||
enabled: true
|
||||
toLocal: true
|
||||
toRemote:
|
||||
enabled: false
|
||||
```
|
||||
|
||||
**IMPORTANT**: When using local-only mode and if you are using synapse, you will also need to enable its dedicated Identity
|
||||
store if you want user searches and invites to work. To do so, see the [dedicated document](../../stores/synapse.md).
|
||||
|
||||
#### Remote sessions only
|
||||
This configuration ensures all 3PID are made public for maximum compatibility and reach within the Matrix ecosystem, at
|
||||
the cost of confidentiality and privacy.
|
||||
|
||||
Typical use cases:
|
||||
- Public Homeserver
|
||||
- Homeserver with registration enabled
|
||||
|
||||
Use the following values:
|
||||
```yaml
|
||||
session.policy.validation.enabled: true
|
||||
session.policy.validation.forLocal:
|
||||
enabled: true
|
||||
toLocal: false
|
||||
toRemote:
|
||||
enabled: true
|
||||
session.policy.validation.forRemote:
|
||||
enabled: true
|
||||
toLocal: false
|
||||
toRemote:
|
||||
enabled: true
|
||||
```
|
||||
|
||||
#### Sessions disabled
|
||||
This configuration would disable 3PID session altogether, preventing users from adding emails and/or phone numbers to
|
||||
their profiles.
|
||||
This configuration would disable 3PID sessions altogether, preventing users from validating emails and/or phone numbers
|
||||
and any subsequent actions that requires them, like adding them to their profiles.
|
||||
|
||||
This would be used if mxisd is also performing authentication for the Homeserver, typically with synapse and the
|
||||
[REST password provider](https://github.com/kamax-io/matrix-synapse-rest-auth).
|
||||
|
||||
**This mode comes with several important restrictions:**
|
||||
- This does not prevent users from removing 3PID from their profile. They would be unable to add them back!
|
||||
- This prevents users from initiating remote session to make their 3PID binds globally visible
|
||||
|
||||
It is therefore recommended to not fully disable sessions but instead restrict specific set of 3PID and Session scopes.
|
||||
[REST password provider](https://github.com/kamax-matrix/matrix-synapse-rest-auth), where 3PID mappings would be
|
||||
auto-populated.
|
||||
|
||||
Use the following values to enable this mode:
|
||||
```yaml
|
||||
session.policy.validation.enabled: false
|
||||
session:
|
||||
policy:
|
||||
validation:
|
||||
enabled: false
|
||||
```
|
||||
|
53
docs/troubleshooting.md
Normal file
53
docs/troubleshooting.md
Normal file
@@ -0,0 +1,53 @@
|
||||
# Troubleshooting
|
||||
- [Purpose](#purpose)
|
||||
- [Logs](#logs)
|
||||
- [Locations](#locations)
|
||||
- [Reading Them](#reading-them)
|
||||
- [Common issues](#common-issues)
|
||||
- [Submit an issue](#submit-an-issue)
|
||||
|
||||
## Purpose
|
||||
This document describes basic troubleshooting steps for mxisd.
|
||||
|
||||
## Logs
|
||||
### Locations
|
||||
mxisd logs to `STDOUT` (Standard Output) and `STDERR` (Standard Error) only, which gets redirected
|
||||
to log file(s) depending on your system.
|
||||
|
||||
If you use the [Debian package](install/debian.md), this goes to `syslog`.
|
||||
If you use the [Docker image](install/docker.md), this goes to the container logs.
|
||||
|
||||
For any other platform, please refer to your package maintainer.
|
||||
|
||||
### Reading them
|
||||
Before reporting an issue, it is important to produce clean and complete logs so they can be understood.
|
||||
|
||||
It is usually useless to try to troubleshoot an issue based on a single log line. Any action or API request
|
||||
in mxisd would trigger more than one log lines, and those would be considered necessary context to
|
||||
understand what happened.
|
||||
|
||||
You may also find things called *stacktraces*. Those are important to pin-point bugs and the likes and should
|
||||
always be included in any report. They also tend to be very specific about the issue at hand.
|
||||
|
||||
Example of a stacktrace:
|
||||
```
|
||||
Exception in thread "main" java.lang.NullPointerException
|
||||
at com.example.myproject.Book.getTitle(Book.java:16)
|
||||
at com.example.myproject.Author.getBookTitles(Author.java:25)
|
||||
at com.example.myproject.Bootstrap.main(Bootstrap.java:14)
|
||||
```
|
||||
|
||||
### Common issues
|
||||
#### Internal Server Error
|
||||
`Contact your administrator with reference Transaction #123456789`
|
||||
|
||||
This is a generic message produced in case of an unknown error. The transaction reference allows to easily find
|
||||
the location in the logs to look for an error.
|
||||
|
||||
**IMPORTANT:** That line alone does not tell you anything about the error. You'll need the log lines before and after,
|
||||
usually including a stacktrace, to know what happened. Please take the time to read the surround output to get
|
||||
context about the issue at hand.
|
||||
|
||||
## Submit an issue
|
||||
In case the logs do not allow you to understand the issue at hand, please submit clean and complete logs
|
||||
as explained [here](#reading-them) in a new issue on the repository, or [get in touch](../README.md#contact).
|
111
mxisd.example.yaml
Normal file
111
mxisd.example.yaml
Normal file
@@ -0,0 +1,111 @@
|
||||
# Sample configuration file explaining the minimum required keys to be set to run mxisd
|
||||
#
|
||||
# For a complete list of options, see https://github.com/kamax-matrix/mxisd/docs/README.md
|
||||
#
|
||||
# Please follow the Getting Started guide if this is your first time using/configuring mxisd
|
||||
#
|
||||
# -- https://github.com/kamax-matrix/mxisd/blob/master/docs/getting-started.md#getting-started
|
||||
#
|
||||
|
||||
#######################
|
||||
# Matrix config items #
|
||||
#######################
|
||||
# Matrix domain, same as the domain configure in your Homeserver configuration.
|
||||
# NOTE: in Synapse Homeserver, the Matrix domain is defined as 'server_name' in configuration file.
|
||||
#
|
||||
# This is used to build the various identifiers in all the features.
|
||||
#
|
||||
# If the hostname of the public URL used to reach your Matrix services is different from your Matrix domain,
|
||||
# per example matrix.domain.tld vs domain.tld, then use the server.name configuration option.
|
||||
# See the "Configure" section of the Getting Started guide for more info.
|
||||
#
|
||||
matrix:
|
||||
domain: ''
|
||||
|
||||
|
||||
################
|
||||
# Signing keys #
|
||||
################
|
||||
# Absolute path for the Identity Server signing keys database.
|
||||
# /!\ THIS MUST **NOT** BE YOUR HOMESERVER KEYS FILE /!\
|
||||
# If this path does not exist, it will be auto-generated.
|
||||
#
|
||||
# During testing, /var/tmp/mxisd/keys is a possible value
|
||||
# For production, recommended location shall be one of the following:
|
||||
# - /var/lib/mxisd/keys
|
||||
# - /var/opt/mxisd/keys
|
||||
# - /var/local/mxisd/keys
|
||||
#
|
||||
key:
|
||||
path: ''
|
||||
|
||||
|
||||
# Path to the SQLite DB file for mxisd internal storage
|
||||
# /!\ THIS MUST **NOT** BE YOUR HOMESERVER DATABASE /!\
|
||||
#
|
||||
# Examples:
|
||||
# - /var/opt/mxisd/store.db
|
||||
# - /var/local/mxisd/store.db
|
||||
# - /var/lib/mxisd/store.db
|
||||
#
|
||||
storage:
|
||||
provider:
|
||||
sqlite:
|
||||
database: '/path/to/mxisd.db'
|
||||
|
||||
|
||||
###################
|
||||
# Identity Stores #
|
||||
###################
|
||||
# If you are using synapse standalone and do not have an Identity store,
|
||||
# see https://github.com/kamax-matrix/mxisd/blob/master/docs/stores/synapse.md#synapse-identity-store
|
||||
#
|
||||
# If you would like to integrate with your AD/Samba/LDAP server,
|
||||
# see https://github.com/kamax-matrix/mxisd/blob/master/docs/stores/ldap.md
|
||||
#
|
||||
# For any other Identity store, or to simply discover them,
|
||||
# see https://github.com/kamax-matrix/mxisd/blob/master/docs/stores/README.md
|
||||
|
||||
|
||||
#################################################
|
||||
# Notifications for invites/addition to profile #
|
||||
#################################################
|
||||
# This is mandatory to deal with anything e-mail related.
|
||||
#
|
||||
# For an introduction to sessions, invites and 3PIDs in general,
|
||||
# see https://github.com/kamax-matrix/mxisd/blob/master/docs/threepids/session/session.md#3pid-sessions
|
||||
#
|
||||
# If you would like to change the content of the notifications,
|
||||
# see https://github.com/kamax-matrix/mxisd/blob/master/docs/threepids/notification/template-generator.md
|
||||
#
|
||||
#### E-mail connector
|
||||
threepid:
|
||||
medium:
|
||||
email:
|
||||
identity:
|
||||
# The e-mail to send as.
|
||||
from: "matrix-identity@example.org"
|
||||
|
||||
connectors:
|
||||
smtp:
|
||||
# SMTP host
|
||||
host: "smtp.example.org"
|
||||
|
||||
# SMTP port
|
||||
port: 587
|
||||
|
||||
# STARTLS mode for the connection.
|
||||
# SSL/TLS is currently not supported. See https://github.com/kamax-matrix/mxisd/issues/125
|
||||
#
|
||||
# Possible values:
|
||||
# 0 Disable any kind of TLS entirely
|
||||
# 1 Enable STARTLS if supported by server (default)
|
||||
# 2 Force STARTLS and fail if not available
|
||||
#
|
||||
tls: 1
|
||||
|
||||
# Login for SMTP
|
||||
login: "matrix-identity@example.org"
|
||||
|
||||
# Password for the account
|
||||
password: "ThePassword"
|
@@ -3,5 +3,7 @@ Maintainer: Kamax.io <foss@kamax.io>
|
||||
Homepage: https://github.com/kamax-matrix/mxisd
|
||||
Description: Federated Matrix Identity Server
|
||||
Architecture: all
|
||||
Section: net
|
||||
Priority: optional
|
||||
Depends: openjdk-8-jre | openjdk-8-jre-headless | openjdk-8-jdk | openjdk-8-jdk-headless
|
||||
Version: 0
|
||||
|
@@ -6,8 +6,8 @@ useradd -r mxisd || true
|
||||
# Set permissions for data directory
|
||||
chown -R mxisd:mxisd %DEB_DATA_DIR%
|
||||
|
||||
# Create symlink to mxusd
|
||||
ln -sfT /usr/lib/mxisd/mxisd.jar /usr/bin/mxisd
|
||||
# Create symlink to mxisd run script
|
||||
ln -sfT /usr/lib/mxisd/mxisd /usr/bin/mxisd
|
||||
|
||||
# Enable systemd service
|
||||
systemctl enable mxisd.service
|
||||
|
@@ -1,25 +1,34 @@
|
||||
#!/usr/bin/env bash
|
||||
#!/bin/bash
|
||||
|
||||
if [[ -n "$CONF_FILE_PATH" ]] && [ ! -f "$CONF_FILE_PATH" ]; then
|
||||
echo "Generating config file $CONF_FILE_PATH"
|
||||
touch "CONF_FILE_PATH"
|
||||
|
||||
if [[ -n "$MATRIX_DOMAIN" ]]; then
|
||||
echo "Setting matrix domain to $MATRIX_DOMAIN"
|
||||
echo "matrix.domain: $MATRIX_DOMAIN" >> "$CONF_FILE_PATH"
|
||||
echo "matrix:" >> "$CONF_FILE_PATH"
|
||||
echo " domain: '$MATRIX_DOMAIN'" >> "$CONF_FILE_PATH"
|
||||
echo >> "$CONF_FILE_PATH"
|
||||
fi
|
||||
|
||||
if [[ -n "$SIGN_KEY_PATH" ]]; then
|
||||
echo "Setting signing key path to $SIGN_KEY_PATH"
|
||||
echo "key.path: $SIGN_KEY_PATH" >> "$CONF_FILE_PATH"
|
||||
echo "key:" >> "$CONF_FILE_PATH"
|
||||
echo " path: '$SIGN_KEY_PATH'" >> "$CONF_FILE_PATH"
|
||||
echo >> "$CONF_FILE_PATH"
|
||||
fi
|
||||
|
||||
if [[ -n "$SQLITE_DATABASE_PATH" ]]; then
|
||||
echo "Setting SQLite DB path to $SQLITE_DATABASE_PATH"
|
||||
echo "storage.provider.sqlite.database: $SQLITE_DATABASE_PATH" >> "$CONF_FILE_PATH"
|
||||
echo "storage:" >> "$CONF_FILE_PATH"
|
||||
echo " provider:" >> "$CONF_FILE_PATH"
|
||||
echo " sqlite:" >> "$CONF_FILE_PATH"
|
||||
echo " database: '$SQLITE_DATABASE_PATH'" >> "$CONF_FILE_PATH"
|
||||
echo >> "$CONF_FILE_PATH"
|
||||
fi
|
||||
|
||||
echo "Starting mxisd..."
|
||||
echo
|
||||
fi
|
||||
|
||||
exec java $JAVA_OPTS -Djava.security.egd=file:/dev/./urandom -Dspring.config.location=/etc/mxisd/ -Dspring.config.name=mxisd -jar /mxisd.jar
|
||||
exec java -jar /app/mxisd.jar -c /etc/mxisd/mxisd.yaml
|
||||
|
@@ -1,27 +1,26 @@
|
||||
/*
|
||||
* The MIT License
|
||||
*
|
||||
* Copyright (c) 2013 Edin Dazdarevic (edin.dazdarevic@gmail.com)
|
||||
* The MIT License
|
||||
*
|
||||
* Copyright (c) 2013 Edin Dazdarevic (edin.dazdarevic@gmail.com)
|
||||
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*
|
||||
* */
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
|
||||
package edazdarevic.commons.net;
|
||||
|
||||
@@ -37,6 +36,7 @@ import java.util.List;
|
||||
* both IPv4 and IPv6.
|
||||
*/
|
||||
public class CIDRUtils {
|
||||
|
||||
private final String cidr;
|
||||
|
||||
private InetAddress inetAddress;
|
||||
@@ -44,7 +44,6 @@ public class CIDRUtils {
|
||||
private InetAddress endAddress;
|
||||
private final int prefixLength;
|
||||
|
||||
|
||||
public CIDRUtils(String cidr) throws UnknownHostException {
|
||||
|
||||
this.cidr = cidr;
|
||||
@@ -66,7 +65,6 @@ public class CIDRUtils {
|
||||
|
||||
|
||||
private void calculate() throws UnknownHostException {
|
||||
|
||||
ByteBuffer maskBuffer;
|
||||
int targetSize;
|
||||
if (inetAddress.getAddress().length == 4) {
|
||||
@@ -120,14 +118,9 @@ public class CIDRUtils {
|
||||
}
|
||||
|
||||
public String getNetworkAddress() {
|
||||
|
||||
return this.startAddress.getHostAddress();
|
||||
}
|
||||
|
||||
public String getBroadcastAddress() {
|
||||
return this.endAddress.getHostAddress();
|
||||
}
|
||||
|
||||
public boolean isInRange(String ipAddress) throws UnknownHostException {
|
||||
InetAddress address = InetAddress.getByName(ipAddress);
|
||||
BigInteger start = new BigInteger(1, this.startAddress.getAddress());
|
||||
@@ -139,4 +132,5 @@ public class CIDRUtils {
|
||||
|
||||
return (st == -1 || st == 0) && (te == -1 || te == 0);
|
||||
}
|
||||
|
||||
}
|
||||
|
147
src/main/java/io/kamax/mxisd/HttpMxisd.java
Normal file
147
src/main/java/io/kamax/mxisd/HttpMxisd.java
Normal file
@@ -0,0 +1,147 @@
|
||||
/*
|
||||
* mxisd - Matrix Identity Server Daemon
|
||||
* Copyright (C) 2018 Kamax Sarl
|
||||
*
|
||||
* https://www.kamax.io/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package io.kamax.mxisd;
|
||||
|
||||
import io.kamax.mxisd.config.MxisdConfig;
|
||||
import io.kamax.mxisd.http.undertow.handler.InternalInfoHandler;
|
||||
import io.kamax.mxisd.http.undertow.handler.OptionsHandler;
|
||||
import io.kamax.mxisd.http.undertow.handler.SaneHandler;
|
||||
import io.kamax.mxisd.http.undertow.handler.as.v1.AsNotFoundHandler;
|
||||
import io.kamax.mxisd.http.undertow.handler.as.v1.AsTransactionHandler;
|
||||
import io.kamax.mxisd.http.undertow.handler.as.v1.AsUserHandler;
|
||||
import io.kamax.mxisd.http.undertow.handler.auth.RestAuthHandler;
|
||||
import io.kamax.mxisd.http.undertow.handler.auth.v1.LoginGetHandler;
|
||||
import io.kamax.mxisd.http.undertow.handler.auth.v1.LoginHandler;
|
||||
import io.kamax.mxisd.http.undertow.handler.auth.v1.LoginPostHandler;
|
||||
import io.kamax.mxisd.http.undertow.handler.directory.v1.UserDirectorySearchHandler;
|
||||
import io.kamax.mxisd.http.undertow.handler.identity.v1.*;
|
||||
import io.kamax.mxisd.http.undertow.handler.invite.v1.RoomInviteHandler;
|
||||
import io.kamax.mxisd.http.undertow.handler.profile.v1.InternalProfileHandler;
|
||||
import io.kamax.mxisd.http.undertow.handler.profile.v1.ProfileHandler;
|
||||
import io.kamax.mxisd.http.undertow.handler.register.v1.Register3pidRequestTokenHandler;
|
||||
import io.kamax.mxisd.http.undertow.handler.status.StatusHandler;
|
||||
import io.kamax.mxisd.http.undertow.handler.status.VersionHandler;
|
||||
import io.undertow.Handlers;
|
||||
import io.undertow.Undertow;
|
||||
import io.undertow.server.HttpHandler;
|
||||
|
||||
import java.util.Objects;
|
||||
|
||||
public class HttpMxisd {
|
||||
|
||||
// Core
|
||||
private Mxisd m;
|
||||
|
||||
// I/O
|
||||
private Undertow httpSrv;
|
||||
|
||||
static {
|
||||
// Used in XNIO package, dependency of Undertow
|
||||
// We switch to slf4j
|
||||
System.setProperty("org.jboss.logging.provider", "slf4j");
|
||||
}
|
||||
|
||||
public HttpMxisd(MxisdConfig cfg) {
|
||||
m = new Mxisd(cfg);
|
||||
}
|
||||
|
||||
public void start() {
|
||||
m.start();
|
||||
|
||||
HttpHandler helloHandler = SaneHandler.around(new HelloHandler());
|
||||
|
||||
HttpHandler asUserHandler = SaneHandler.around(new AsUserHandler(m.getAs()));
|
||||
HttpHandler asTxnHandler = SaneHandler.around(new AsTransactionHandler(m.getAs()));
|
||||
HttpHandler asNotFoundHandler = SaneHandler.around(new AsNotFoundHandler(m.getAs()));
|
||||
|
||||
HttpHandler storeInvHandler = SaneHandler.around(new StoreInviteHandler(m.getConfig().getServer(), m.getInvite(), m.getKeyManager()));
|
||||
HttpHandler sessValidateHandler = SaneHandler.around(new SessionValidateHandler(m.getSession(), m.getConfig().getServer(), m.getConfig().getView()));
|
||||
|
||||
httpSrv = Undertow.builder().addHttpListener(m.getConfig().getServer().getPort(), "0.0.0.0").setHandler(Handlers.routing()
|
||||
|
||||
.add("OPTIONS", "/**", SaneHandler.around(new OptionsHandler()))
|
||||
|
||||
// Status endpoints
|
||||
.get(StatusHandler.Path, SaneHandler.around(new StatusHandler()))
|
||||
.get(VersionHandler.Path, SaneHandler.around(new VersionHandler()))
|
||||
|
||||
// Authentication endpoints
|
||||
.get(LoginHandler.Path, SaneHandler.around(new LoginGetHandler(m.getAuth(), m.getHttpClient())))
|
||||
.post(LoginHandler.Path, SaneHandler.around(new LoginPostHandler(m.getAuth())))
|
||||
.post(RestAuthHandler.Path, SaneHandler.around(new RestAuthHandler(m.getAuth())))
|
||||
|
||||
// Directory endpoints
|
||||
.post(UserDirectorySearchHandler.Path, SaneHandler.around(new UserDirectorySearchHandler(m.getDirectory())))
|
||||
|
||||
// Key endpoints
|
||||
.get(KeyGetHandler.Path, SaneHandler.around(new KeyGetHandler(m.getKeyManager())))
|
||||
.get(RegularKeyIsValidHandler.Path, SaneHandler.around(new RegularKeyIsValidHandler(m.getKeyManager())))
|
||||
.get(EphemeralKeyIsValidHandler.Path, SaneHandler.around(new EphemeralKeyIsValidHandler(m.getKeyManager())))
|
||||
|
||||
// Identity endpoints
|
||||
.get(HelloHandler.Path, helloHandler)
|
||||
.get(HelloHandler.Path + "/", helloHandler) // Be lax with possibly trailing slash
|
||||
.get(SingleLookupHandler.Path, SaneHandler.around(new SingleLookupHandler(m.getConfig(), m.getIdentity(), m.getSign())))
|
||||
.post(BulkLookupHandler.Path, SaneHandler.around(new BulkLookupHandler(m.getIdentity())))
|
||||
.post(StoreInviteHandler.Path, storeInvHandler)
|
||||
.post(SessionStartHandler.Path, SaneHandler.around(new SessionStartHandler(m.getSession())))
|
||||
.get(SessionValidateHandler.Path, sessValidateHandler)
|
||||
.post(SessionValidateHandler.Path, sessValidateHandler)
|
||||
.get(SessionTpidGetValidatedHandler.Path, SaneHandler.around(new SessionTpidGetValidatedHandler(m.getSession())))
|
||||
.post(SessionTpidBindHandler.Path, SaneHandler.around(new SessionTpidBindHandler(m.getSession(), m.getInvite())))
|
||||
.post(SessionTpidUnbindHandler.Path, SaneHandler.around(new SessionTpidUnbindHandler(m.getSession())))
|
||||
.post(SignEd25519Handler.Path, SaneHandler.around(new SignEd25519Handler(m.getConfig(), m.getInvite(), m.getSign())))
|
||||
|
||||
// Profile endpoints
|
||||
.get(ProfileHandler.Path, SaneHandler.around(new ProfileHandler(m.getProfile())))
|
||||
.get(InternalProfileHandler.Path, SaneHandler.around(new InternalProfileHandler(m.getProfile())))
|
||||
|
||||
// Registration endpoints
|
||||
.post(Register3pidRequestTokenHandler.Path, SaneHandler.around(new Register3pidRequestTokenHandler(m.getReg(), m.getClientDns(), m.getHttpClient())))
|
||||
|
||||
// Invite endpoints
|
||||
.post(RoomInviteHandler.Path, SaneHandler.around(new RoomInviteHandler(m.getHttpClient(), m.getClientDns(), m.getInvite())))
|
||||
|
||||
// Application Service endpoints
|
||||
.get(AsUserHandler.Path, asUserHandler)
|
||||
.get("/_matrix/app/v1/rooms/**", asNotFoundHandler)
|
||||
.put(AsTransactionHandler.Path, asTxnHandler)
|
||||
|
||||
.get("/users/{" + AsUserHandler.ID + "}", asUserHandler) // Legacy endpoint
|
||||
.get("/rooms/**", asNotFoundHandler) // Legacy endpoint
|
||||
.put("/transactions/{" + AsTransactionHandler.ID + "}", asTxnHandler) // Legacy endpoint
|
||||
|
||||
// Banned endpoints
|
||||
.get(InternalInfoHandler.Path, SaneHandler.around(new InternalInfoHandler()))
|
||||
|
||||
).build();
|
||||
|
||||
httpSrv.start();
|
||||
}
|
||||
|
||||
public void stop() {
|
||||
// Because it might have never been initialized if an exception is thrown early
|
||||
if (Objects.nonNull(httpSrv)) httpSrv.stop();
|
||||
|
||||
m.stop();
|
||||
}
|
||||
|
||||
}
|
203
src/main/java/io/kamax/mxisd/Mxisd.java
Normal file
203
src/main/java/io/kamax/mxisd/Mxisd.java
Normal file
@@ -0,0 +1,203 @@
|
||||
/*
|
||||
* mxisd - Matrix Identity Server Daemon
|
||||
* Copyright (C) 2018 Kamax Sarl
|
||||
*
|
||||
* https://www.kamax.io/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package io.kamax.mxisd;
|
||||
|
||||
import io.kamax.mxisd.as.AppSvcManager;
|
||||
import io.kamax.mxisd.auth.AuthManager;
|
||||
import io.kamax.mxisd.auth.AuthProviders;
|
||||
import io.kamax.mxisd.backend.IdentityStoreSupplier;
|
||||
import io.kamax.mxisd.backend.sql.synapse.Synapse;
|
||||
import io.kamax.mxisd.config.MxisdConfig;
|
||||
import io.kamax.mxisd.crypto.CryptoFactory;
|
||||
import io.kamax.mxisd.crypto.KeyManager;
|
||||
import io.kamax.mxisd.crypto.SignatureManager;
|
||||
import io.kamax.mxisd.crypto.ed25519.Ed25519KeyManager;
|
||||
import io.kamax.mxisd.directory.DirectoryManager;
|
||||
import io.kamax.mxisd.directory.DirectoryProviders;
|
||||
import io.kamax.mxisd.dns.ClientDnsOverwrite;
|
||||
import io.kamax.mxisd.dns.FederationDnsOverwrite;
|
||||
import io.kamax.mxisd.invitation.InvitationManager;
|
||||
import io.kamax.mxisd.lookup.ThreePidProviders;
|
||||
import io.kamax.mxisd.lookup.fetcher.IRemoteIdentityServerFetcher;
|
||||
import io.kamax.mxisd.lookup.provider.BridgeFetcher;
|
||||
import io.kamax.mxisd.lookup.provider.RemoteIdentityServerFetcher;
|
||||
import io.kamax.mxisd.lookup.strategy.LookupStrategy;
|
||||
import io.kamax.mxisd.lookup.strategy.RecursivePriorityLookupStrategy;
|
||||
import io.kamax.mxisd.matrix.IdentityServerUtils;
|
||||
import io.kamax.mxisd.notification.NotificationHandlerSupplier;
|
||||
import io.kamax.mxisd.notification.NotificationHandlers;
|
||||
import io.kamax.mxisd.notification.NotificationManager;
|
||||
import io.kamax.mxisd.profile.ProfileManager;
|
||||
import io.kamax.mxisd.profile.ProfileProviders;
|
||||
import io.kamax.mxisd.registration.RegistrationManager;
|
||||
import io.kamax.mxisd.session.SessionManager;
|
||||
import io.kamax.mxisd.storage.IStorage;
|
||||
import io.kamax.mxisd.storage.ormlite.OrmLiteSqlStorage;
|
||||
import org.apache.commons.lang.StringUtils;
|
||||
import org.apache.http.impl.client.CloseableHttpClient;
|
||||
import org.apache.http.impl.client.HttpClients;
|
||||
|
||||
import java.util.ServiceLoader;
|
||||
|
||||
public class Mxisd {
|
||||
|
||||
public static final String Name = StringUtils.defaultIfBlank(Mxisd.class.getPackage().getImplementationTitle(), "mxisd");
|
||||
public static final String Version = StringUtils.defaultIfBlank(Mxisd.class.getPackage().getImplementationVersion(), "UNKNOWN");
|
||||
public static final String Agent = Name + "/" + Version;
|
||||
|
||||
private MxisdConfig cfg;
|
||||
|
||||
private CloseableHttpClient httpClient;
|
||||
private IRemoteIdentityServerFetcher srvFetcher;
|
||||
|
||||
private IStorage store;
|
||||
|
||||
private Ed25519KeyManager keyMgr;
|
||||
private SignatureManager signMgr;
|
||||
private ClientDnsOverwrite clientDns;
|
||||
|
||||
// Features
|
||||
private AuthManager authMgr;
|
||||
private DirectoryManager dirMgr;
|
||||
private LookupStrategy idStrategy;
|
||||
private InvitationManager invMgr;
|
||||
private ProfileManager pMgr;
|
||||
private AppSvcManager asHander;
|
||||
private SessionManager sessMgr;
|
||||
private NotificationManager notifMgr;
|
||||
private RegistrationManager regMgr;
|
||||
|
||||
// HS-specific classes
|
||||
private Synapse synapse;
|
||||
|
||||
public Mxisd(MxisdConfig cfg) {
|
||||
this.cfg = cfg.build();
|
||||
}
|
||||
|
||||
private void build() {
|
||||
httpClient = HttpClients.custom()
|
||||
.setUserAgent(Agent)
|
||||
.setMaxConnPerRoute(Integer.MAX_VALUE)
|
||||
.setMaxConnTotal(Integer.MAX_VALUE)
|
||||
.build();
|
||||
|
||||
IdentityServerUtils.setHttpClient(httpClient);
|
||||
srvFetcher = new RemoteIdentityServerFetcher(httpClient);
|
||||
|
||||
store = new OrmLiteSqlStorage(cfg);
|
||||
keyMgr = CryptoFactory.getKeyManager(cfg.getKey());
|
||||
signMgr = CryptoFactory.getSignatureManager(keyMgr);
|
||||
clientDns = new ClientDnsOverwrite(cfg.getDns().getOverwrite());
|
||||
FederationDnsOverwrite fedDns = new FederationDnsOverwrite(cfg.getDns().getOverwrite());
|
||||
synapse = new Synapse(cfg.getSynapseSql());
|
||||
BridgeFetcher bridgeFetcher = new BridgeFetcher(cfg.getLookup().getRecursive().getBridge(), srvFetcher);
|
||||
|
||||
ServiceLoader.load(IdentityStoreSupplier.class).iterator().forEachRemaining(p -> p.accept(this));
|
||||
ServiceLoader.load(NotificationHandlerSupplier.class).iterator().forEachRemaining(p -> p.accept(this));
|
||||
|
||||
idStrategy = new RecursivePriorityLookupStrategy(cfg.getLookup(), ThreePidProviders.get(), bridgeFetcher);
|
||||
pMgr = new ProfileManager(ProfileProviders.get(), clientDns, httpClient);
|
||||
notifMgr = new NotificationManager(cfg.getNotification(), NotificationHandlers.get());
|
||||
sessMgr = new SessionManager(cfg.getSession(), cfg.getMatrix(), store, notifMgr, idStrategy, httpClient);
|
||||
invMgr = new InvitationManager(cfg, store, idStrategy, keyMgr, signMgr, fedDns, notifMgr, pMgr);
|
||||
authMgr = new AuthManager(cfg, AuthProviders.get(), idStrategy, invMgr, clientDns, httpClient);
|
||||
dirMgr = new DirectoryManager(cfg.getDirectory(), clientDns, httpClient, DirectoryProviders.get());
|
||||
regMgr = new RegistrationManager(cfg.getRegister(), httpClient, clientDns, invMgr);
|
||||
asHander = new AppSvcManager(this);
|
||||
}
|
||||
|
||||
public MxisdConfig getConfig() {
|
||||
return cfg;
|
||||
}
|
||||
|
||||
public CloseableHttpClient getHttpClient() {
|
||||
return httpClient;
|
||||
}
|
||||
|
||||
public ClientDnsOverwrite getClientDns() {
|
||||
return clientDns;
|
||||
}
|
||||
|
||||
public IRemoteIdentityServerFetcher getServerFetcher() {
|
||||
return srvFetcher;
|
||||
}
|
||||
|
||||
public KeyManager getKeyManager() {
|
||||
return keyMgr;
|
||||
}
|
||||
|
||||
public InvitationManager getInvite() {
|
||||
return invMgr;
|
||||
}
|
||||
|
||||
public LookupStrategy getIdentity() {
|
||||
return idStrategy;
|
||||
}
|
||||
|
||||
public AuthManager getAuth() {
|
||||
return authMgr;
|
||||
}
|
||||
|
||||
public SessionManager getSession() {
|
||||
return sessMgr;
|
||||
}
|
||||
|
||||
public DirectoryManager getDirectory() {
|
||||
return dirMgr;
|
||||
}
|
||||
|
||||
public ProfileManager getProfile() {
|
||||
return pMgr;
|
||||
}
|
||||
|
||||
public SignatureManager getSign() {
|
||||
return signMgr;
|
||||
}
|
||||
|
||||
public RegistrationManager getReg() {
|
||||
return regMgr;
|
||||
}
|
||||
|
||||
public AppSvcManager getAs() {
|
||||
return asHander;
|
||||
}
|
||||
|
||||
public NotificationManager getNotif() {
|
||||
return notifMgr;
|
||||
}
|
||||
|
||||
public IStorage getStore() {
|
||||
return store;
|
||||
}
|
||||
|
||||
public Synapse getSynapse() {
|
||||
return synapse;
|
||||
}
|
||||
|
||||
public void start() {
|
||||
build();
|
||||
}
|
||||
|
||||
public void stop() {
|
||||
// no-op
|
||||
}
|
||||
|
||||
}
|
89
src/main/java/io/kamax/mxisd/MxisdStandaloneExec.java
Normal file
89
src/main/java/io/kamax/mxisd/MxisdStandaloneExec.java
Normal file
@@ -0,0 +1,89 @@
|
||||
/*
|
||||
* mxisd - Matrix Identity Server Daemon
|
||||
* Copyright (C) 2018 Kamax Sarl
|
||||
*
|
||||
* https://www.kamax.io/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package io.kamax.mxisd;
|
||||
|
||||
import io.kamax.mxisd.config.MxisdConfig;
|
||||
import io.kamax.mxisd.config.YamlConfigLoader;
|
||||
import io.kamax.mxisd.exception.ConfigurationException;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
import java.util.Arrays;
|
||||
import java.util.Iterator;
|
||||
import java.util.Objects;
|
||||
|
||||
public class MxisdStandaloneExec {
|
||||
|
||||
private static final Logger log = LoggerFactory.getLogger("App");
|
||||
|
||||
public static void main(String[] args) {
|
||||
try {
|
||||
MxisdConfig cfg = null;
|
||||
Iterator<String> argsIt = Arrays.asList(args).iterator();
|
||||
while (argsIt.hasNext()) {
|
||||
String arg = argsIt.next();
|
||||
if (StringUtils.equalsAny(arg, "-h", "--help", "-?", "--usage")) {
|
||||
System.out.println("Available arguments:" + System.lineSeparator());
|
||||
System.out.println(" -h, --help Show this help message");
|
||||
System.out.println(" --version Print the version then exit");
|
||||
System.out.println(" -c, --config Set the configuration file location");
|
||||
System.out.println(" ");
|
||||
System.exit(0);
|
||||
} else if (StringUtils.equalsAny(arg, "-c", "--config")) {
|
||||
String cfgFile = argsIt.next();
|
||||
cfg = YamlConfigLoader.loadFromFile(cfgFile);
|
||||
} else if (StringUtils.equals("--version", arg)) {
|
||||
System.out.println(Mxisd.Version);
|
||||
System.exit(0);
|
||||
} else {
|
||||
System.err.println("Invalid argument: " + arg);
|
||||
System.err.println("Try '--help' for available arguments");
|
||||
System.exit(1);
|
||||
}
|
||||
}
|
||||
|
||||
log.info("mxisd starting");
|
||||
log.info("Version: {}", Mxisd.Version);
|
||||
|
||||
if (Objects.isNull(cfg)) {
|
||||
cfg = YamlConfigLoader.tryLoadFromFile("mxisd.yaml").orElseGet(MxisdConfig::new);
|
||||
}
|
||||
|
||||
HttpMxisd mxisd = new HttpMxisd(cfg);
|
||||
Runtime.getRuntime().addShutdownHook(new Thread(() -> {
|
||||
mxisd.stop();
|
||||
log.info("mxisd stopped");
|
||||
}));
|
||||
mxisd.start();
|
||||
|
||||
log.info("mxisd started");
|
||||
} catch (ConfigurationException e) {
|
||||
log.error(e.getDetailedMessage());
|
||||
log.error(e.getMessage());
|
||||
System.exit(2);
|
||||
} catch (Throwable t) {
|
||||
t.printStackTrace();
|
||||
System.exit(1);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
@@ -1,211 +0,0 @@
|
||||
/*
|
||||
* mxisd - Matrix Identity Server Daemon
|
||||
* Copyright (C) 2018 Kamax Sarl
|
||||
*
|
||||
* https://www.kamax.io/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package io.kamax.mxisd.as;
|
||||
|
||||
import com.google.gson.JsonObject;
|
||||
import io.kamax.matrix.MatrixID;
|
||||
import io.kamax.matrix.ThreePidMedium;
|
||||
import io.kamax.matrix._MatrixID;
|
||||
import io.kamax.matrix._ThreePid;
|
||||
import io.kamax.matrix.event.EventKey;
|
||||
import io.kamax.matrix.json.GsonUtil;
|
||||
import io.kamax.mxisd.backend.sql.synapse.Synapse;
|
||||
import io.kamax.mxisd.config.ListenerConfig;
|
||||
import io.kamax.mxisd.config.MatrixConfig;
|
||||
import io.kamax.mxisd.notification.NotificationManager;
|
||||
import io.kamax.mxisd.profile.ProfileManager;
|
||||
import io.kamax.mxisd.storage.IStorage;
|
||||
import io.kamax.mxisd.storage.ormlite.dao.ASTransactionDao;
|
||||
import io.kamax.mxisd.util.GsonParser;
|
||||
import org.apache.commons.lang.StringUtils;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
import java.io.InputStream;
|
||||
import java.time.Instant;
|
||||
import java.util.*;
|
||||
import java.util.concurrent.CompletableFuture;
|
||||
import java.util.concurrent.ConcurrentHashMap;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
@Component
|
||||
public class AppServiceHandler {
|
||||
|
||||
private final Logger log = LoggerFactory.getLogger(AppServiceHandler.class);
|
||||
|
||||
private final GsonParser parser;
|
||||
|
||||
private String localpart;
|
||||
private MatrixConfig cfg;
|
||||
private IStorage store;
|
||||
private ProfileManager profiler;
|
||||
private NotificationManager notif;
|
||||
private Synapse synapse;
|
||||
|
||||
private Map<String, CompletableFuture<String>> transactionsInProgress;
|
||||
|
||||
@Autowired
|
||||
public AppServiceHandler(ListenerConfig lCfg, MatrixConfig cfg, IStorage store, ProfileManager profiler, NotificationManager notif, Synapse synapse) {
|
||||
this.cfg = cfg;
|
||||
this.store = store;
|
||||
this.profiler = profiler;
|
||||
this.notif = notif;
|
||||
this.synapse = synapse;
|
||||
|
||||
localpart = lCfg.getLocalpart();
|
||||
parser = new GsonParser();
|
||||
transactionsInProgress = new ConcurrentHashMap<>();
|
||||
}
|
||||
|
||||
public CompletableFuture<String> processTransaction(String txnId, InputStream is) {
|
||||
synchronized (this) {
|
||||
Optional<ASTransactionDao> dao = store.getTransactionResult(localpart, txnId);
|
||||
if (dao.isPresent()) {
|
||||
log.info("AS Transaction {} already processed - returning computed result", txnId);
|
||||
return CompletableFuture.completedFuture(dao.get().getResult());
|
||||
}
|
||||
|
||||
CompletableFuture<String> f = transactionsInProgress.get(txnId);
|
||||
if (Objects.nonNull(f)) {
|
||||
log.info("Returning future for transaction {}", txnId);
|
||||
return f;
|
||||
}
|
||||
|
||||
transactionsInProgress.put(txnId, new CompletableFuture<>());
|
||||
}
|
||||
|
||||
CompletableFuture<String> future = transactionsInProgress.get(txnId);
|
||||
|
||||
Instant start = Instant.now();
|
||||
log.info("Processing AS Transaction {}: start", txnId);
|
||||
try {
|
||||
List<JsonObject> events = GsonUtil.asList(GsonUtil.getArray(parser.parse(is), "events"), JsonObject.class);
|
||||
is.close();
|
||||
log.debug("{} event(s) parsed", events.size());
|
||||
|
||||
processTransaction(events);
|
||||
Instant end = Instant.now();
|
||||
log.info("Processed AS transaction {} in {} ms", txnId, (Instant.now().toEpochMilli() - start.toEpochMilli()));
|
||||
|
||||
String result = "{}";
|
||||
|
||||
try {
|
||||
log.info("Saving transaction details to store");
|
||||
store.insertTransactionResult(localpart, txnId, end, result);
|
||||
} finally {
|
||||
log.debug("Removing CompletedFuture from transaction map");
|
||||
transactionsInProgress.remove(txnId);
|
||||
}
|
||||
|
||||
future.complete(result);
|
||||
} catch (Exception e) {
|
||||
log.error("Unable to properly process transaction {}", txnId, e);
|
||||
future.completeExceptionally(e);
|
||||
}
|
||||
|
||||
log.info("Processing AS Transaction {}: end", txnId);
|
||||
return future;
|
||||
}
|
||||
|
||||
public void processTransaction(List<JsonObject> eventsJson) {
|
||||
log.info("Processing transaction events: start");
|
||||
|
||||
eventsJson.forEach(ev -> {
|
||||
String evId = EventKey.Id.getStringOrNull(ev);
|
||||
if (StringUtils.isBlank(evId)) {
|
||||
log.warn("Event has no ID, skipping");
|
||||
log.debug("Event:\n{}", GsonUtil.getPrettyForLog(ev));
|
||||
return;
|
||||
}
|
||||
log.debug("Event {}: processing start", evId);
|
||||
|
||||
String roomId = EventKey.RoomId.getStringOrNull(ev);
|
||||
if (StringUtils.isBlank(roomId)) {
|
||||
log.debug("Event has no room ID, skipping");
|
||||
return;
|
||||
}
|
||||
|
||||
String senderId = EventKey.Sender.getStringOrNull(ev);
|
||||
if (StringUtils.isBlank(senderId)) {
|
||||
log.debug("Event has no sender ID, skipping");
|
||||
return;
|
||||
}
|
||||
_MatrixID sender = MatrixID.asAcceptable(senderId);
|
||||
log.debug("Sender: {}", senderId);
|
||||
|
||||
if (!StringUtils.equals("m.room.member", GsonUtil.getStringOrNull(ev, "type"))) {
|
||||
log.debug("This is not a room membership event, skipping");
|
||||
return;
|
||||
}
|
||||
|
||||
if (!StringUtils.equals("invite", GsonUtil.getStringOrNull(ev, "membership"))) {
|
||||
log.debug("This is not an invite event, skipping");
|
||||
return;
|
||||
}
|
||||
|
||||
String inviteeId = EventKey.StateKey.getStringOrNull(ev);
|
||||
if (StringUtils.isBlank(inviteeId)) {
|
||||
log.warn("Invalid event: No invitee ID, skipping");
|
||||
return;
|
||||
}
|
||||
|
||||
_MatrixID invitee = MatrixID.asAcceptable(inviteeId);
|
||||
if (!StringUtils.equals(invitee.getDomain(), cfg.getDomain())) {
|
||||
log.debug("Ignoring invite for {}: not a local user");
|
||||
return;
|
||||
}
|
||||
|
||||
log.info("Got invite from {} to {}", senderId, inviteeId);
|
||||
|
||||
boolean wasSent = false;
|
||||
List<_ThreePid> tpids = profiler.getThreepids(invitee).stream()
|
||||
.filter(tpid -> ThreePidMedium.Email.is(tpid.getMedium()))
|
||||
.collect(Collectors.toList());
|
||||
log.info("Found {} email(s) in identity store for {}", tpids.size(), inviteeId);
|
||||
|
||||
for (_ThreePid tpid : tpids) {
|
||||
log.info("Found Email to notify about room invitation: {}", tpid.getAddress());
|
||||
Map<String, String> properties = new HashMap<>();
|
||||
profiler.getDisplayName(sender).ifPresent(name -> properties.put("sender_display_name", name));
|
||||
try {
|
||||
synapse.getRoomName(roomId).ifPresent(name -> properties.put("room_name", name));
|
||||
} catch (RuntimeException e) {
|
||||
log.warn("Could not fetch room name", e);
|
||||
log.info("Unable to fetch room name: Did you integrate your Homeserver as documented?");
|
||||
}
|
||||
|
||||
IMatrixIdInvite inv = new MatrixIdInvite(roomId, sender, invitee, tpid.getMedium(), tpid.getAddress(), properties);
|
||||
notif.sendForInvite(inv);
|
||||
log.info("Notification for invite of {} sent to {}", inviteeId, tpid.getAddress());
|
||||
wasSent = true;
|
||||
}
|
||||
|
||||
log.info("Was notification sent? {}", wasSent);
|
||||
|
||||
log.debug("Event {}: processing end", evId);
|
||||
});
|
||||
|
||||
log.info("Processing transaction events: end");
|
||||
}
|
||||
|
||||
}
|
290
src/main/java/io/kamax/mxisd/as/AppSvcManager.java
Normal file
290
src/main/java/io/kamax/mxisd/as/AppSvcManager.java
Normal file
@@ -0,0 +1,290 @@
|
||||
/*
|
||||
* mxisd - Matrix Identity Server Daemon
|
||||
* Copyright (C) 2018 Kamax Sarl
|
||||
*
|
||||
* https://www.kamax.io/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package io.kamax.mxisd.as;
|
||||
|
||||
import com.google.gson.JsonObject;
|
||||
import io.kamax.matrix.MatrixID;
|
||||
import io.kamax.matrix._MatrixID;
|
||||
import io.kamax.matrix.client.MatrixClientContext;
|
||||
import io.kamax.matrix.client.as.MatrixApplicationServiceClient;
|
||||
import io.kamax.matrix.event.EventKey;
|
||||
import io.kamax.matrix.json.GsonUtil;
|
||||
import io.kamax.mxisd.Mxisd;
|
||||
import io.kamax.mxisd.as.processor.event.EventTypeProcessor;
|
||||
import io.kamax.mxisd.as.processor.event.MembershipEventProcessor;
|
||||
import io.kamax.mxisd.as.processor.event.MessageEventProcessor;
|
||||
import io.kamax.mxisd.as.registration.SynapseRegistrationYaml;
|
||||
import io.kamax.mxisd.config.AppServiceConfig;
|
||||
import io.kamax.mxisd.config.MxisdConfig;
|
||||
import io.kamax.mxisd.exception.ConfigurationException;
|
||||
import io.kamax.mxisd.exception.HttpMatrixException;
|
||||
import io.kamax.mxisd.exception.NotAllowedException;
|
||||
import io.kamax.mxisd.storage.IStorage;
|
||||
import io.kamax.mxisd.storage.ormlite.dao.ASTransactionDao;
|
||||
import io.kamax.mxisd.util.GsonParser;
|
||||
import org.apache.commons.io.IOUtils;
|
||||
import org.apache.commons.lang3.ObjectUtils;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
import org.yaml.snakeyaml.Yaml;
|
||||
import org.yaml.snakeyaml.introspector.BeanAccess;
|
||||
import org.yaml.snakeyaml.representer.Representer;
|
||||
|
||||
import java.io.FileOutputStream;
|
||||
import java.io.IOException;
|
||||
import java.io.InputStream;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.time.Instant;
|
||||
import java.util.*;
|
||||
import java.util.concurrent.CompletableFuture;
|
||||
import java.util.concurrent.ConcurrentHashMap;
|
||||
|
||||
public class AppSvcManager {
|
||||
|
||||
private static final Logger log = LoggerFactory.getLogger(AppSvcManager.class);
|
||||
|
||||
private final AppServiceConfig cfg;
|
||||
private final IStorage store;
|
||||
private final GsonParser parser = new GsonParser();
|
||||
|
||||
private MatrixApplicationServiceClient client;
|
||||
private Map<String, EventTypeProcessor> processors = new HashMap<>();
|
||||
private Map<String, CompletableFuture<String>> transactionsInProgress = new ConcurrentHashMap<>();
|
||||
|
||||
public AppSvcManager(Mxisd m) {
|
||||
this.cfg = m.getConfig().getAppsvc();
|
||||
this.store = m.getStore();
|
||||
|
||||
/*
|
||||
We process the configuration to make sure all is fine and setting default values if needed
|
||||
*/
|
||||
|
||||
// By default, the feature is enabled
|
||||
cfg.setEnabled(ObjectUtils.defaultIfNull(cfg.isEnabled(), false));
|
||||
|
||||
if (!cfg.isEnabled()) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (Objects.isNull(cfg.getEndpoint().getToAS().getUrl())) {
|
||||
throw new ConfigurationException("App Service: Endpoint: To AS: URL");
|
||||
}
|
||||
|
||||
if (Objects.isNull(cfg.getEndpoint().getToAS().getToken())) {
|
||||
throw new ConfigurationException("App Service: Endpoint: To AS: Token", "Must be set, even if to an empty string");
|
||||
}
|
||||
|
||||
if (Objects.isNull(cfg.getEndpoint().getToHS().getUrl())) {
|
||||
throw new ConfigurationException("App Service: Endpoint: To HS: URL");
|
||||
}
|
||||
|
||||
if (Objects.isNull(cfg.getEndpoint().getToHS().getToken())) {
|
||||
throw new ConfigurationException("App Service: Endpoint: To HS: Token", "Must be set, even if to an empty string");
|
||||
}
|
||||
|
||||
// We set a default status for each feature individually
|
||||
cfg.getFeature().getAdmin().setEnabled(ObjectUtils.defaultIfNull(cfg.getFeature().getAdmin().getEnabled(), cfg.isEnabled()));
|
||||
cfg.getFeature().setCleanExpiredInvite(ObjectUtils.defaultIfNull(cfg.getFeature().getCleanExpiredInvite(), cfg.isEnabled()));
|
||||
cfg.getFeature().setInviteById(ObjectUtils.defaultIfNull(cfg.getFeature().getInviteById(), false));
|
||||
|
||||
if (cfg.getFeature().getAdmin().getEnabled()) {
|
||||
if (StringUtils.isBlank(cfg.getUser().getMain())) {
|
||||
throw new ConfigurationException("App Service admin feature is enabled, but no main user configured");
|
||||
}
|
||||
|
||||
if (cfg.getUser().getMain().startsWith("@") || cfg.getUser().getMain().contains(":")) {
|
||||
throw new ConfigurationException("App Service: Users: Main ID: Is not a localpart");
|
||||
}
|
||||
}
|
||||
|
||||
if (cfg.getFeature().getCleanExpiredInvite()) {
|
||||
if (StringUtils.isBlank(cfg.getUser().getInviteExpired())) {
|
||||
throw new ConfigurationException("App Service user for Expired Invite is not set");
|
||||
}
|
||||
|
||||
if (cfg.getUser().getMain().startsWith("@") || cfg.getUser().getMain().contains(":")) {
|
||||
throw new ConfigurationException("App Service: Users: Expired Invite ID: Is not a localpart");
|
||||
}
|
||||
}
|
||||
|
||||
MatrixClientContext mxContext = new MatrixClientContext();
|
||||
mxContext.setDomain(m.getConfig().getMatrix().getDomain());
|
||||
mxContext.setToken(cfg.getEndpoint().getToHS().getToken());
|
||||
mxContext.setHsBaseUrl(cfg.getEndpoint().getToHS().getUrl());
|
||||
client = new MatrixApplicationServiceClient(mxContext);
|
||||
|
||||
processors.put("m.room.member", new MembershipEventProcessor(client, m));
|
||||
processors.put("m.room.message", new MessageEventProcessor(m, client));
|
||||
|
||||
processSynapseConfig(m.getConfig());
|
||||
}
|
||||
|
||||
private void processSynapseConfig(MxisdConfig cfg) {
|
||||
String synapseRegFile = cfg.getAppsvc().getRegistration().getSynapse().getFile();
|
||||
|
||||
if (StringUtils.isBlank(synapseRegFile)) {
|
||||
log.info("No synapse registration file path given - skipping generation...");
|
||||
return;
|
||||
}
|
||||
|
||||
SynapseRegistrationYaml syncCfg = SynapseRegistrationYaml.parse(cfg.getAppsvc(), cfg.getMatrix().getDomain());
|
||||
|
||||
Representer rep = new Representer();
|
||||
rep.getPropertyUtils().setBeanAccess(BeanAccess.FIELD);
|
||||
Yaml yaml = new Yaml(rep);
|
||||
|
||||
// SnakeYAML set the type of object on the first line, which can fail to be parsed on synapse
|
||||
// We therefore need to split the resulting string, remove the first line, and then write it
|
||||
List<String> lines = new ArrayList<>(Arrays.asList(yaml.dump(syncCfg).split("\\R+")));
|
||||
if (StringUtils.equals(lines.get(0), "!!" + SynapseRegistrationYaml.class.getCanonicalName())) {
|
||||
lines.remove(0);
|
||||
}
|
||||
|
||||
try (FileOutputStream os = new FileOutputStream(synapseRegFile)) {
|
||||
IOUtils.writeLines(lines, System.lineSeparator(), os, StandardCharsets.UTF_8);
|
||||
} catch (IOException e) {
|
||||
throw new RuntimeException("Unable to write synapse appservice registration file", e);
|
||||
}
|
||||
}
|
||||
|
||||
private void ensureEnabled() {
|
||||
if (!cfg.isEnabled()) {
|
||||
throw new HttpMatrixException(503, "M_NOT_AVAILABLE", "This feature is disabled");
|
||||
}
|
||||
}
|
||||
|
||||
public AppSvcManager withToken(String token) {
|
||||
ensureEnabled();
|
||||
|
||||
if (StringUtils.isBlank(token)) {
|
||||
throw new HttpMatrixException(401, "M_UNAUTHORIZED", "No HS token");
|
||||
}
|
||||
|
||||
if (!StringUtils.equals(cfg.getEndpoint().getToAS().getToken(), token)) {
|
||||
throw new NotAllowedException("Invalid HS token");
|
||||
}
|
||||
|
||||
return this;
|
||||
}
|
||||
|
||||
public void processUser(String userId) {
|
||||
client.createUser(MatrixID.asAcceptable(userId).getLocalPart());
|
||||
}
|
||||
|
||||
public CompletableFuture<String> processTransaction(String txnId, InputStream is) {
|
||||
ensureEnabled();
|
||||
|
||||
if (StringUtils.isEmpty(txnId)) {
|
||||
throw new IllegalArgumentException("Transaction ID cannot be empty");
|
||||
}
|
||||
|
||||
synchronized (this) {
|
||||
Optional<ASTransactionDao> dao = store.getTransactionResult(cfg.getUser().getMain(), txnId);
|
||||
if (dao.isPresent()) {
|
||||
log.info("AS Transaction {} already processed - returning computed result", txnId);
|
||||
return CompletableFuture.completedFuture(dao.get().getResult());
|
||||
}
|
||||
|
||||
CompletableFuture<String> f = transactionsInProgress.get(txnId);
|
||||
if (Objects.nonNull(f)) {
|
||||
log.info("Returning future for transaction {}", txnId);
|
||||
return f;
|
||||
}
|
||||
|
||||
transactionsInProgress.put(txnId, new CompletableFuture<>());
|
||||
}
|
||||
|
||||
CompletableFuture<String> future = transactionsInProgress.get(txnId);
|
||||
|
||||
Instant start = Instant.now();
|
||||
log.info("Processing AS Transaction {}: start", txnId);
|
||||
try {
|
||||
List<JsonObject> events = GsonUtil.asList(GsonUtil.getArray(parser.parse(is), "events"), JsonObject.class);
|
||||
is.close();
|
||||
log.debug("{} event(s) parsed", events.size());
|
||||
|
||||
processTransaction(events);
|
||||
|
||||
Instant end = Instant.now();
|
||||
String result = "{}";
|
||||
|
||||
try {
|
||||
log.info("Saving transaction details to store");
|
||||
store.insertTransactionResult(cfg.getUser().getMain(), txnId, end, result);
|
||||
} finally {
|
||||
log.debug("Removing CompletedFuture from transaction map");
|
||||
transactionsInProgress.remove(txnId);
|
||||
}
|
||||
|
||||
log.info("Processed AS transaction {} in {} ms", txnId, (Instant.now().toEpochMilli() - start.toEpochMilli()));
|
||||
future.complete(result);
|
||||
} catch (Exception e) {
|
||||
log.error("Unable to properly process transaction {}", txnId, e);
|
||||
future.completeExceptionally(e);
|
||||
}
|
||||
|
||||
log.info("Processing AS Transaction {}: end", txnId);
|
||||
return future;
|
||||
}
|
||||
|
||||
private void processTransaction(List<JsonObject> eventsJson) {
|
||||
log.info("Processing transaction events: start");
|
||||
|
||||
eventsJson.forEach(ev -> {
|
||||
String evId = EventKey.Id.getStringOrNull(ev);
|
||||
if (StringUtils.isBlank(evId)) {
|
||||
log.warn("Event has no ID, skipping");
|
||||
log.debug("Event:\n{}", GsonUtil.getPrettyForLog(ev));
|
||||
return;
|
||||
}
|
||||
log.debug("Event {}: processing start", evId);
|
||||
|
||||
String roomId = EventKey.RoomId.getStringOrNull(ev);
|
||||
if (StringUtils.isBlank(roomId)) {
|
||||
log.debug("Event has no room ID, skipping");
|
||||
return;
|
||||
}
|
||||
|
||||
String senderId = EventKey.Sender.getStringOrNull(ev);
|
||||
if (StringUtils.isBlank(senderId)) {
|
||||
log.debug("Event has no sender ID, skipping");
|
||||
return;
|
||||
}
|
||||
_MatrixID sender = MatrixID.asAcceptable(senderId);
|
||||
log.debug("Sender: {}", senderId);
|
||||
|
||||
String evType = StringUtils.defaultIfBlank(EventKey.Type.getStringOrNull(ev), "<EMPTY/MISSING>");
|
||||
EventTypeProcessor p = processors.get(evType);
|
||||
if (Objects.isNull(p)) {
|
||||
log.debug("No event processor for type {}, skipping", evType);
|
||||
return;
|
||||
}
|
||||
|
||||
p.process(ev, sender, roomId);
|
||||
|
||||
log.debug("Event {}: processing end", evId);
|
||||
});
|
||||
|
||||
log.info("Processing transaction events: end");
|
||||
}
|
||||
|
||||
}
|
@@ -0,0 +1,32 @@
|
||||
/*
|
||||
* mxisd - Matrix Identity Server Daemon
|
||||
* Copyright (C) 2019 Kamax Sarl
|
||||
*
|
||||
* https://www.kamax.io/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package io.kamax.mxisd.as.processor.command;
|
||||
|
||||
import io.kamax.matrix.client._MatrixClient;
|
||||
import io.kamax.matrix.hs._MatrixRoom;
|
||||
import io.kamax.mxisd.Mxisd;
|
||||
import org.apache.commons.cli.CommandLine;
|
||||
|
||||
public interface CommandProcessor {
|
||||
|
||||
void process(Mxisd m, _MatrixClient client, _MatrixRoom room, CommandLine cmdLine);
|
||||
|
||||
}
|
@@ -0,0 +1,117 @@
|
||||
/*
|
||||
* mxisd - Matrix Identity Server Daemon
|
||||
* Copyright (C) 2019 Kamax Sarl
|
||||
*
|
||||
* https://www.kamax.io/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package io.kamax.mxisd.as.processor.command;
|
||||
|
||||
import io.kamax.matrix.client._MatrixClient;
|
||||
import io.kamax.matrix.hs._MatrixRoom;
|
||||
import io.kamax.mxisd.Mxisd;
|
||||
import io.kamax.mxisd.invitation.IThreePidInviteReply;
|
||||
import org.apache.commons.cli.CommandLine;
|
||||
import org.apache.commons.lang.StringUtils;
|
||||
import org.apache.commons.lang.text.StrBuilder;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
public class InviteCommandProcessor implements CommandProcessor {
|
||||
|
||||
public static final String Command = "invite";
|
||||
|
||||
@Override
|
||||
public void process(Mxisd m, _MatrixClient client, _MatrixRoom room, CommandLine cmdLine) {
|
||||
if (cmdLine.getArgs().length < 2) {
|
||||
room.sendNotice(buildHelp());
|
||||
} else {
|
||||
String arg = cmdLine.getArgList().get(1);
|
||||
String response;
|
||||
if (StringUtils.equals("list", arg)) {
|
||||
|
||||
StrBuilder b = new StrBuilder();
|
||||
|
||||
List<IThreePidInviteReply> invites = m.getInvite().listInvites();
|
||||
if (invites.isEmpty()) {
|
||||
b.appendln("No invites!");
|
||||
response = b.toString();
|
||||
} else {
|
||||
b.appendln("Invites:");
|
||||
|
||||
|
||||
for (IThreePidInviteReply invite : invites) {
|
||||
b.appendNewLine().append("ID: ").append(invite.getId());
|
||||
b.appendNewLine().append("Room: ").append(invite.getInvite().getRoomId());
|
||||
b.appendNewLine().append("Medium: ").append(invite.getInvite().getMedium());
|
||||
b.appendNewLine().append("Address: ").append(invite.getInvite().getAddress());
|
||||
b.appendNewLine();
|
||||
}
|
||||
|
||||
response = b.appendNewLine().append("Total: " + invites.size()).toString();
|
||||
}
|
||||
} else if (StringUtils.equals("show", arg)) {
|
||||
if (cmdLine.getArgList().size() < 3) {
|
||||
response = buildHelp();
|
||||
} else {
|
||||
String id = cmdLine.getArgList().get(2);
|
||||
IThreePidInviteReply invite = m.getInvite().getInvite(id);
|
||||
StrBuilder b = new StrBuilder();
|
||||
b.appendln("Details for Invitation #" + id);
|
||||
b.appendNewLine().append("Room: ").append(invite.getInvite().getRoomId());
|
||||
b.appendNewLine().append("Sender: ").append(invite.getInvite().getSender().toString());
|
||||
b.appendNewLine().append("Medium: ").append(invite.getInvite().getMedium());
|
||||
b.appendNewLine().append("Address: ").append(invite.getInvite().getAddress());
|
||||
b.appendNewLine().append("Display name: ").append(invite.getDisplayName());
|
||||
b.appendNewLine().appendNewLine().append("Properties:");
|
||||
invite.getInvite().getProperties().forEach((k, v) -> {
|
||||
b.appendNewLine().append("\t").append(k).append("=").append(v);
|
||||
});
|
||||
b.appendNewLine();
|
||||
|
||||
response = b.toString();
|
||||
}
|
||||
} else if (StringUtils.equals("revoke", arg)) {
|
||||
if (cmdLine.getArgList().size() < 3) {
|
||||
response = buildHelp();
|
||||
} else {
|
||||
m.getInvite().expireInvite(cmdLine.getArgList().get(2));
|
||||
response = "OK";
|
||||
}
|
||||
} else {
|
||||
response = buildError("Unknown invite action: " + arg, true);
|
||||
}
|
||||
|
||||
room.sendNotice(response);
|
||||
}
|
||||
}
|
||||
|
||||
private String buildError(String message, boolean showHelp) {
|
||||
if (showHelp) {
|
||||
message = message + "\n\n" + buildHelp();
|
||||
}
|
||||
|
||||
return message;
|
||||
}
|
||||
|
||||
private String buildHelp() {
|
||||
return "Available actions:\n\n" +
|
||||
"list - List invites\n" +
|
||||
"show ID - Show detailed info about a specific invite\n" +
|
||||
"revoke ID - Revoke a pending invite by resolving it to the configured Expiration user\n";
|
||||
}
|
||||
|
||||
}
|
@@ -0,0 +1,78 @@
|
||||
/*
|
||||
* mxisd - Matrix Identity Server Daemon
|
||||
* Copyright (C) 2019 Kamax Sarl
|
||||
*
|
||||
* https://www.kamax.io/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package io.kamax.mxisd.as.processor.command;
|
||||
|
||||
import io.kamax.matrix.client._MatrixClient;
|
||||
import io.kamax.matrix.hs._MatrixRoom;
|
||||
import io.kamax.mxisd.Mxisd;
|
||||
import io.kamax.mxisd.lookup.SingleLookupReply;
|
||||
import org.apache.commons.cli.CommandLine;
|
||||
import org.apache.commons.lang.text.StrBuilder;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
|
||||
import java.util.Optional;
|
||||
|
||||
public class LookupCommandProcessor implements CommandProcessor {
|
||||
|
||||
public static final String Command = "lookup";
|
||||
|
||||
@Override
|
||||
public void process(Mxisd m, _MatrixClient client, _MatrixRoom room, CommandLine cmdLine) {
|
||||
if (cmdLine.getArgList().size() != 3) {
|
||||
room.sendNotice(getUsage());
|
||||
return;
|
||||
}
|
||||
|
||||
String medium = cmdLine.getArgList().get(1);
|
||||
String address = cmdLine.getArgList().get(2);
|
||||
if (StringUtils.isAnyBlank(medium, address)) {
|
||||
room.sendNotice(getUsage());
|
||||
return;
|
||||
}
|
||||
|
||||
room.sendNotice("Processing...");
|
||||
Optional<SingleLookupReply> r = m.getIdentity().find(medium, address, true);
|
||||
if (!r.isPresent()) {
|
||||
room.sendNotice("No result");
|
||||
return;
|
||||
}
|
||||
|
||||
SingleLookupReply lookup = r.get();
|
||||
StrBuilder b = new StrBuilder();
|
||||
b.append("Result for 3PID lookup of ").append(medium).append(" ").appendln(address).appendNewLine();
|
||||
b.append("Matrix ID: ").appendln(lookup.getMxid().getId());
|
||||
b.appendln("Validity:")
|
||||
.append(" Not Before: ").appendln(lookup.getNotBefore())
|
||||
.append(" Not After: ").appendln(lookup.getNotAfter());
|
||||
b.appendln("Signatures:");
|
||||
lookup.getSignatures().forEach((host, signs) -> {
|
||||
b.append(" ").append(host).appendln(":");
|
||||
signs.forEach((key, sign) -> b.append(" ").append(key).append(" -> ").appendln("OK"));
|
||||
});
|
||||
|
||||
room.sendNotice(b.toString());
|
||||
}
|
||||
|
||||
public String getUsage() {
|
||||
return "lookup MEDIUM ADDRESS";
|
||||
}
|
||||
|
||||
}
|
@@ -0,0 +1,37 @@
|
||||
/*
|
||||
* mxisd - Matrix Identity Server Daemon
|
||||
* Copyright (C) 2019 Kamax Sarl
|
||||
*
|
||||
* https://www.kamax.io/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package io.kamax.mxisd.as.processor.command;
|
||||
|
||||
import io.kamax.matrix.client._MatrixClient;
|
||||
import io.kamax.matrix.hs._MatrixRoom;
|
||||
import io.kamax.mxisd.Mxisd;
|
||||
import org.apache.commons.cli.CommandLine;
|
||||
|
||||
public class PingCommandProcessor implements CommandProcessor {
|
||||
|
||||
public static final String Command = "ping";
|
||||
|
||||
@Override
|
||||
public void process(Mxisd m, _MatrixClient client, _MatrixRoom room, CommandLine cmdLine) {
|
||||
room.sendNotice("Pong!");
|
||||
}
|
||||
|
||||
}
|
@@ -0,0 +1,30 @@
|
||||
/*
|
||||
* mxisd - Matrix Identity Server Daemon
|
||||
* Copyright (C) 2019 Kamax Sarl
|
||||
*
|
||||
* https://www.kamax.io/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package io.kamax.mxisd.as.processor.event;
|
||||
|
||||
import com.google.gson.JsonObject;
|
||||
import io.kamax.matrix._MatrixID;
|
||||
|
||||
public interface EventTypeProcessor {
|
||||
|
||||
void process(JsonObject ev, _MatrixID sender, String roomId);
|
||||
|
||||
}
|
@@ -0,0 +1,172 @@
|
||||
/*
|
||||
* mxisd - Matrix Identity Server Daemon
|
||||
* Copyright (C) 2019 Kamax Sarl
|
||||
*
|
||||
* https://www.kamax.io/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package io.kamax.mxisd.as.processor.event;
|
||||
|
||||
import com.google.gson.JsonObject;
|
||||
import io.kamax.matrix.MatrixID;
|
||||
import io.kamax.matrix.ThreePidMedium;
|
||||
import io.kamax.matrix._MatrixID;
|
||||
import io.kamax.matrix._ThreePid;
|
||||
import io.kamax.matrix.client.as.MatrixApplicationServiceClient;
|
||||
import io.kamax.matrix.event.EventKey;
|
||||
import io.kamax.matrix.hs._MatrixRoom;
|
||||
import io.kamax.mxisd.Mxisd;
|
||||
import io.kamax.mxisd.backend.sql.synapse.Synapse;
|
||||
import io.kamax.mxisd.config.MxisdConfig;
|
||||
import io.kamax.mxisd.invitation.IMatrixIdInvite;
|
||||
import io.kamax.mxisd.invitation.MatrixIdInvite;
|
||||
import io.kamax.mxisd.notification.NotificationManager;
|
||||
import io.kamax.mxisd.profile.ProfileManager;
|
||||
import org.apache.commons.lang.StringUtils;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
public class MembershipEventProcessor implements EventTypeProcessor {
|
||||
|
||||
private final static Logger log = LoggerFactory.getLogger(MembershipEventProcessor.class);
|
||||
|
||||
private MatrixApplicationServiceClient client;
|
||||
|
||||
private final MxisdConfig cfg;
|
||||
private ProfileManager profiler;
|
||||
private NotificationManager notif;
|
||||
private Synapse synapse;
|
||||
|
||||
public MembershipEventProcessor(
|
||||
MatrixApplicationServiceClient client,
|
||||
Mxisd m
|
||||
) {
|
||||
this.client = client;
|
||||
this.cfg = m.getConfig();
|
||||
this.profiler = m.getProfile();
|
||||
this.notif = m.getNotif();
|
||||
this.synapse = m.getSynapse();
|
||||
}
|
||||
|
||||
@Override
|
||||
public void process(JsonObject ev, _MatrixID sender, String roomId) {
|
||||
JsonObject content = EventKey.Content.findObj(ev).orElseGet(() -> {
|
||||
log.debug("No content found, falling back to full object");
|
||||
return ev;
|
||||
});
|
||||
|
||||
String targetId = EventKey.StateKey.getStringOrNull(ev);
|
||||
if (StringUtils.isBlank(targetId)) {
|
||||
log.warn("Invalid event: No invitee ID, skipping");
|
||||
return;
|
||||
}
|
||||
|
||||
_MatrixID target = MatrixID.asAcceptable(targetId);
|
||||
if (!StringUtils.equals(target.getDomain(), cfg.getMatrix().getDomain())) {
|
||||
log.debug("Ignoring invite for {}: not a local user");
|
||||
return;
|
||||
}
|
||||
|
||||
log.info("Got membership event from {} to {} for room {}", sender.getId(), targetId, roomId);
|
||||
|
||||
boolean isForMainUser = StringUtils.equals(target.getLocalPart(), cfg.getAppsvc().getUser().getMain());
|
||||
boolean isForExpInvUser = StringUtils.equals(target.getLocalPart(), cfg.getAppsvc().getUser().getInviteExpired());
|
||||
boolean isUs = isForMainUser || isForExpInvUser;
|
||||
|
||||
if (StringUtils.equals("join", EventKey.Membership.getStringOrNull(content))) {
|
||||
if (!isForMainUser) {
|
||||
log.warn("We joined the room {} for another identity as the main user, which is not supported. Leaving...", roomId);
|
||||
|
||||
client.getUser(target.getLocalPart()).getRoom(roomId).tryLeave().ifPresent(err -> {
|
||||
log.warn("Could not decline invite to room {}: {} - {}", roomId, err.getErrcode(), err.getError());
|
||||
});
|
||||
}
|
||||
} else if (StringUtils.equals("invite", EventKey.Membership.getStringOrNull(content))) {
|
||||
if (isForMainUser) {
|
||||
processForMainUser(roomId, sender);
|
||||
} else if (isForExpInvUser) {
|
||||
processForExpiredInviteUser(roomId, target);
|
||||
} else {
|
||||
processForUserIdInvite(roomId, sender, target);
|
||||
}
|
||||
} else if (StringUtils.equals("leave", EventKey.Membership.getStringOrNull(content))) {
|
||||
_MatrixRoom room = client.getRoom(roomId);
|
||||
if (!isUs && room.getJoinedUsers().size() == 1) {
|
||||
// TODO we need to find out if this is only us remaining and leave the room if so, using the right client for it
|
||||
}
|
||||
} else {
|
||||
log.debug("This is not an supported type of membership event, skipping");
|
||||
}
|
||||
}
|
||||
|
||||
private void processForMainUser(String roomId, _MatrixID sender) {
|
||||
boolean isAllowed = profiler.hasAnyRole(sender, cfg.getAppsvc().getFeature().getAdmin().getAllowedRoles());
|
||||
if (!isAllowed) {
|
||||
log.info("Sender does not have any of the required roles, denying");
|
||||
client.getRoom(roomId).tryLeave().ifPresent(err -> {
|
||||
log.warn("Could not decline invite to room {}: {} - {}", roomId, err.getErrcode(), err.getError());
|
||||
});
|
||||
} else {
|
||||
client.getRoom(roomId).tryJoin().ifPresent(err -> {
|
||||
log.warn("Could not join room {}: {} - {}", roomId, err.getErrcode(), err.getError());
|
||||
client.getRoom(roomId).tryLeave().ifPresent(err1 -> {
|
||||
log.warn("Could not decline invite to room {} after failed join: {} - {}", roomId, err1.getErrcode(), err1.getError());
|
||||
});
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
private void processForExpiredInviteUser(String roomId, _MatrixID invitee) {
|
||||
client.getUser(invitee.getLocalPart()).getRoom(roomId).tryLeave().ifPresent(err -> {
|
||||
log.warn("Could not decline invite to room {}: {} - {}", roomId, err.getErrcode(), err.getError());
|
||||
});
|
||||
}
|
||||
|
||||
private void processForUserIdInvite(String roomId, _MatrixID sender, _MatrixID invitee) {
|
||||
String inviteeId = invitee.getId();
|
||||
|
||||
boolean wasSent = false;
|
||||
List<_ThreePid> tpids = profiler.getThreepids(invitee).stream()
|
||||
.filter(tpid -> ThreePidMedium.Email.is(tpid.getMedium()))
|
||||
.collect(Collectors.toList());
|
||||
log.info("Found {} email(s) in identity store for {}", tpids.size(), inviteeId);
|
||||
|
||||
for (_ThreePid tpid : tpids) {
|
||||
log.info("Found Email to notify about room invitation: {}", tpid.getAddress());
|
||||
Map<String, String> properties = new HashMap<>();
|
||||
profiler.getDisplayName(sender).ifPresent(name -> properties.put("sender_display_name", name));
|
||||
try {
|
||||
synapse.getRoomName(roomId).ifPresent(name -> properties.put("room_name", name));
|
||||
} catch (RuntimeException e) {
|
||||
log.warn("Could not fetch room name", e);
|
||||
log.info("Unable to fetch room name: Did you integrate your Homeserver as documented?");
|
||||
}
|
||||
|
||||
IMatrixIdInvite inv = new MatrixIdInvite(roomId, sender, invitee, tpid.getMedium(), tpid.getAddress(), properties);
|
||||
notif.sendForInvite(inv);
|
||||
log.info("Notification for invite of {} sent to {}", inviteeId, tpid.getAddress());
|
||||
wasSent = true;
|
||||
}
|
||||
|
||||
log.info("Was notification sent? {}", wasSent);
|
||||
}
|
||||
|
||||
}
|
@@ -0,0 +1,127 @@
|
||||
/*
|
||||
* mxisd - Matrix Identity Server Daemon
|
||||
* Copyright (C) 2019 Kamax Sarl
|
||||
*
|
||||
* https://www.kamax.io/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package io.kamax.mxisd.as.processor.event;
|
||||
|
||||
import com.google.gson.JsonObject;
|
||||
import io.kamax.matrix._MatrixID;
|
||||
import io.kamax.matrix._MatrixUserProfile;
|
||||
import io.kamax.matrix.client.as.MatrixApplicationServiceClient;
|
||||
import io.kamax.matrix.hs._MatrixRoom;
|
||||
import io.kamax.matrix.json.event.MatrixJsonRoomMessageEvent;
|
||||
import io.kamax.mxisd.Mxisd;
|
||||
import io.kamax.mxisd.as.processor.command.CommandProcessor;
|
||||
import io.kamax.mxisd.as.processor.command.InviteCommandProcessor;
|
||||
import io.kamax.mxisd.as.processor.command.LookupCommandProcessor;
|
||||
import io.kamax.mxisd.as.processor.command.PingCommandProcessor;
|
||||
import org.apache.commons.cli.*;
|
||||
import org.apache.commons.lang.text.StrBuilder;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.Objects;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
public class MessageEventProcessor implements EventTypeProcessor {
|
||||
|
||||
private static final Logger log = LoggerFactory.getLogger(MessageEventProcessor.class);
|
||||
|
||||
private final Mxisd m;
|
||||
private final MatrixApplicationServiceClient client;
|
||||
private Map<String, CommandProcessor> processors;
|
||||
|
||||
public MessageEventProcessor(Mxisd m, MatrixApplicationServiceClient client) {
|
||||
this.m = m;
|
||||
this.client = client;
|
||||
|
||||
processors = new HashMap<>();
|
||||
processors.put("?", (m1, client1, room, cmdLine) -> room.sendNotice(getHelp()));
|
||||
processors.put("help", (m1, client1, room, cmdLine) -> room.sendNotice(getHelp()));
|
||||
processors.put(PingCommandProcessor.Command, new PingCommandProcessor());
|
||||
processors.put(InviteCommandProcessor.Command, new InviteCommandProcessor());
|
||||
processors.put(LookupCommandProcessor.Command, new LookupCommandProcessor());
|
||||
}
|
||||
|
||||
@Override
|
||||
public void process(JsonObject ev, _MatrixID sender, String roomId) {
|
||||
MatrixJsonRoomMessageEvent msgEv = new MatrixJsonRoomMessageEvent(ev);
|
||||
if (StringUtils.equals("m.notice", msgEv.getBodyType())) {
|
||||
log.info("Ignoring automated message");
|
||||
return;
|
||||
}
|
||||
|
||||
_MatrixRoom room = client.getRoom(roomId);
|
||||
|
||||
if (!m.getProfile().hasAnyRole(sender, m.getConfig().getAppsvc().getFeature().getAdmin().getAllowedRoles())) {
|
||||
room.sendNotice("You are not allowed to interact with me.");
|
||||
return;
|
||||
}
|
||||
|
||||
List<_MatrixID> joinedUsers = room.getJoinedUsers().stream().map(_MatrixUserProfile::getId).collect(Collectors.toList());
|
||||
boolean joinedWithMainUser = joinedUsers.contains(client.getWhoAmI());
|
||||
boolean isAdminPrivate = joinedWithMainUser && joinedUsers.size() == 2;
|
||||
|
||||
if (!StringUtils.equals("m.text", msgEv.getBodyType())) {
|
||||
log.info("Unsupported message event type: {}", msgEv.getBodyType());
|
||||
return;
|
||||
}
|
||||
|
||||
String command = msgEv.getBody();
|
||||
if (!isAdminPrivate) {
|
||||
if (!StringUtils.startsWith(command, "!" + Mxisd.Name + " ")) {
|
||||
// Not for us
|
||||
return;
|
||||
}
|
||||
|
||||
command = command.substring(("!" + Mxisd.Name + " ").length());
|
||||
}
|
||||
|
||||
try {
|
||||
CommandLineParser p = new DefaultParser();
|
||||
CommandLine cmdLine = p.parse(new Options(), command.split(" ", 0));
|
||||
String cmd = cmdLine.getArgList().get(0);
|
||||
|
||||
CommandProcessor cp = processors.get(cmd);
|
||||
if (Objects.isNull(cp)) {
|
||||
room.sendNotice("Unknown command: " + command + "\n\n" + getHelp());
|
||||
} else {
|
||||
cp.process(m, client, room, cmdLine);
|
||||
}
|
||||
} catch (ParseException e) {
|
||||
room.sendNotice("Invalid input" + "\n\n" + getHelp());
|
||||
} catch (RuntimeException e) {
|
||||
room.sendNotice("Error when running command: " + e.getMessage());
|
||||
}
|
||||
}
|
||||
|
||||
public String getHelp() {
|
||||
StrBuilder builder = new StrBuilder();
|
||||
builder.appendln("Available commands:");
|
||||
for (String cmd : processors.keySet()) {
|
||||
builder.append("\t").appendln(cmd);
|
||||
}
|
||||
return builder.toString();
|
||||
}
|
||||
|
||||
}
|
@@ -0,0 +1,176 @@
|
||||
/*
|
||||
* mxisd - Matrix Identity Server Daemon
|
||||
* Copyright (C) 2019 Kamax Sarl
|
||||
*
|
||||
* https://www.kamax.io/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package io.kamax.mxisd.as.registration;
|
||||
|
||||
import io.kamax.mxisd.config.AppServiceConfig;
|
||||
|
||||
import java.net.URL;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import java.util.Objects;
|
||||
|
||||
public class SynapseRegistrationYaml {
|
||||
|
||||
public static SynapseRegistrationYaml parse(AppServiceConfig cfg, String domain) {
|
||||
SynapseRegistrationYaml yaml = new SynapseRegistrationYaml();
|
||||
|
||||
yaml.setId(cfg.getRegistration().getSynapse().getId());
|
||||
yaml.setUrl(cfg.getEndpoint().getToAS().getUrl());
|
||||
yaml.setAsToken(cfg.getEndpoint().getToHS().getToken());
|
||||
yaml.setHsToken(cfg.getEndpoint().getToAS().getToken());
|
||||
yaml.setSenderLocalpart(cfg.getUser().getMain());
|
||||
|
||||
if (cfg.getFeature().getCleanExpiredInvite()) {
|
||||
Namespace ns = new Namespace();
|
||||
ns.setExclusive(true);
|
||||
ns.setRegex("@" + cfg.getUser().getInviteExpired() + ":" + domain);
|
||||
yaml.getNamespaces().getUsers().add(ns);
|
||||
}
|
||||
|
||||
if (cfg.getFeature().getInviteById()) {
|
||||
Namespace ns = new Namespace();
|
||||
ns.setExclusive(false);
|
||||
ns.setRegex("@*:" + domain);
|
||||
yaml.getNamespaces().getUsers().add(ns);
|
||||
}
|
||||
|
||||
return yaml;
|
||||
}
|
||||
|
||||
public static class Namespace {
|
||||
|
||||
private String regex;
|
||||
private boolean exclusive;
|
||||
|
||||
public String getRegex() {
|
||||
return regex;
|
||||
}
|
||||
|
||||
public void setRegex(String regex) {
|
||||
this.regex = regex;
|
||||
}
|
||||
|
||||
public boolean isExclusive() {
|
||||
return exclusive;
|
||||
}
|
||||
|
||||
public void setExclusive(boolean exclusive) {
|
||||
this.exclusive = exclusive;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
public static class Namespaces {
|
||||
|
||||
private List<Namespace> users = new ArrayList<>();
|
||||
private List<Namespace> aliases = new ArrayList<>();
|
||||
private List<Namespace> rooms = new ArrayList<>();
|
||||
|
||||
public List<Namespace> getUsers() {
|
||||
return users;
|
||||
}
|
||||
|
||||
public void setUsers(List<Namespace> users) {
|
||||
this.users = users;
|
||||
}
|
||||
|
||||
public List<Namespace> getAliases() {
|
||||
return aliases;
|
||||
}
|
||||
|
||||
public void setAliases(List<Namespace> aliases) {
|
||||
this.aliases = aliases;
|
||||
}
|
||||
|
||||
public List<Namespace> getRooms() {
|
||||
return rooms;
|
||||
}
|
||||
|
||||
public void setRooms(List<Namespace> rooms) {
|
||||
this.rooms = rooms;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
private String id;
|
||||
private String url;
|
||||
private String as_token;
|
||||
private String hs_token;
|
||||
private String sender_localpart;
|
||||
private Namespaces namespaces = new Namespaces();
|
||||
|
||||
public String getId() {
|
||||
return id;
|
||||
}
|
||||
|
||||
public void setId(String id) {
|
||||
this.id = id;
|
||||
}
|
||||
|
||||
public String getUrl() {
|
||||
return url;
|
||||
}
|
||||
|
||||
public void setUrl(String url) {
|
||||
this.url = url;
|
||||
}
|
||||
|
||||
public void setUrl(URL url) {
|
||||
if (Objects.isNull(url)) {
|
||||
this.url = null;
|
||||
} else {
|
||||
this.url = url.toString();
|
||||
}
|
||||
}
|
||||
|
||||
public String getAsToken() {
|
||||
return as_token;
|
||||
}
|
||||
|
||||
public void setAsToken(String as_token) {
|
||||
this.as_token = as_token;
|
||||
}
|
||||
|
||||
public String getHsToken() {
|
||||
return hs_token;
|
||||
}
|
||||
|
||||
public void setHsToken(String hs_token) {
|
||||
this.hs_token = hs_token;
|
||||
}
|
||||
|
||||
public String getSenderLocalpart() {
|
||||
return sender_localpart;
|
||||
}
|
||||
|
||||
public void setSenderLocalpart(String sender_localpart) {
|
||||
this.sender_localpart = sender_localpart;
|
||||
}
|
||||
|
||||
public Namespaces getNamespaces() {
|
||||
return namespaces;
|
||||
}
|
||||
|
||||
public void setNamespaces(Namespaces namespaces) {
|
||||
this.namespaces = namespaces;
|
||||
}
|
||||
|
||||
}
|
@@ -37,6 +37,7 @@ import io.kamax.mxisd.auth.provider.AuthenticatorProvider;
|
||||
import io.kamax.mxisd.auth.provider.BackendAuthResult;
|
||||
import io.kamax.mxisd.config.AuthenticationConfig;
|
||||
import io.kamax.mxisd.config.MatrixConfig;
|
||||
import io.kamax.mxisd.config.MxisdConfig;
|
||||
import io.kamax.mxisd.dns.ClientDnsOverwrite;
|
||||
import io.kamax.mxisd.exception.RemoteLoginException;
|
||||
import io.kamax.mxisd.invitation.InvitationManager;
|
||||
@@ -53,8 +54,6 @@ import org.apache.http.impl.client.CloseableHttpClient;
|
||||
import org.apache.http.util.EntityUtils;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.stereotype.Service;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.net.URI;
|
||||
@@ -63,7 +62,6 @@ import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import java.util.Objects;
|
||||
|
||||
@Service
|
||||
public class AuthManager {
|
||||
|
||||
private static final String TypeKey = "type";
|
||||
@@ -74,8 +72,8 @@ public class AuthManager {
|
||||
private static final String UserIdTypeValue = "m.id.user";
|
||||
private static final String ThreepidTypeValue = "m.id.thirdparty";
|
||||
|
||||
private final Logger log = LoggerFactory.getLogger(AuthManager.class);
|
||||
private final Gson gson = GsonUtil.get();
|
||||
private transient final Logger log = LoggerFactory.getLogger(AuthManager.class);
|
||||
private final Gson gson = GsonUtil.get(); // FIXME replace
|
||||
|
||||
private List<AuthenticatorProvider> providers;
|
||||
private MatrixConfig mxCfg;
|
||||
@@ -85,18 +83,16 @@ public class AuthManager {
|
||||
private LookupStrategy strategy;
|
||||
private CloseableHttpClient client;
|
||||
|
||||
@Autowired
|
||||
public AuthManager(
|
||||
AuthenticationConfig cfg,
|
||||
MatrixConfig mxCfg,
|
||||
List<AuthenticatorProvider> providers,
|
||||
MxisdConfig cfg,
|
||||
List<? extends AuthenticatorProvider> providers,
|
||||
LookupStrategy strategy,
|
||||
InvitationManager invMgr,
|
||||
ClientDnsOverwrite dns,
|
||||
CloseableHttpClient client
|
||||
) {
|
||||
this.cfg = cfg;
|
||||
this.mxCfg = mxCfg;
|
||||
this.cfg = cfg.getAuth();
|
||||
this.mxCfg = cfg.getMatrix();
|
||||
this.providers = new ArrayList<>(providers);
|
||||
this.strategy = strategy;
|
||||
this.invMgr = invMgr;
|
||||
|
@@ -18,20 +18,25 @@
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package io.kamax.mxisd.controller.identity.v1.remote;
|
||||
package io.kamax.mxisd.auth;
|
||||
|
||||
public class RemoteIdentityAPIv1 {
|
||||
import io.kamax.mxisd.auth.provider.AuthenticatorProvider;
|
||||
|
||||
public static final String BASE = "/_matrix/identity/remote/api/v1";
|
||||
public static final String SESSION_REQUEST_TOKEN = BASE + "/validate/requestToken";
|
||||
public static final String SESSION_CHECK = BASE + "/validate/check";
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import java.util.function.Supplier;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
public static String getRequestToken(String id, String secret) {
|
||||
return SESSION_REQUEST_TOKEN + "?sid=" + id + "&client_secret=" + secret;
|
||||
public class AuthProviders {
|
||||
|
||||
private static final List<Supplier<? extends AuthenticatorProvider>> suppliers = new ArrayList<>();
|
||||
|
||||
public static void register(Supplier<? extends AuthenticatorProvider> supplier) {
|
||||
suppliers.add(supplier);
|
||||
}
|
||||
|
||||
public static String getSessionCheck(String id, String secret) {
|
||||
return SESSION_CHECK + "?sid=" + id + "&client_secret=" + secret;
|
||||
public static List<? extends AuthenticatorProvider> get() {
|
||||
return suppliers.stream().map(Supplier::get).collect(Collectors.toList());
|
||||
}
|
||||
|
||||
}
|
@@ -0,0 +1,29 @@
|
||||
/*
|
||||
* mxisd - Matrix Identity Server Daemon
|
||||
* Copyright (C) 2018 Kamax Sarl
|
||||
*
|
||||
* https://www.kamax.io/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package io.kamax.mxisd.backend;
|
||||
|
||||
import io.kamax.mxisd.Mxisd;
|
||||
|
||||
import java.util.function.Consumer;
|
||||
|
||||
public interface IdentityStoreSupplier extends Consumer<Mxisd> {
|
||||
|
||||
}
|
@@ -33,21 +33,18 @@ import io.kamax.mxisd.exception.InternalServerError;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
import java.util.Objects;
|
||||
import java.util.Optional;
|
||||
|
||||
@Component
|
||||
public class ExecAuthStore extends ExecStore implements AuthenticatorProvider {
|
||||
|
||||
private final Logger log = LoggerFactory.getLogger(ExecAuthStore.class);
|
||||
private transient final Logger log = LoggerFactory.getLogger(ExecAuthStore.class);
|
||||
|
||||
private ExecConfig.Auth cfg;
|
||||
|
||||
@Autowired
|
||||
public ExecAuthStore(ExecConfig cfg) {
|
||||
super(cfg);
|
||||
this.cfg = Objects.requireNonNull(cfg.getAuth());
|
||||
}
|
||||
|
||||
|
@@ -24,34 +24,27 @@ import io.kamax.matrix.MatrixID;
|
||||
import io.kamax.matrix.json.GsonUtil;
|
||||
import io.kamax.mxisd.config.ExecConfig;
|
||||
import io.kamax.mxisd.config.MatrixConfig;
|
||||
import io.kamax.mxisd.controller.directory.v1.io.UserDirectorySearchRequest;
|
||||
import io.kamax.mxisd.controller.directory.v1.io.UserDirectorySearchResult;
|
||||
import io.kamax.mxisd.directory.IDirectoryProvider;
|
||||
import io.kamax.mxisd.config.MxisdConfig;
|
||||
import io.kamax.mxisd.directory.DirectoryProvider;
|
||||
import io.kamax.mxisd.http.io.UserDirectorySearchRequest;
|
||||
import io.kamax.mxisd.http.io.UserDirectorySearchResult;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
@Component
|
||||
public class ExecDirectoryStore extends ExecStore implements IDirectoryProvider {
|
||||
public class ExecDirectoryStore extends ExecStore implements DirectoryProvider {
|
||||
|
||||
private ExecConfig.Directory cfg;
|
||||
private MatrixConfig mxCfg;
|
||||
|
||||
@Autowired
|
||||
public ExecDirectoryStore(MxisdConfig cfg) {
|
||||
this(cfg.getExec(), cfg.getMatrix());
|
||||
}
|
||||
|
||||
public ExecDirectoryStore(ExecConfig cfg, MatrixConfig mxCfg) {
|
||||
this(cfg.getDirectory(), mxCfg);
|
||||
}
|
||||
|
||||
public ExecDirectoryStore(ExecConfig.Directory cfg, MatrixConfig mxCfg) {
|
||||
this.cfg = cfg;
|
||||
super(cfg);
|
||||
this.cfg = cfg.getDirectory();
|
||||
this.mxCfg = mxCfg;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isEnabled() {
|
||||
return cfg.isEnabled();
|
||||
}
|
||||
|
||||
private UserDirectorySearchResult search(ExecConfig.Process cfg, UserDirectorySearchRequest request) {
|
||||
if (StringUtils.isEmpty(cfg.getCommand())) {
|
||||
return UserDirectorySearchResult.empty();
|
||||
|
@@ -40,8 +40,6 @@ import io.kamax.mxisd.lookup.provider.IThreePidProvider;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
import java.util.Collections;
|
||||
import java.util.List;
|
||||
@@ -49,29 +47,19 @@ import java.util.Objects;
|
||||
import java.util.Optional;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
@Component
|
||||
public class ExecIdentityStore extends ExecStore implements IThreePidProvider {
|
||||
|
||||
private final Logger log = LoggerFactory.getLogger(ExecIdentityStore.class);
|
||||
private transient final Logger log = LoggerFactory.getLogger(ExecIdentityStore.class);
|
||||
|
||||
private final ExecConfig.Identity cfg;
|
||||
private final MatrixConfig mxCfg;
|
||||
|
||||
@Autowired
|
||||
public ExecIdentityStore(ExecConfig cfg, MatrixConfig mxCfg) {
|
||||
this(cfg.getIdentity(), mxCfg);
|
||||
}
|
||||
|
||||
public ExecIdentityStore(ExecConfig.Identity cfg, MatrixConfig mxCfg) {
|
||||
this.cfg = cfg;
|
||||
super(cfg);
|
||||
this.cfg = cfg.getIdentity();
|
||||
this.mxCfg = mxCfg;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isEnabled() {
|
||||
return cfg.isEnabled();
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isLocal() {
|
||||
return true;
|
||||
|
@@ -0,0 +1,56 @@
|
||||
/*
|
||||
* mxisd - Matrix Identity Server Daemon
|
||||
* Copyright (C) 2018 Kamax Sarl
|
||||
*
|
||||
* https://www.kamax.io/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package io.kamax.mxisd.backend.exec;
|
||||
|
||||
import io.kamax.mxisd.Mxisd;
|
||||
import io.kamax.mxisd.auth.AuthProviders;
|
||||
import io.kamax.mxisd.backend.IdentityStoreSupplier;
|
||||
import io.kamax.mxisd.config.MxisdConfig;
|
||||
import io.kamax.mxisd.directory.DirectoryProviders;
|
||||
import io.kamax.mxisd.lookup.ThreePidProviders;
|
||||
import io.kamax.mxisd.profile.ProfileProviders;
|
||||
|
||||
public class ExecIdentityStoreSupplier implements IdentityStoreSupplier {
|
||||
|
||||
@Override
|
||||
public void accept(Mxisd mxisd) {
|
||||
accept(mxisd.getConfig());
|
||||
}
|
||||
|
||||
public void accept(MxisdConfig cfg) {
|
||||
if (cfg.getExec().getAuth().isEnabled()) {
|
||||
AuthProviders.register(() -> new ExecAuthStore(cfg.getExec()));
|
||||
}
|
||||
|
||||
if (cfg.getExec().getDirectory().isEnabled()) {
|
||||
DirectoryProviders.register(() -> new ExecDirectoryStore(cfg));
|
||||
}
|
||||
|
||||
if (cfg.getExec().getIdentity().isEnabled()) {
|
||||
ThreePidProviders.register(() -> new ExecIdentityStore(cfg.getExec(), cfg.getMatrix()));
|
||||
}
|
||||
|
||||
if (cfg.getExec().getProfile().isEnabled()) {
|
||||
ProfileProviders.register(() -> new ExecProfileStore(cfg.getExec()));
|
||||
}
|
||||
}
|
||||
|
||||
}
|
@@ -28,30 +28,18 @@ import io.kamax.mxisd.profile.JsonProfileRequest;
|
||||
import io.kamax.mxisd.profile.JsonProfileResult;
|
||||
import io.kamax.mxisd.profile.ProfileProvider;
|
||||
import org.apache.commons.lang.StringUtils;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
import java.util.Collections;
|
||||
import java.util.List;
|
||||
import java.util.Optional;
|
||||
|
||||
@Component
|
||||
public class ExecProfileStore extends ExecStore implements ProfileProvider {
|
||||
|
||||
private ExecConfig.Profile cfg;
|
||||
|
||||
@Autowired
|
||||
public ExecProfileStore(ExecConfig cfg) {
|
||||
this(cfg.getProfile());
|
||||
}
|
||||
|
||||
public ExecProfileStore(ExecConfig.Profile cfg) {
|
||||
this.cfg = cfg;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isEnabled() {
|
||||
return cfg.isEnabled();
|
||||
super(cfg);
|
||||
this.cfg = cfg.getProfile();
|
||||
}
|
||||
|
||||
private Optional<JsonProfileResult> getFull(_MatrixID userId, ExecConfig.Process cfg) {
|
||||
|
@@ -43,14 +43,19 @@ public class ExecStore {
|
||||
public static final String JsonType = "json";
|
||||
public static final String PlainType = "plain";
|
||||
|
||||
private static final Logger log = LoggerFactory.getLogger(ExecStore.class);
|
||||
|
||||
protected static String toJson(Object o) {
|
||||
return GsonUtil.get().toJson(o);
|
||||
}
|
||||
|
||||
private final Logger log = LoggerFactory.getLogger(ExecStore.class);
|
||||
|
||||
private final ExecConfig cfg;
|
||||
private Supplier<ProcessExecutor> executorSupplier = () -> new ProcessExecutor().readOutput(true);
|
||||
|
||||
public ExecStore(ExecConfig cfg) {
|
||||
this.cfg = cfg;
|
||||
}
|
||||
|
||||
public void setExecutorSupplier(Supplier<ProcessExecutor> supplier) {
|
||||
executorSupplier = supplier;
|
||||
}
|
||||
@@ -64,7 +69,7 @@ public class ExecStore {
|
||||
private Function<String, String> inputUnknownTypeMapper;
|
||||
private Map<String, Supplier<String>> inputTypeSuppliers;
|
||||
|
||||
private Map<String, Function<ExecConfig.TokenOverride, String>> inputTypeTemplates;
|
||||
private Map<String, Function<ExecConfig.Token, String>> inputTypeTemplates;
|
||||
private Supplier<String> inputTypeNoTemplateHandler;
|
||||
private Map<String, Supplier<String>> tokenMappers;
|
||||
private Function<String, String> tokenHandler;
|
||||
@@ -156,11 +161,11 @@ public class ExecStore {
|
||||
inputTypeSuppliers.put(type, handler);
|
||||
}
|
||||
|
||||
protected void addInputTemplate(String type, Function<ExecConfig.TokenOverride, String> template) {
|
||||
protected void addInputTemplate(String type, Function<ExecConfig.Token, String> template) {
|
||||
inputTypeTemplates.put(type, template);
|
||||
}
|
||||
|
||||
public void addJsonInputTemplate(Function<ExecConfig.TokenOverride, Object> template) {
|
||||
public void addJsonInputTemplate(Function<ExecConfig.Token, Object> template) {
|
||||
inputTypeTemplates.put(JsonType, token -> GsonUtil.get().toJson(template.apply(token)));
|
||||
}
|
||||
|
||||
|
@@ -29,6 +29,7 @@ import io.kamax.matrix._MatrixID;
|
||||
import io.kamax.mxisd.UserIdType;
|
||||
import io.kamax.mxisd.auth.provider.AuthenticatorProvider;
|
||||
import io.kamax.mxisd.auth.provider.BackendAuthResult;
|
||||
import io.kamax.mxisd.config.FirebaseConfig;
|
||||
import org.apache.commons.lang.StringUtils;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
@@ -38,10 +39,14 @@ import java.util.concurrent.TimeUnit;
|
||||
|
||||
public class GoogleFirebaseAuthenticator extends GoogleFirebaseBackend implements AuthenticatorProvider {
|
||||
|
||||
private Logger log = LoggerFactory.getLogger(GoogleFirebaseAuthenticator.class);
|
||||
private transient final Logger log = LoggerFactory.getLogger(GoogleFirebaseAuthenticator.class);
|
||||
|
||||
private PhoneNumberUtil phoneUtil = PhoneNumberUtil.getInstance();
|
||||
|
||||
public GoogleFirebaseAuthenticator(FirebaseConfig cfg) {
|
||||
this(cfg.isEnabled(), cfg.getCredentials(), cfg.getDatabase());
|
||||
}
|
||||
|
||||
public GoogleFirebaseAuthenticator(boolean isEnabled, String credsPath, String db) {
|
||||
super(isEnabled, "AuthenticationProvider", credsPath, db);
|
||||
}
|
||||
|
@@ -35,7 +35,7 @@ import java.io.IOException;
|
||||
|
||||
public class GoogleFirebaseBackend {
|
||||
|
||||
private Logger log = LoggerFactory.getLogger(GoogleFirebaseBackend.class);
|
||||
private transient final Logger log = LoggerFactory.getLogger(GoogleFirebaseBackend.class);
|
||||
|
||||
private boolean isEnabled;
|
||||
private FirebaseAuth fbAuth;
|
||||
@@ -60,7 +60,9 @@ public class GoogleFirebaseBackend {
|
||||
|
||||
private FirebaseCredential getCreds(String credsPath) throws IOException {
|
||||
if (StringUtils.isNotBlank(credsPath)) {
|
||||
return FirebaseCredentials.fromCertificate(new FileInputStream(credsPath));
|
||||
try (FileInputStream is = new FileInputStream(credsPath)) {
|
||||
return FirebaseCredentials.fromCertificate(is);
|
||||
}
|
||||
} else {
|
||||
return FirebaseCredentials.applicationDefault();
|
||||
}
|
||||
|
@@ -25,6 +25,7 @@ import com.google.firebase.tasks.OnFailureListener;
|
||||
import com.google.firebase.tasks.OnSuccessListener;
|
||||
import io.kamax.matrix.MatrixID;
|
||||
import io.kamax.matrix.ThreePidMedium;
|
||||
import io.kamax.mxisd.config.MxisdConfig;
|
||||
import io.kamax.mxisd.lookup.SingleLookupReply;
|
||||
import io.kamax.mxisd.lookup.SingleLookupRequest;
|
||||
import io.kamax.mxisd.lookup.ThreePidMapping;
|
||||
@@ -40,9 +41,13 @@ import java.util.concurrent.TimeUnit;
|
||||
|
||||
public class GoogleFirebaseProvider extends GoogleFirebaseBackend implements IThreePidProvider {
|
||||
|
||||
private Logger log = LoggerFactory.getLogger(GoogleFirebaseProvider.class);
|
||||
private transient final Logger log = LoggerFactory.getLogger(GoogleFirebaseProvider.class);
|
||||
private String domain;
|
||||
|
||||
public GoogleFirebaseProvider(MxisdConfig cfg) {
|
||||
this(cfg.getFirebase().isEnabled(), cfg.getFirebase().getCredentials(), cfg.getFirebase().getDatabase(), cfg.getMatrix().getDomain());
|
||||
}
|
||||
|
||||
public GoogleFirebaseProvider(boolean isEnabled, String credsPath, String db, String domain) {
|
||||
super(isEnabled, "ThreePidProvider", credsPath, db);
|
||||
this.domain = domain;
|
||||
|
@@ -1,6 +1,6 @@
|
||||
/*
|
||||
* mxisd - Matrix Identity Server Daemon
|
||||
* Copyright (C) 2017 Kamax Sarl
|
||||
* Copyright (C) 2018 Kamax Sarl
|
||||
*
|
||||
* https://www.kamax.io/
|
||||
*
|
||||
@@ -18,21 +18,26 @@
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package io.kamax.mxisd.spring;
|
||||
package io.kamax.mxisd.backend.firebase;
|
||||
|
||||
import io.kamax.mxisd.exception.ConfigurationException;
|
||||
import org.springframework.boot.diagnostics.AbstractFailureAnalyzer;
|
||||
import org.springframework.boot.diagnostics.FailureAnalysis;
|
||||
import io.kamax.mxisd.Mxisd;
|
||||
import io.kamax.mxisd.auth.AuthProviders;
|
||||
import io.kamax.mxisd.backend.IdentityStoreSupplier;
|
||||
import io.kamax.mxisd.config.MxisdConfig;
|
||||
import io.kamax.mxisd.lookup.ThreePidProviders;
|
||||
|
||||
public class ConfigurationFailureAnalyzer extends AbstractFailureAnalyzer<ConfigurationException> {
|
||||
public class GoogleFirebaseStoreSupplier implements IdentityStoreSupplier {
|
||||
|
||||
@Override
|
||||
protected FailureAnalysis analyze(Throwable rootFailure, ConfigurationException cause) {
|
||||
String message = cause.getMessage();
|
||||
if (cause.getDetailedMessage().isPresent()) {
|
||||
message += " - " + cause.getDetailedMessage().get();
|
||||
public void accept(Mxisd mxisd) {
|
||||
accept(mxisd.getConfig());
|
||||
}
|
||||
|
||||
public void accept(MxisdConfig cfg) {
|
||||
if (cfg.getFirebase().isEnabled()) {
|
||||
AuthProviders.register(() -> new GoogleFirebaseAuthenticator(cfg.getFirebase()));
|
||||
ThreePidProviders.register(() -> new GoogleFirebaseProvider(cfg));
|
||||
}
|
||||
return new FailureAnalysis(message, "Double check the key value", cause);
|
||||
}
|
||||
|
||||
}
|
@@ -43,8 +43,6 @@ import org.apache.directory.api.ldap.model.message.SearchScope;
|
||||
import org.apache.directory.ldap.client.api.LdapConnection;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.util.HashSet;
|
||||
@@ -52,14 +50,12 @@ import java.util.List;
|
||||
import java.util.Optional;
|
||||
import java.util.Set;
|
||||
|
||||
@Component
|
||||
public class LdapAuthProvider extends LdapBackend implements AuthenticatorProvider {
|
||||
|
||||
private Logger log = LoggerFactory.getLogger(LdapAuthProvider.class);
|
||||
private transient final Logger log = LoggerFactory.getLogger(LdapAuthProvider.class);
|
||||
|
||||
private PhoneNumberUtil phoneUtil = PhoneNumberUtil.getInstance();
|
||||
|
||||
@Autowired
|
||||
public LdapAuthProvider(LdapConfig cfg, MatrixConfig mxCfg) {
|
||||
super(cfg, mxCfg);
|
||||
}
|
||||
|
@@ -45,7 +45,7 @@ public abstract class LdapBackend {
|
||||
public static final String UID = "uid";
|
||||
public static final String MATRIX_ID = "mxid";
|
||||
|
||||
private Logger log = LoggerFactory.getLogger(LdapBackend.class);
|
||||
private transient final Logger log = LoggerFactory.getLogger(LdapBackend.class);
|
||||
|
||||
private LdapConfig cfg;
|
||||
private MatrixConfig mxCfg;
|
||||
|
@@ -22,9 +22,9 @@ package io.kamax.mxisd.backend.ldap;
|
||||
|
||||
import io.kamax.mxisd.config.MatrixConfig;
|
||||
import io.kamax.mxisd.config.ldap.LdapConfig;
|
||||
import io.kamax.mxisd.controller.directory.v1.io.UserDirectorySearchResult;
|
||||
import io.kamax.mxisd.directory.IDirectoryProvider;
|
||||
import io.kamax.mxisd.directory.DirectoryProvider;
|
||||
import io.kamax.mxisd.exception.InternalServerError;
|
||||
import io.kamax.mxisd.http.io.UserDirectorySearchResult;
|
||||
import io.kamax.mxisd.util.GsonUtil;
|
||||
import org.apache.directory.api.ldap.model.cursor.CursorException;
|
||||
import org.apache.directory.api.ldap.model.cursor.CursorLdapReferralException;
|
||||
@@ -35,28 +35,19 @@ import org.apache.directory.api.ldap.model.message.SearchScope;
|
||||
import org.apache.directory.ldap.client.api.LdapConnection;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
@Component
|
||||
public class LdapDirectoryProvider extends LdapBackend implements IDirectoryProvider {
|
||||
public class LdapDirectoryProvider extends LdapBackend implements DirectoryProvider {
|
||||
|
||||
private Logger log = LoggerFactory.getLogger(LdapDirectoryProvider.class);
|
||||
private transient final Logger log = LoggerFactory.getLogger(LdapDirectoryProvider.class);
|
||||
|
||||
@Autowired
|
||||
public LdapDirectoryProvider(LdapConfig cfg, MatrixConfig mxCfg) {
|
||||
super(cfg, mxCfg);
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isEnabled() {
|
||||
return getCfg().isEnabled();
|
||||
}
|
||||
|
||||
protected UserDirectorySearchResult search(String query, List<String> attributes) {
|
||||
UserDirectorySearchResult result = new UserDirectorySearchResult();
|
||||
result.setLimited(false);
|
||||
@@ -95,7 +86,6 @@ public class LdapDirectoryProvider extends LdapBackend implements IDirectoryProv
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
} catch (CursorLdapReferralException e) {
|
||||
log.warn("An entry is only available via referral, skipping");
|
||||
} catch (IOException | LdapException | CursorException e) {
|
||||
|
@@ -36,8 +36,6 @@ import org.apache.directory.api.ldap.model.message.SearchScope;
|
||||
import org.apache.directory.ldap.client.api.LdapConnection;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.util.ArrayList;
|
||||
@@ -45,21 +43,14 @@ import java.util.Collections;
|
||||
import java.util.List;
|
||||
import java.util.Optional;
|
||||
|
||||
@Component
|
||||
public class LdapProfileProvider extends LdapBackend implements ProfileProvider {
|
||||
|
||||
private transient Logger log = LoggerFactory.getLogger(LdapProfileProvider.class);
|
||||
private transient final Logger log = LoggerFactory.getLogger(LdapProfileProvider.class);
|
||||
|
||||
@Autowired
|
||||
public LdapProfileProvider(LdapConfig cfg, MatrixConfig mxCfg) {
|
||||
super(cfg, mxCfg);
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isEnabled() {
|
||||
return getCfg().isEnabled();
|
||||
}
|
||||
|
||||
@Override
|
||||
public Optional<String> getDisplayName(_MatrixID userId) {
|
||||
String uid = buildUidFromMatrixId(userId);
|
||||
|
@@ -0,0 +1,47 @@
|
||||
/*
|
||||
* mxisd - Matrix Identity Server Daemon
|
||||
* Copyright (C) 2018 Kamax Sarl
|
||||
*
|
||||
* https://www.kamax.io/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package io.kamax.mxisd.backend.ldap;
|
||||
|
||||
import io.kamax.mxisd.Mxisd;
|
||||
import io.kamax.mxisd.auth.AuthProviders;
|
||||
import io.kamax.mxisd.backend.IdentityStoreSupplier;
|
||||
import io.kamax.mxisd.config.MxisdConfig;
|
||||
import io.kamax.mxisd.directory.DirectoryProviders;
|
||||
import io.kamax.mxisd.lookup.ThreePidProviders;
|
||||
import io.kamax.mxisd.profile.ProfileProviders;
|
||||
|
||||
public class LdapStoreSupplier implements IdentityStoreSupplier {
|
||||
|
||||
@Override
|
||||
public void accept(Mxisd mxisd) {
|
||||
accept(mxisd.getConfig());
|
||||
}
|
||||
|
||||
public void accept(MxisdConfig cfg) {
|
||||
if (cfg.getLdap().isEnabled()) {
|
||||
AuthProviders.register(() -> new LdapAuthProvider(cfg.getLdap(), cfg.getMatrix()));
|
||||
DirectoryProviders.register(() -> new LdapDirectoryProvider(cfg.getLdap(), cfg.getMatrix()));
|
||||
ThreePidProviders.register(() -> new LdapThreePidProvider(cfg.getLdap(), cfg.getMatrix()));
|
||||
ProfileProviders.register(() -> new LdapProfileProvider(cfg.getLdap(), cfg.getMatrix()));
|
||||
}
|
||||
}
|
||||
|
||||
}
|
@@ -37,27 +37,20 @@ import org.apache.directory.api.ldap.model.message.SearchScope;
|
||||
import org.apache.directory.ldap.client.api.LdapConnection;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import java.util.Optional;
|
||||
|
||||
@Component
|
||||
public class LdapThreePidProvider extends LdapBackend implements IThreePidProvider {
|
||||
|
||||
private Logger log = LoggerFactory.getLogger(LdapThreePidProvider.class);
|
||||
private transient final Logger log = LoggerFactory.getLogger(LdapThreePidProvider.class);
|
||||
|
||||
public LdapThreePidProvider(LdapConfig cfg, MatrixConfig mxCfg) {
|
||||
super(cfg, mxCfg);
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isEnabled() {
|
||||
return getCfg().isEnabled();
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isLocal() {
|
||||
return true;
|
||||
|
@@ -23,9 +23,7 @@ package io.kamax.mxisd.backend.ldap.netiq;
|
||||
import io.kamax.mxisd.backend.ldap.LdapAuthProvider;
|
||||
import io.kamax.mxisd.config.MatrixConfig;
|
||||
import io.kamax.mxisd.config.ldap.netiq.NetIqLdapConfig;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
@Component
|
||||
public class NetIqLdapAuthProvider extends LdapAuthProvider {
|
||||
|
||||
public NetIqLdapAuthProvider(NetIqLdapConfig cfg, MatrixConfig mxCfg) {
|
||||
|
@@ -23,9 +23,7 @@ package io.kamax.mxisd.backend.ldap.netiq;
|
||||
import io.kamax.mxisd.backend.ldap.LdapDirectoryProvider;
|
||||
import io.kamax.mxisd.config.MatrixConfig;
|
||||
import io.kamax.mxisd.config.ldap.netiq.NetIqLdapConfig;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
@Component
|
||||
public class NetIqLdapDirectoryProvider extends LdapDirectoryProvider {
|
||||
|
||||
public NetIqLdapDirectoryProvider(NetIqLdapConfig cfg, MatrixConfig mxCfg) {
|
||||
|
@@ -24,13 +24,9 @@ import io.kamax.matrix._MatrixID;
|
||||
import io.kamax.mxisd.backend.ldap.LdapProfileProvider;
|
||||
import io.kamax.mxisd.config.MatrixConfig;
|
||||
import io.kamax.mxisd.config.ldap.netiq.NetIqLdapConfig;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
@Component
|
||||
public class NetIqLdapProfileProvider extends LdapProfileProvider {
|
||||
|
||||
@Autowired
|
||||
public NetIqLdapProfileProvider(NetIqLdapConfig cfg, MatrixConfig mxCfg) {
|
||||
super(cfg, mxCfg);
|
||||
}
|
||||
|
@@ -0,0 +1,47 @@
|
||||
/*
|
||||
* mxisd - Matrix Identity Server Daemon
|
||||
* Copyright (C) 2018 Kamax Sarl
|
||||
*
|
||||
* https://www.kamax.io/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package io.kamax.mxisd.backend.ldap.netiq;
|
||||
|
||||
import io.kamax.mxisd.Mxisd;
|
||||
import io.kamax.mxisd.auth.AuthProviders;
|
||||
import io.kamax.mxisd.backend.IdentityStoreSupplier;
|
||||
import io.kamax.mxisd.config.MxisdConfig;
|
||||
import io.kamax.mxisd.directory.DirectoryProviders;
|
||||
import io.kamax.mxisd.lookup.ThreePidProviders;
|
||||
import io.kamax.mxisd.profile.ProfileProviders;
|
||||
|
||||
public class NetIqLdapStoreSupplier implements IdentityStoreSupplier {
|
||||
|
||||
@Override
|
||||
public void accept(Mxisd mxisd) {
|
||||
accept(mxisd.getConfig());
|
||||
}
|
||||
|
||||
public void accept(MxisdConfig cfg) {
|
||||
if (cfg.getNetiq().isEnabled()) {
|
||||
AuthProviders.register(() -> new NetIqLdapAuthProvider(cfg.getNetiq(), cfg.getMatrix()));
|
||||
DirectoryProviders.register(() -> new NetIqLdapDirectoryProvider(cfg.getNetiq(), cfg.getMatrix()));
|
||||
ThreePidProviders.register(() -> new NetIqLdapThreePidProvider(cfg.getNetiq(), cfg.getMatrix()));
|
||||
ProfileProviders.register(() -> new NetIqLdapProfileProvider(cfg.getNetiq(), cfg.getMatrix()));
|
||||
}
|
||||
}
|
||||
|
||||
}
|
@@ -23,9 +23,7 @@ package io.kamax.mxisd.backend.ldap.netiq;
|
||||
import io.kamax.mxisd.backend.ldap.LdapThreePidProvider;
|
||||
import io.kamax.mxisd.config.MatrixConfig;
|
||||
import io.kamax.mxisd.config.ldap.netiq.NetIqLdapConfig;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
@Component
|
||||
public class NetIqLdapThreePidProvider extends LdapThreePidProvider {
|
||||
|
||||
public NetIqLdapThreePidProvider(NetIqLdapConfig cfg, MatrixConfig mxCfg) {
|
||||
|
@@ -31,8 +31,8 @@ import io.kamax.mxisd.config.MatrixConfig;
|
||||
import io.kamax.mxisd.config.memory.MemoryIdentityConfig;
|
||||
import io.kamax.mxisd.config.memory.MemoryStoreConfig;
|
||||
import io.kamax.mxisd.config.memory.MemoryThreePid;
|
||||
import io.kamax.mxisd.controller.directory.v1.io.UserDirectorySearchResult;
|
||||
import io.kamax.mxisd.directory.IDirectoryProvider;
|
||||
import io.kamax.mxisd.directory.DirectoryProvider;
|
||||
import io.kamax.mxisd.http.io.UserDirectorySearchResult;
|
||||
import io.kamax.mxisd.lookup.SingleLookupReply;
|
||||
import io.kamax.mxisd.lookup.SingleLookupRequest;
|
||||
import io.kamax.mxisd.lookup.ThreePidMapping;
|
||||
@@ -41,8 +41,6 @@ import io.kamax.mxisd.profile.ProfileProvider;
|
||||
import org.apache.commons.lang.StringUtils;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.Collections;
|
||||
@@ -51,15 +49,13 @@ import java.util.Optional;
|
||||
import java.util.function.Function;
|
||||
import java.util.function.Predicate;
|
||||
|
||||
@Component
|
||||
public class MemoryIdentityStore implements AuthenticatorProvider, IDirectoryProvider, IThreePidProvider, ProfileProvider {
|
||||
public class MemoryIdentityStore implements AuthenticatorProvider, DirectoryProvider, IThreePidProvider, ProfileProvider {
|
||||
|
||||
private final Logger logger = LoggerFactory.getLogger(MemoryIdentityStore.class);
|
||||
private transient final Logger logger = LoggerFactory.getLogger(MemoryIdentityStore.class);
|
||||
|
||||
private final MatrixConfig mxCfg;
|
||||
private final MemoryStoreConfig cfg;
|
||||
|
||||
@Autowired
|
||||
public MemoryIdentityStore(MatrixConfig mxCfg, MemoryStoreConfig cfg) {
|
||||
this.mxCfg = mxCfg;
|
||||
this.cfg = cfg;
|
||||
|
@@ -0,0 +1,51 @@
|
||||
/*
|
||||
* mxisd - Matrix Identity Server Daemon
|
||||
* Copyright (C) 2018 Kamax Sarl
|
||||
*
|
||||
* https://www.kamax.io/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package io.kamax.mxisd.backend.memory;
|
||||
|
||||
import io.kamax.mxisd.Mxisd;
|
||||
import io.kamax.mxisd.auth.AuthProviders;
|
||||
import io.kamax.mxisd.backend.IdentityStoreSupplier;
|
||||
import io.kamax.mxisd.config.MxisdConfig;
|
||||
import io.kamax.mxisd.directory.DirectoryProviders;
|
||||
import io.kamax.mxisd.lookup.ThreePidProviders;
|
||||
import io.kamax.mxisd.profile.ProfileProviders;
|
||||
|
||||
import java.util.function.Supplier;
|
||||
|
||||
public class MemoryIdentityStoreSupplier implements IdentityStoreSupplier {
|
||||
|
||||
@Override
|
||||
public void accept(Mxisd mxisd) {
|
||||
accept(mxisd.getConfig());
|
||||
}
|
||||
|
||||
public void accept(MxisdConfig cfg) {
|
||||
if (cfg.getMemory().isEnabled()) {
|
||||
Supplier<MemoryIdentityStore> supplier = () -> new MemoryIdentityStore(cfg.getMatrix(), cfg.getMemory());
|
||||
|
||||
AuthProviders.register(supplier);
|
||||
DirectoryProviders.register(supplier);
|
||||
ThreePidProviders.register(supplier);
|
||||
ProfileProviders.register(supplier);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
@@ -37,4 +37,5 @@ public class LookupSingleRequestJson {
|
||||
public String getAddress() {
|
||||
return address;
|
||||
}
|
||||
|
||||
}
|
||||
|
@@ -27,15 +27,11 @@ import io.kamax.mxisd.config.rest.RestBackendConfig;
|
||||
import io.kamax.mxisd.util.RestClientUtils;
|
||||
import org.apache.http.client.methods.CloseableHttpResponse;
|
||||
import org.apache.http.client.methods.HttpUriRequest;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
import java.io.IOException;
|
||||
|
||||
@Component
|
||||
public class RestAuthProvider extends RestProvider implements AuthenticatorProvider {
|
||||
|
||||
@Autowired
|
||||
public RestAuthProvider(RestBackendConfig cfg) {
|
||||
super(cfg);
|
||||
}
|
||||
|
@@ -23,21 +23,18 @@ package io.kamax.mxisd.backend.rest;
|
||||
import io.kamax.matrix.MatrixID;
|
||||
import io.kamax.mxisd.config.MatrixConfig;
|
||||
import io.kamax.mxisd.config.rest.RestBackendConfig;
|
||||
import io.kamax.mxisd.controller.directory.v1.io.UserDirectorySearchRequest;
|
||||
import io.kamax.mxisd.controller.directory.v1.io.UserDirectorySearchResult;
|
||||
import io.kamax.mxisd.directory.IDirectoryProvider;
|
||||
import io.kamax.mxisd.directory.DirectoryProvider;
|
||||
import io.kamax.mxisd.exception.InternalServerError;
|
||||
import io.kamax.mxisd.http.io.UserDirectorySearchRequest;
|
||||
import io.kamax.mxisd.http.io.UserDirectorySearchResult;
|
||||
import io.kamax.mxisd.util.RestClientUtils;
|
||||
import org.apache.commons.io.IOUtils;
|
||||
import org.apache.commons.lang.StringUtils;
|
||||
import org.apache.http.client.methods.CloseableHttpResponse;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
|
||||
@Component
|
||||
public class RestDirectoryProvider extends RestProvider implements IDirectoryProvider {
|
||||
public class RestDirectoryProvider extends RestProvider implements DirectoryProvider {
|
||||
|
||||
private MatrixConfig mxCfg;
|
||||
|
||||
@@ -46,11 +43,6 @@ public class RestDirectoryProvider extends RestProvider implements IDirectoryPro
|
||||
this.mxCfg = mxCfg;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isEnabled() {
|
||||
return cfg.isEnabled() && StringUtils.isNotBlank(cfg.getEndpoints().getDirectory());
|
||||
}
|
||||
|
||||
private UserDirectorySearchResult search(String by, String query) {
|
||||
UserDirectorySearchRequest request = new UserDirectorySearchRequest(query);
|
||||
request.setBy(by);
|
||||
|
@@ -32,7 +32,7 @@ import io.kamax.mxisd.profile.JsonProfileRequest;
|
||||
import io.kamax.mxisd.profile.JsonProfileResult;
|
||||
import io.kamax.mxisd.profile.ProfileProvider;
|
||||
import org.apache.commons.io.IOUtils;
|
||||
import org.apache.commons.lang.StringUtils;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
import org.apache.http.client.methods.CloseableHttpResponse;
|
||||
import org.apache.http.client.methods.HttpPost;
|
||||
import org.apache.http.client.utils.URIBuilder;
|
||||
@@ -40,7 +40,6 @@ import org.apache.http.entity.ContentType;
|
||||
import org.apache.http.entity.StringEntity;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.net.URISyntaxException;
|
||||
@@ -48,83 +47,84 @@ import java.nio.charset.StandardCharsets;
|
||||
import java.util.*;
|
||||
import java.util.function.Function;
|
||||
|
||||
@Component
|
||||
public class RestProfileProvider extends RestProvider implements ProfileProvider {
|
||||
|
||||
private final Logger log = LoggerFactory.getLogger(RestProfileProvider.class);
|
||||
private static final Logger log = LoggerFactory.getLogger(RestProfileProvider.class);
|
||||
|
||||
public RestProfileProvider(RestBackendConfig cfg) {
|
||||
super(cfg);
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isEnabled() {
|
||||
return cfg.isEnabled() && cfg.getEndpoints().getProfile().isPresent();
|
||||
}
|
||||
|
||||
private <T> Optional<T> doRequest(
|
||||
_MatrixID userId,
|
||||
Function<RestBackendConfig.ProfileEndpoints, Optional<String>> endpoint,
|
||||
Function<JsonProfileResult, Optional<T>> value
|
||||
) {
|
||||
return cfg.getEndpoints().getProfile()
|
||||
// We get the endpoint
|
||||
.flatMap(endpoint)
|
||||
// We only continue if there is a value
|
||||
.filter(StringUtils::isNotBlank)
|
||||
// We use the endpoint
|
||||
.flatMap(url -> {
|
||||
try {
|
||||
URIBuilder builder = new URIBuilder(url);
|
||||
HttpPost req = new HttpPost(builder.build());
|
||||
req.setEntity(new StringEntity(GsonUtil.get().toJson(new JsonProfileRequest(userId)), ContentType.APPLICATION_JSON));
|
||||
try (CloseableHttpResponse res = client.execute(req)) {
|
||||
int sc = res.getStatusLine().getStatusCode();
|
||||
if (sc == 404) {
|
||||
log.info("Got 404 - No result found");
|
||||
return Optional.empty();
|
||||
}
|
||||
Optional<String> url = endpoint.apply(cfg.getEndpoints().getProfile());
|
||||
if (!url.isPresent()) {
|
||||
return Optional.empty();
|
||||
}
|
||||
|
||||
if (sc != 200) {
|
||||
throw new InternalServerError("Unexpected backed status code: " + sc);
|
||||
}
|
||||
try {
|
||||
URIBuilder builder = new URIBuilder(url.get());
|
||||
HttpPost req = new HttpPost(builder.build());
|
||||
req.setEntity(new StringEntity(GsonUtil.get().toJson(new JsonProfileRequest(userId)), ContentType.APPLICATION_JSON));
|
||||
try (CloseableHttpResponse res = client.execute(req)) {
|
||||
int sc = res.getStatusLine().getStatusCode();
|
||||
if (sc == 404) {
|
||||
log.info("Got 404 - No result found");
|
||||
return Optional.empty();
|
||||
}
|
||||
|
||||
String body = IOUtils.toString(res.getEntity().getContent(), StandardCharsets.UTF_8);
|
||||
if (StringUtils.isBlank(body)) {
|
||||
log.warn("Backend response body is empty/blank, expected JSON object with profile key");
|
||||
return Optional.empty();
|
||||
}
|
||||
if (sc != 200) {
|
||||
throw new InternalServerError("Unexpected backed status code: " + sc);
|
||||
}
|
||||
|
||||
Optional<JsonObject> pJson = GsonUtil.findObj(GsonUtil.parseObj(body), "profile");
|
||||
if (!pJson.isPresent()) {
|
||||
log.warn("Backend response body is invalid, expected JSON object with profile key");
|
||||
return Optional.empty();
|
||||
}
|
||||
String body = IOUtils.toString(res.getEntity().getContent(), StandardCharsets.UTF_8);
|
||||
if (StringUtils.isBlank(body)) {
|
||||
log.warn("Backend response body is empty/blank, expected JSON object with profile key");
|
||||
return Optional.empty();
|
||||
}
|
||||
|
||||
JsonProfileResult profile = gson.fromJson(pJson.get(), JsonProfileResult.class);
|
||||
return value.apply(profile);
|
||||
}
|
||||
} catch (JsonSyntaxException | InvalidJsonException e) {
|
||||
log.error("Unable to parse backend response as JSON", e);
|
||||
throw new InternalServerError(e);
|
||||
} catch (URISyntaxException e) {
|
||||
log.error("Unable to build a valid request URL", e);
|
||||
throw new InternalServerError(e);
|
||||
} catch (IOException e) {
|
||||
log.error("I/O Error during backend request", e);
|
||||
throw new InternalServerError();
|
||||
}
|
||||
});
|
||||
Optional<JsonObject> pJson = GsonUtil.findObj(GsonUtil.parseObj(body), "profile");
|
||||
if (!pJson.isPresent()) {
|
||||
log.warn("Backend response body is invalid, expected JSON object with profile key");
|
||||
return Optional.empty();
|
||||
}
|
||||
|
||||
JsonProfileResult profile = gson.fromJson(pJson.get(), JsonProfileResult.class);
|
||||
return value.apply(profile);
|
||||
}
|
||||
} catch (JsonSyntaxException | InvalidJsonException e) {
|
||||
log.error("Unable to parse backend response as JSON", e);
|
||||
throw new InternalServerError(e);
|
||||
} catch (URISyntaxException e) {
|
||||
log.error("Unable to build a valid request URL", e);
|
||||
throw new InternalServerError(e);
|
||||
} catch (IOException e) {
|
||||
log.error("I/O Error during backend request", e);
|
||||
throw new InternalServerError();
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public Optional<String> getDisplayName(_MatrixID userId) {
|
||||
return doRequest(userId, p -> Optional.ofNullable(p.getDisplayName()), profile -> Optional.ofNullable(profile.getDisplayName()));
|
||||
return doRequest(userId, p -> {
|
||||
if (StringUtils.isBlank(p.getDisplayName())) {
|
||||
return Optional.empty();
|
||||
}
|
||||
return Optional.ofNullable(p.getDisplayName());
|
||||
}, profile -> Optional.ofNullable(profile.getDisplayName()));
|
||||
}
|
||||
|
||||
@Override
|
||||
public List<_ThreePid> getThreepids(_MatrixID userId) {
|
||||
return doRequest(userId, p -> Optional.ofNullable(p.getThreepids()), profile -> {
|
||||
return doRequest(userId, p -> {
|
||||
if (StringUtils.isBlank(p.getThreepids())) {
|
||||
return Optional.empty();
|
||||
}
|
||||
return Optional.ofNullable(p.getThreepids());
|
||||
}, profile -> {
|
||||
List<_ThreePid> t = new ArrayList<>();
|
||||
if (Objects.nonNull(profile.getThreepids())) {
|
||||
t.addAll(profile.getThreepids());
|
||||
@@ -135,7 +135,12 @@ public class RestProfileProvider extends RestProvider implements ProfileProvider
|
||||
|
||||
@Override
|
||||
public List<String> getRoles(_MatrixID userId) {
|
||||
return doRequest(userId, p -> Optional.ofNullable(p.getRoles()), profile -> {
|
||||
return doRequest(userId, p -> {
|
||||
if (StringUtils.isBlank(p.getRoles())) {
|
||||
return Optional.empty();
|
||||
}
|
||||
return Optional.ofNullable(p.getRoles());
|
||||
}, profile -> {
|
||||
List<String> t = new ArrayList<>();
|
||||
if (Objects.nonNull(profile.getRoles())) {
|
||||
t.addAll(profile.getRoles());
|
||||
|
@@ -0,0 +1,47 @@
|
||||
/*
|
||||
* mxisd - Matrix Identity Server Daemon
|
||||
* Copyright (C) 2018 Kamax Sarl
|
||||
*
|
||||
* https://www.kamax.io/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package io.kamax.mxisd.backend.rest;
|
||||
|
||||
import io.kamax.mxisd.Mxisd;
|
||||
import io.kamax.mxisd.auth.AuthProviders;
|
||||
import io.kamax.mxisd.backend.IdentityStoreSupplier;
|
||||
import io.kamax.mxisd.config.MxisdConfig;
|
||||
import io.kamax.mxisd.directory.DirectoryProviders;
|
||||
import io.kamax.mxisd.lookup.ThreePidProviders;
|
||||
import io.kamax.mxisd.profile.ProfileProviders;
|
||||
|
||||
public class RestStoreSupplier implements IdentityStoreSupplier {
|
||||
|
||||
@Override
|
||||
public void accept(Mxisd mxisd) {
|
||||
accept(mxisd.getConfig());
|
||||
}
|
||||
|
||||
public void accept(MxisdConfig cfg) {
|
||||
if (cfg.getRest().isEnabled()) {
|
||||
AuthProviders.register(() -> new RestAuthProvider(cfg.getRest()));
|
||||
DirectoryProviders.register(() -> new RestDirectoryProvider(cfg.getRest(), cfg.getMatrix()));
|
||||
ThreePidProviders.register(() -> new RestThreePidProvider(cfg.getRest(), cfg.getMatrix()));
|
||||
ProfileProviders.register(() -> new RestProfileProvider(cfg.getRest()));
|
||||
}
|
||||
}
|
||||
|
||||
}
|
@@ -35,8 +35,6 @@ import org.apache.http.client.methods.CloseableHttpResponse;
|
||||
import org.apache.http.client.methods.HttpUriRequest;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.util.ArrayList;
|
||||
@@ -44,14 +42,12 @@ import java.util.List;
|
||||
import java.util.Optional;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
@Component
|
||||
public class RestThreePidProvider extends RestProvider implements IThreePidProvider {
|
||||
|
||||
private Logger log = LoggerFactory.getLogger(RestThreePidProvider.class);
|
||||
private transient final Logger log = LoggerFactory.getLogger(RestThreePidProvider.class);
|
||||
|
||||
private MatrixConfig mxCfg; // FIXME should be done in the lookup manager
|
||||
|
||||
@Autowired
|
||||
public RestThreePidProvider(RestBackendConfig cfg, MatrixConfig mxCfg) {
|
||||
super(cfg);
|
||||
this.mxCfg = mxCfg;
|
||||
@@ -66,11 +62,6 @@ public class RestThreePidProvider extends RestProvider implements IThreePidProvi
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isEnabled() {
|
||||
return cfg.isEnabled();
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isLocal() {
|
||||
return true;
|
||||
|
@@ -0,0 +1,55 @@
|
||||
/*
|
||||
* mxisd - Matrix Identity Server Daemon
|
||||
* Copyright (C) 2019 Kamax Sàrl
|
||||
*
|
||||
* https://www.kamax.io/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package io.kamax.mxisd.backend.sql;
|
||||
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
|
||||
public class BuiltInDriverLoader implements DriverLoader {
|
||||
|
||||
@Override
|
||||
public void accept(String s) {
|
||||
String className = null;
|
||||
if (StringUtils.equals("sqlite", s)) {
|
||||
className = "org.sqlite.JDBC";
|
||||
}
|
||||
|
||||
if (StringUtils.equals("postgresql", s)) {
|
||||
className = "org.postgresql.Driver";
|
||||
}
|
||||
|
||||
if (StringUtils.equals("mariadb", s)) {
|
||||
className = "org.mariadb.jdbc.Driver";
|
||||
}
|
||||
|
||||
if (StringUtils.equals("mysql", s)) {
|
||||
className = "org.mariadb.jdbc.Driver";
|
||||
}
|
||||
|
||||
if (StringUtils.isNotEmpty(className)) {
|
||||
try {
|
||||
Class.forName(className);
|
||||
} catch (ClassNotFoundException e) {
|
||||
throw new RuntimeException(e);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
}
|
26
src/main/java/io/kamax/mxisd/backend/sql/DriverLoader.java
Normal file
26
src/main/java/io/kamax/mxisd/backend/sql/DriverLoader.java
Normal file
@@ -0,0 +1,26 @@
|
||||
/*
|
||||
* mxisd - Matrix Identity Server Daemon
|
||||
* Copyright (C) 2019 Kamax Sàrl
|
||||
*
|
||||
* https://www.kamax.io/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package io.kamax.mxisd.backend.sql;
|
||||
|
||||
import java.util.function.Consumer;
|
||||
|
||||
public interface DriverLoader extends Consumer<String> {
|
||||
}
|
38
src/main/java/io/kamax/mxisd/backend/sql/Drivers.java
Normal file
38
src/main/java/io/kamax/mxisd/backend/sql/Drivers.java
Normal file
@@ -0,0 +1,38 @@
|
||||
/*
|
||||
* mxisd - Matrix Identity Server Daemon
|
||||
* Copyright (C) 2019 Kamax Sàrl
|
||||
*
|
||||
* https://www.kamax.io/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package io.kamax.mxisd.backend.sql;
|
||||
|
||||
import java.util.Objects;
|
||||
import java.util.ServiceLoader;
|
||||
|
||||
public class Drivers {
|
||||
|
||||
private static ServiceLoader<DriverLoader> svcLoader;
|
||||
|
||||
public static void load(String type) {
|
||||
if (Objects.isNull(svcLoader)) {
|
||||
svcLoader = ServiceLoader.load(DriverLoader.class);
|
||||
}
|
||||
|
||||
svcLoader.iterator().forEachRemaining(drv -> drv.accept(type));
|
||||
}
|
||||
|
||||
}
|
@@ -37,11 +37,15 @@ public class SqlConnectionPool {
|
||||
private ComboPooledDataSource ds;
|
||||
|
||||
public SqlConnectionPool(SqlConfig cfg) {
|
||||
Drivers.load(cfg.getType());
|
||||
|
||||
ds = new ComboPooledDataSource();
|
||||
ds.setJdbcUrl("jdbc:" + cfg.getType() + ":" + cfg.getConnection());
|
||||
ds.setMinPoolSize(1);
|
||||
ds.setMaxPoolSize(10);
|
||||
ds.setAcquireIncrement(2);
|
||||
ds.setAcquireRetryAttempts(10);
|
||||
ds.setAcquireRetryDelay(1000);
|
||||
}
|
||||
|
||||
public Connection get() throws SQLException {
|
||||
|
@@ -23,7 +23,9 @@ package io.kamax.mxisd.backend.sql;
|
||||
import io.kamax.matrix.ThreePid;
|
||||
import io.kamax.matrix._MatrixID;
|
||||
import io.kamax.matrix._ThreePid;
|
||||
import io.kamax.mxisd.UserIdType;
|
||||
import io.kamax.mxisd.config.sql.SqlConfig;
|
||||
import io.kamax.mxisd.exception.InternalServerError;
|
||||
import io.kamax.mxisd.profile.ProfileProvider;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
@@ -33,16 +35,14 @@ import java.sql.PreparedStatement;
|
||||
import java.sql.ResultSet;
|
||||
import java.sql.SQLException;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Collections;
|
||||
import java.util.List;
|
||||
import java.util.Optional;
|
||||
|
||||
public abstract class SqlProfileProvider implements ProfileProvider {
|
||||
|
||||
private Logger log = LoggerFactory.getLogger(SqlProfileProvider.class);
|
||||
private static final Logger log = LoggerFactory.getLogger(SqlProfileProvider.class);
|
||||
|
||||
private SqlConfig.Profile cfg;
|
||||
|
||||
private SqlConnectionPool pool;
|
||||
|
||||
public SqlProfileProvider(SqlConfig cfg) {
|
||||
@@ -50,9 +50,10 @@ public abstract class SqlProfileProvider implements ProfileProvider {
|
||||
this.pool = new SqlConnectionPool(cfg);
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isEnabled() {
|
||||
return cfg.isEnabled();
|
||||
private void setParameters(PreparedStatement stmt, String value) throws SQLException {
|
||||
for (int i = 1; i <= stmt.getParameterMetaData().getParameterCount(); i++) {
|
||||
stmt.setString(i, value);
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
@@ -99,7 +100,33 @@ public abstract class SqlProfileProvider implements ProfileProvider {
|
||||
|
||||
@Override
|
||||
public List<String> getRoles(_MatrixID user) {
|
||||
return Collections.emptyList();
|
||||
log.info("Querying roles for {}", user.getId());
|
||||
|
||||
List<String> roles = new ArrayList<>();
|
||||
|
||||
String stmtSql = cfg.getRole().getQuery();
|
||||
try (Connection conn = pool.get()) {
|
||||
PreparedStatement stmt = conn.prepareStatement(stmtSql);
|
||||
if (UserIdType.Localpart.is(cfg.getRole().getType())) {
|
||||
setParameters(stmt, user.getLocalPart());
|
||||
} else if (UserIdType.MatrixID.is(cfg.getRole().getType())) {
|
||||
setParameters(stmt, user.getId());
|
||||
} else {
|
||||
throw new InternalServerError("Unsupported user type in SQL Role fetching: " + cfg.getRole().getType());
|
||||
}
|
||||
|
||||
ResultSet rSet = stmt.executeQuery();
|
||||
while (rSet.next()) {
|
||||
String role = rSet.getString(1);
|
||||
roles.add(role);
|
||||
log.debug("Found role {}", role);
|
||||
}
|
||||
|
||||
log.info("Got {} roles", roles.size());
|
||||
return roles;
|
||||
} catch (SQLException e) {
|
||||
throw new RuntimeException(e);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
@@ -41,7 +41,7 @@ import java.util.Optional;
|
||||
|
||||
public abstract class SqlThreePidProvider implements IThreePidProvider {
|
||||
|
||||
private Logger log = LoggerFactory.getLogger(SqlThreePidProvider.class);
|
||||
private transient final Logger log = LoggerFactory.getLogger(SqlThreePidProvider.class);
|
||||
|
||||
private SqlConfig cfg;
|
||||
private MatrixConfig mxCfg;
|
||||
@@ -54,11 +54,6 @@ public abstract class SqlThreePidProvider implements IThreePidProvider {
|
||||
this.mxCfg = mxCfg;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isEnabled() {
|
||||
return cfg.isEnabled();
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isLocal() {
|
||||
return true;
|
||||
|
@@ -27,20 +27,19 @@ import io.kamax.mxisd.config.sql.generic.GenericSqlProviderConfig;
|
||||
import io.kamax.mxisd.invitation.InvitationManager;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
@Component
|
||||
public class GenericSqlAuthProvider implements AuthenticatorProvider {
|
||||
|
||||
private Logger log = LoggerFactory.getLogger(GenericSqlAuthProvider.class);
|
||||
private transient final Logger log = LoggerFactory.getLogger(GenericSqlAuthProvider.class);
|
||||
|
||||
@Autowired
|
||||
private GenericSqlProviderConfig cfg;
|
||||
|
||||
@Autowired
|
||||
private InvitationManager invMgr;
|
||||
|
||||
public GenericSqlAuthProvider(GenericSqlProviderConfig cfg, InvitationManager invMgr) {
|
||||
this.cfg = cfg;
|
||||
this.invMgr = invMgr;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isEnabled() {
|
||||
return cfg.getAuth().isEnabled();
|
||||
|
@@ -25,9 +25,9 @@ import io.kamax.mxisd.backend.sql.SqlConnectionPool;
|
||||
import io.kamax.mxisd.config.MatrixConfig;
|
||||
import io.kamax.mxisd.config.sql.SqlConfig;
|
||||
import io.kamax.mxisd.config.sql.generic.GenericSqlProviderConfig;
|
||||
import io.kamax.mxisd.controller.directory.v1.io.UserDirectorySearchResult;
|
||||
import io.kamax.mxisd.directory.IDirectoryProvider;
|
||||
import io.kamax.mxisd.directory.DirectoryProvider;
|
||||
import io.kamax.mxisd.exception.InternalServerError;
|
||||
import io.kamax.mxisd.http.io.UserDirectorySearchResult;
|
||||
import org.apache.commons.lang.StringUtils;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
@@ -38,11 +38,11 @@ import java.sql.ResultSet;
|
||||
import java.sql.SQLException;
|
||||
import java.util.Optional;
|
||||
|
||||
import static io.kamax.mxisd.controller.directory.v1.io.UserDirectorySearchResult.Result;
|
||||
import static io.kamax.mxisd.http.io.UserDirectorySearchResult.Result;
|
||||
|
||||
public abstract class GenericSqlDirectoryProvider implements IDirectoryProvider {
|
||||
public class GenericSqlDirectoryProvider implements DirectoryProvider {
|
||||
|
||||
private Logger log = LoggerFactory.getLogger(GenericSqlDirectoryProvider.class);
|
||||
private transient final Logger log = LoggerFactory.getLogger(GenericSqlDirectoryProvider.class);
|
||||
|
||||
protected SqlConfig cfg;
|
||||
protected MatrixConfig mxCfg;
|
||||
@@ -55,11 +55,6 @@ public abstract class GenericSqlDirectoryProvider implements IDirectoryProvider
|
||||
this.mxCfg = mxCfg;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isEnabled() {
|
||||
return cfg.getDirectory().isEnabled();
|
||||
}
|
||||
|
||||
protected void setParameters(PreparedStatement stmt, String searchTerm) throws SQLException {
|
||||
for (int i = 1; i <= stmt.getParameterMetaData().getParameterCount(); i++) {
|
||||
stmt.setString(i, searchTerm);
|
||||
|
@@ -22,9 +22,7 @@ package io.kamax.mxisd.backend.sql.generic;
|
||||
|
||||
import io.kamax.mxisd.backend.sql.SqlProfileProvider;
|
||||
import io.kamax.mxisd.config.sql.generic.GenericSqlProviderConfig;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
@Component
|
||||
public class GenericSqlProfileProvider extends SqlProfileProvider {
|
||||
|
||||
public GenericSqlProfileProvider(GenericSqlProviderConfig cfg) {
|
||||
|
@@ -0,0 +1,51 @@
|
||||
/*
|
||||
* mxisd - Matrix Identity Server Daemon
|
||||
* Copyright (C) 2018 Kamax Sarl
|
||||
*
|
||||
* https://www.kamax.io/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package io.kamax.mxisd.backend.sql.generic;
|
||||
|
||||
import io.kamax.mxisd.Mxisd;
|
||||
import io.kamax.mxisd.auth.AuthProviders;
|
||||
import io.kamax.mxisd.backend.IdentityStoreSupplier;
|
||||
import io.kamax.mxisd.directory.DirectoryProviders;
|
||||
import io.kamax.mxisd.lookup.ThreePidProviders;
|
||||
import io.kamax.mxisd.profile.ProfileProviders;
|
||||
|
||||
public class GenericSqlStoreSupplier implements IdentityStoreSupplier {
|
||||
|
||||
@Override
|
||||
public void accept(Mxisd mxisd) {
|
||||
if (mxisd.getConfig().getSql().getAuth().isEnabled()) {
|
||||
AuthProviders.register(() -> new GenericSqlAuthProvider(mxisd.getConfig().getSql(), mxisd.getInvite()));
|
||||
}
|
||||
|
||||
if (mxisd.getConfig().getSql().getDirectory().isEnabled()) {
|
||||
DirectoryProviders.register(() -> new GenericSqlDirectoryProvider(mxisd.getConfig().getSql(), mxisd.getConfig().getMatrix()));
|
||||
}
|
||||
|
||||
if (mxisd.getConfig().getSql().getIdentity().isEnabled()) {
|
||||
ThreePidProviders.register(() -> new GenericSqlThreePidProvider(mxisd.getConfig().getSql(), mxisd.getConfig().getMatrix()));
|
||||
}
|
||||
|
||||
if (mxisd.getConfig().getSql().getProfile().isEnabled()) {
|
||||
ProfileProviders.register(() -> new GenericSqlProfileProvider(mxisd.getConfig().getSql()));
|
||||
}
|
||||
}
|
||||
|
||||
}
|
@@ -23,13 +23,9 @@ package io.kamax.mxisd.backend.sql.generic;
|
||||
import io.kamax.mxisd.backend.sql.SqlThreePidProvider;
|
||||
import io.kamax.mxisd.config.MatrixConfig;
|
||||
import io.kamax.mxisd.config.sql.generic.GenericSqlProviderConfig;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
@Component
|
||||
public class GenericSqlThreePidProvider extends SqlThreePidProvider {
|
||||
|
||||
@Autowired
|
||||
public GenericSqlThreePidProvider(GenericSqlProviderConfig cfg, MatrixConfig mxCfg) {
|
||||
super(cfg, mxCfg);
|
||||
}
|
||||
|
@@ -22,19 +22,15 @@ package io.kamax.mxisd.backend.sql.synapse;
|
||||
|
||||
import io.kamax.mxisd.backend.sql.SqlConnectionPool;
|
||||
import io.kamax.mxisd.config.sql.synapse.SynapseSqlProviderConfig;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
import java.sql.PreparedStatement;
|
||||
import java.sql.ResultSet;
|
||||
import java.util.Optional;
|
||||
|
||||
@Component
|
||||
public class Synapse {
|
||||
|
||||
private SqlConnectionPool pool;
|
||||
|
||||
@Autowired
|
||||
public Synapse(SynapseSqlProviderConfig sqlCfg) {
|
||||
this.pool = new SqlConnectionPool(sqlCfg);
|
||||
}
|
||||
|
@@ -43,6 +43,10 @@ public class SynapseQueries {
|
||||
return "SELECT medium, address FROM user_threepids WHERE user_id = ?";
|
||||
}
|
||||
|
||||
public static String getRoles() {
|
||||
return "SELECT DISTINCT(group_id) FROM group_users WHERE user_id = ?";
|
||||
}
|
||||
|
||||
public static String findByDisplayName(String type, String domain) {
|
||||
if (StringUtils.equals("sqlite", type)) {
|
||||
return "select " + getUserId(type, domain) + ", displayname from profiles p where displayname like ?";
|
||||
|
@@ -24,32 +24,15 @@ import io.kamax.mxisd.backend.sql.generic.GenericSqlDirectoryProvider;
|
||||
import io.kamax.mxisd.config.MatrixConfig;
|
||||
import io.kamax.mxisd.config.sql.generic.GenericSqlProviderConfig;
|
||||
import io.kamax.mxisd.config.sql.synapse.SynapseSqlProviderConfig;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
import javax.annotation.PostConstruct;
|
||||
import java.sql.PreparedStatement;
|
||||
import java.sql.SQLException;
|
||||
import java.util.Objects;
|
||||
|
||||
@Component
|
||||
public class SynapseSqlDirectoryProvider extends GenericSqlDirectoryProvider {
|
||||
|
||||
@Autowired
|
||||
public SynapseSqlDirectoryProvider(SynapseSqlProviderConfig cfg, MatrixConfig mxCfg) {
|
||||
super(cfg, mxCfg);
|
||||
}
|
||||
|
||||
@Override
|
||||
protected void setParameters(PreparedStatement stmt, String searchTerm) throws SQLException {
|
||||
stmt.setString(1, "%" + searchTerm + "%");
|
||||
}
|
||||
|
||||
@PostConstruct
|
||||
public void build() {
|
||||
if (!isEnabled()) {
|
||||
return;
|
||||
}
|
||||
|
||||
GenericSqlProviderConfig.Type queries = cfg.getDirectory().getQuery();
|
||||
if (Objects.isNull(queries.getName().getValue())) {
|
||||
@@ -60,4 +43,9 @@ public class SynapseSqlDirectoryProvider extends GenericSqlDirectoryProvider {
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
protected void setParameters(PreparedStatement stmt, String searchTerm) throws SQLException {
|
||||
stmt.setString(1, "%" + searchTerm + "%");
|
||||
}
|
||||
|
||||
}
|
||||
|
@@ -22,13 +22,9 @@ package io.kamax.mxisd.backend.sql.synapse;
|
||||
|
||||
import io.kamax.mxisd.backend.sql.SqlProfileProvider;
|
||||
import io.kamax.mxisd.config.sql.synapse.SynapseSqlProviderConfig;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
@Component
|
||||
public class SynapseSqlProfileProvider extends SqlProfileProvider {
|
||||
|
||||
@Autowired
|
||||
public SynapseSqlProfileProvider(SynapseSqlProviderConfig cfg) {
|
||||
super(cfg);
|
||||
}
|
||||
|
@@ -0,0 +1,56 @@
|
||||
/*
|
||||
* mxisd - Matrix Identity Server Daemon
|
||||
* Copyright (C) 2018 Kamax Sarl
|
||||
*
|
||||
* https://www.kamax.io/
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
package io.kamax.mxisd.backend.sql.synapse;
|
||||
|
||||
import io.kamax.mxisd.Mxisd;
|
||||
import io.kamax.mxisd.backend.IdentityStoreSupplier;
|
||||
import io.kamax.mxisd.config.MxisdConfig;
|
||||
import io.kamax.mxisd.directory.DirectoryProviders;
|
||||
import io.kamax.mxisd.lookup.ThreePidProviders;
|
||||
import io.kamax.mxisd.profile.ProfileProviders;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
public class SynapseSqlStoreSupplier implements IdentityStoreSupplier {
|
||||
|
||||
private static final Logger log = LoggerFactory.getLogger(SynapseSqlStoreSupplier.class);
|
||||
|
||||
@Override
|
||||
public void accept(Mxisd mxisd) {
|
||||
accept(mxisd.getConfig());
|
||||
}
|
||||
|
||||
public void accept(MxisdConfig cfg) {
|
||||
if (cfg.getSynapseSql().getDirectory().isEnabled()) {
|
||||
DirectoryProviders.register(() -> new SynapseSqlDirectoryProvider(cfg.getSynapseSql(), cfg.getMatrix()));
|
||||
}
|
||||
|
||||
if (cfg.getSynapseSql().getIdentity().isEnabled()) {
|
||||
ThreePidProviders.register(() -> new SynapseSqlThreePidProvider(cfg.getSynapseSql(), cfg.getMatrix()));
|
||||
}
|
||||
|
||||
if (cfg.getSynapseSql().getProfile().isEnabled()) {
|
||||
log.debug("Profile is enabled, registering provider");
|
||||
ProfileProviders.register(() -> new SynapseSqlProfileProvider(cfg.getSynapseSql()));
|
||||
}
|
||||
}
|
||||
|
||||
}
|
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user