Compare commits
57 Commits
v1.1-rc.1
...
v1.3.0-alp
Author | SHA1 | Date | |
---|---|---|---|
|
7ec11ba8cf | ||
|
9317c11434 | ||
|
b257a0275f | ||
|
2aaa04062f | ||
|
54c3014568 | ||
|
c3ca73f576 | ||
|
4185b644b7 | ||
|
ace5918342 | ||
|
7ad985fead | ||
|
6a376db322 | ||
|
950f7c931c | ||
|
d160a44509 | ||
|
05493da27c | ||
|
df44428a85 | ||
|
e6f9c30611 | ||
|
06b2c787d3 | ||
|
5645f69208 | ||
|
92cf5c6b21 | ||
|
ad1b91f370 | ||
|
e9c29f1c03 | ||
|
f13748abeb | ||
|
7208c7e456 | ||
|
8857f636d6 | ||
|
d9fc41e8c7 | ||
|
da08e0b4ad | ||
|
11fc8f08b0 | ||
|
af4d734105 | ||
|
0f4f5ac81b | ||
|
8c4ddd2e65 | ||
|
cb8049b54a | ||
|
99b7d9f27d | ||
|
ded5e3db5e | ||
|
b892d19023 | ||
|
026a2e82d9 | ||
|
b881f73798 | ||
|
99d793b5ed | ||
|
cb02f62b9d | ||
|
bd9161ec9b | ||
|
544cab816c | ||
|
cdb56aec1f | ||
|
407138e972 | ||
|
3eee4eaccf | ||
|
b3aefbed77 | ||
|
29017fbe1e | ||
|
843fa04f19 | ||
|
f7d1a300f1 | ||
|
f16eb264be | ||
|
f29014be1f | ||
|
20a4d8dd91 | ||
|
0c0feab0c0 | ||
|
dd313881db | ||
|
feb37112b2 | ||
|
1ab8a27fda | ||
|
deafc420a5 | ||
|
fce15f0e29 | ||
|
5b5893f407 | ||
|
f55d5fbc80 |
1
.gitignore
vendored
1
.gitignore
vendored
@@ -7,6 +7,7 @@ out/
|
|||||||
.idea/
|
.idea/
|
||||||
|
|
||||||
# Local dev config
|
# Local dev config
|
||||||
|
/mxisd.yaml
|
||||||
/application.yaml
|
/application.yaml
|
||||||
|
|
||||||
# Local dev storage
|
# Local dev storage
|
||||||
|
@@ -14,4 +14,5 @@ ENV SQLITE_DATABASE_PATH="/var/mxisd/mxisd.db"
|
|||||||
CMD [ "/start.sh" ]
|
CMD [ "/start.sh" ]
|
||||||
|
|
||||||
ADD src/docker/start.sh /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
|
||||||
|
@@ -1,6 +1,6 @@
|
|||||||
mxisd - Federated Matrix Identity Server
|
mxisd - Federated Matrix Identity Server
|
||||||
----------------------------------------
|
----------------------------------------
|
||||||

|

|
||||||
|
|
||||||
- [Overview](#overview)
|
- [Overview](#overview)
|
||||||
- [Features](#features)
|
- [Features](#features)
|
||||||
|
@@ -1,99 +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-io/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'
|
|
||||||
|
|
||||||
|
|
||||||
################
|
|
||||||
# LDAP Backend #
|
|
||||||
################
|
|
||||||
# If you would like to integrate with your AD/Samba/LDAP server,
|
|
||||||
# see https://github.com/kamax-io/mxisd/blob/master/docs/backends/ldap.md
|
|
||||||
|
|
||||||
###############
|
|
||||||
# SQL Backend #
|
|
||||||
###############
|
|
||||||
# If you would like to integrate with a MySQL/MariaDB/PostgreQL/SQLite DB,
|
|
||||||
# see https://github.com/kamax-io/mxisd/blob/master/docs/backends/sql.md
|
|
||||||
|
|
||||||
################
|
|
||||||
# REST Backend #
|
|
||||||
################
|
|
||||||
# If you would like to integrate with an existing web service/webapp,
|
|
||||||
# see https://github.com/kamax-io/mxisd/blob/master/docs/backends/rest.md
|
|
||||||
|
|
||||||
|
|
||||||
#################################################
|
|
||||||
# Notifications for invites/addition to profile #
|
|
||||||
#################################################
|
|
||||||
# If you would like to change the content,
|
|
||||||
# see https://github.com/kamax-io/mxisd/blob/master/docs/threepids/notifications/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"
|
|
121
build.gradle
121
build.gradle
@@ -1,8 +1,8 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2017 Maxime Dor
|
* Copyright (C) 2017 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://max.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU Affero General Public License as
|
* it under the terms of the GNU Affero General Public License as
|
||||||
@@ -21,9 +21,11 @@
|
|||||||
import java.util.regex.Pattern
|
import java.util.regex.Pattern
|
||||||
|
|
||||||
apply plugin: 'java'
|
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 distDir = "${project.buildDir}/dist"
|
||||||
|
|
||||||
def debBinPath = "/usr/lib/mxisd"
|
def debBinPath = "/usr/lib/mxisd"
|
||||||
@@ -31,7 +33,8 @@ def debConfPath = "/etc/mxisd"
|
|||||||
def debDataPath = "/var/lib/mxisd"
|
def debDataPath = "/var/lib/mxisd"
|
||||||
def debSystemdPath = "/etc/systemd/system"
|
def debSystemdPath = "/etc/systemd/system"
|
||||||
|
|
||||||
def debConfFileName = "mxisd-sample.yaml"
|
def debConfFileName = confFileName
|
||||||
|
def debStartScriptFilename = "mxisd"
|
||||||
|
|
||||||
def debBuildBasePath = "${project.buildDir}/tmp/debian"
|
def debBuildBasePath = "${project.buildDir}/tmp/debian"
|
||||||
def debBuildDebianPath = "${debBuildBasePath}/DEBIAN"
|
def debBuildDebianPath = "${debBuildBasePath}/DEBIAN"
|
||||||
@@ -41,47 +44,61 @@ def debBuildDataPath = "${debBuildBasePath}${debDataPath}"
|
|||||||
def debBuildSystemdPath = "${debBuildBasePath}${debSystemdPath}"
|
def debBuildSystemdPath = "${debBuildBasePath}${debSystemdPath}"
|
||||||
|
|
||||||
def dockerImageName = "kamax/mxisd"
|
def dockerImageName = "kamax/mxisd"
|
||||||
def dockerImageTag = "${dockerImageName}:${gitVersion()}"
|
def dockerImageTag = "${dockerImageName}:${mxisdVersion()}"
|
||||||
|
|
||||||
|
group = 'io.kamax'
|
||||||
|
mainClassName = 'io.kamax.mxisd.MxisdStandaloneExec'
|
||||||
|
|
||||||
|
String mxisdVersion() {
|
||||||
|
def versionPattern = Pattern.compile("v(\\d+\\.)?(\\d+\\.)?(\\d+)(-.*)?")
|
||||||
|
|
||||||
|
String version = System.getenv('MXISD_BUILD_VERSION')
|
||||||
|
if (version == null || version.size() == 0) {
|
||||||
|
version = gitVersion()
|
||||||
|
}
|
||||||
|
return versionPattern.matcher(version).matches() ? version.substring(1) : version
|
||||||
|
}
|
||||||
|
|
||||||
String gitVersion() {
|
String gitVersion() {
|
||||||
def versionPattern = Pattern.compile("v(\\d+\\.)?(\\d+\\.)?(\\d+)(-.*)?")
|
|
||||||
ByteArrayOutputStream out = new ByteArrayOutputStream()
|
ByteArrayOutputStream out = new ByteArrayOutputStream()
|
||||||
exec {
|
exec {
|
||||||
commandLine = ['git', 'describe', '--tags', '--always', '--dirty']
|
commandLine = ['git', 'describe', '--tags', '--always', '--dirty']
|
||||||
standardOutput = out
|
standardOutput = out
|
||||||
}
|
}
|
||||||
def v = out.toString().replace(System.lineSeparator(), '')
|
return out.toString().replace(System.lineSeparator(), '')
|
||||||
return versionPattern.matcher(v).matches() ? v.substring(1) : v
|
|
||||||
}
|
}
|
||||||
|
|
||||||
buildscript {
|
buildscript {
|
||||||
repositories {
|
repositories {
|
||||||
mavenCentral()
|
jcenter()
|
||||||
}
|
}
|
||||||
|
|
||||||
dependencies {
|
dependencies {
|
||||||
classpath 'org.springframework.boot:spring-boot-gradle-plugin:1.5.3.RELEASE'
|
classpath 'com.github.jengelman.gradle.plugins:shadow:4.0.3'
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
repositories {
|
repositories {
|
||||||
|
jcenter()
|
||||||
maven { url "https://kamax.io/maven/releases/" }
|
maven { url "https://kamax.io/maven/releases/" }
|
||||||
maven { url "https://kamax.io/maven/snapshots/" }
|
maven { url "https://kamax.io/maven/snapshots/" }
|
||||||
mavenCentral()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
dependencies {
|
dependencies {
|
||||||
|
// Logging
|
||||||
|
compile 'org.slf4j:slf4j-simple:1.7.25'
|
||||||
|
|
||||||
// Easy file management
|
// Easy file management
|
||||||
compile 'commons-io:commons-io:2.5'
|
compile 'commons-io:commons-io:2.5'
|
||||||
|
|
||||||
// Spring Boot - standalone app
|
// Config management
|
||||||
compile 'org.springframework.boot:spring-boot-starter-web:1.5.10.RELEASE'
|
compile 'org.yaml:snakeyaml:1.23'
|
||||||
|
|
||||||
// Thymeleaf for HTML templates
|
|
||||||
compile "org.springframework.boot:spring-boot-starter-thymeleaf:1.5.10.RELEASE"
|
|
||||||
|
|
||||||
// Matrix Java SDK
|
// Matrix Java SDK
|
||||||
compile 'io.kamax:matrix-java-sdk:0.0.11'
|
compile 'io.kamax:matrix-java-sdk:0.0.14-8-g0e57ec6'
|
||||||
|
|
||||||
|
// ORMLite
|
||||||
|
compile 'com.j256.ormlite:ormlite-jdbc:5.0'
|
||||||
|
|
||||||
// ed25519 handling
|
// ed25519 handling
|
||||||
compile 'net.i2p.crypto:eddsa:0.1.0'
|
compile 'net.i2p.crypto:eddsa:0.1.0'
|
||||||
@@ -99,15 +116,12 @@ dependencies {
|
|||||||
compile 'com.googlecode.libphonenumber:libphonenumber:8.7.1'
|
compile 'com.googlecode.libphonenumber:libphonenumber:8.7.1'
|
||||||
|
|
||||||
// E-mail sending
|
// E-mail sending
|
||||||
compile 'com.sun.mail:javax.mail:1.5.6'
|
compile 'javax.mail:javax.mail-api:1.6.2'
|
||||||
compile 'javax.mail:javax.mail-api:1.5.6'
|
compile 'com.sun.mail:javax.mail:1.6.2'
|
||||||
|
|
||||||
// Google Firebase Authentication backend
|
// Google Firebase Authentication backend
|
||||||
compile 'com.google.firebase:firebase-admin:5.3.0'
|
compile 'com.google.firebase:firebase-admin:5.3.0'
|
||||||
|
|
||||||
// ORMLite
|
|
||||||
compile 'com.j256.ormlite:ormlite-jdbc:5.0'
|
|
||||||
|
|
||||||
// Connection Pool
|
// Connection Pool
|
||||||
compile 'com.mchange:c3p0:0.9.5.2'
|
compile 'com.mchange:c3p0:0.9.5.2'
|
||||||
|
|
||||||
@@ -126,36 +140,31 @@ dependencies {
|
|||||||
// SendGrid SDK to send emails from GCE
|
// SendGrid SDK to send emails from GCE
|
||||||
compile 'com.sendgrid:sendgrid-java:2.2.2'
|
compile 'com.sendgrid:sendgrid-java:2.2.2'
|
||||||
|
|
||||||
|
// ZT-Exec for exec identity store
|
||||||
|
compile 'org.zeroturnaround:zt-exec:1.10'
|
||||||
|
|
||||||
|
// HTTP server
|
||||||
|
compile 'io.undertow:undertow-core:2.0.16.Final'
|
||||||
|
|
||||||
testCompile 'junit:junit:4.12'
|
testCompile 'junit:junit:4.12'
|
||||||
testCompile 'com.github.tomakehurst:wiremock:2.8.0'
|
testCompile 'com.github.tomakehurst:wiremock:2.8.0'
|
||||||
|
testCompile 'com.unboundid:unboundid-ldapsdk:4.0.9'
|
||||||
|
testCompile 'com.icegreen:greenmail:1.5.9'
|
||||||
}
|
}
|
||||||
|
|
||||||
springBoot {
|
shadowJar {
|
||||||
executable = true
|
baseName = project.name
|
||||||
|
classifier = null
|
||||||
embeddedLaunchScriptProperties = [
|
version = null
|
||||||
confFolder: "/etc/default"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
|
|
||||||
processResources {
|
task debBuild(dependsOn: shadowJar) {
|
||||||
doLast {
|
doLast {
|
||||||
copy {
|
String debVersion = mxisdVersion()
|
||||||
from('build/resources/main/application.yaml') {
|
println "Version for package: ${debVersion}"
|
||||||
rename 'application.yaml', 'mxisd.yaml'
|
|
||||||
}
|
|
||||||
into 'build/resources/main'
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
task buildDeb(dependsOn: build) {
|
|
||||||
doLast {
|
|
||||||
def v = gitVersion()
|
|
||||||
println "Version for package: ${v}"
|
|
||||||
mkdir distDir
|
mkdir distDir
|
||||||
mkdir debBuildBasePath
|
mkdir debBuildBasePath
|
||||||
mkdir "${debBuildBasePath}/DEBIAN"
|
mkdir debBuildDebianPath
|
||||||
mkdir debBuildBinPath
|
mkdir debBuildBinPath
|
||||||
mkdir debBuildConfPath
|
mkdir debBuildConfPath
|
||||||
mkdir debBuildDataPath
|
mkdir debBuildDataPath
|
||||||
@@ -166,10 +175,10 @@ task buildDeb(dependsOn: build) {
|
|||||||
into debBuildBinPath
|
into debBuildBinPath
|
||||||
}
|
}
|
||||||
|
|
||||||
ant.chmod(
|
copy {
|
||||||
file: "${debBuildBinPath}/mxisd.jar",
|
from "${project.file("src/script/" + debStartScriptFilename)}"
|
||||||
perm: 'a+x'
|
into debBuildBinPath
|
||||||
)
|
}
|
||||||
|
|
||||||
copy {
|
copy {
|
||||||
from(project.file(confFileName)) {
|
from(project.file(confFileName)) {
|
||||||
@@ -178,16 +187,16 @@ task buildDeb(dependsOn: build) {
|
|||||||
into debBuildConfPath
|
into debBuildConfPath
|
||||||
}
|
}
|
||||||
|
|
||||||
ant.replaceregexp(
|
ant.replaceregexp( // FIXME adapt to new config format
|
||||||
file: "${debBuildConfPath}/${debConfFileName}",
|
file: "${debBuildConfPath}/${debConfFileName}",
|
||||||
match: "key.path:(.*)",
|
match: "key:\\R path:(.*)",
|
||||||
replace: "key.path: '${debDataPath}/signing.key'"
|
replace: "key:\n path: '${debDataPath}/signing.key'"
|
||||||
)
|
)
|
||||||
|
|
||||||
ant.replaceregexp(
|
ant.replaceregexp( // FIXME adapt to new config format
|
||||||
file: "${debBuildConfPath}/${debConfFileName}",
|
file: "${debBuildConfPath}/${debConfFileName}",
|
||||||
match: "storage.provider.sqlite.database:(.*)",
|
match: "storage:\\R provider:\\R sqlite:\\R database:(.*)",
|
||||||
replace: "storage.provider.sqlite.database: '${debDataPath}/mxisd.db'"
|
replace: "storage:\n provider:\n sqlite:\n database: '${debDataPath}/mxisd.db'"
|
||||||
)
|
)
|
||||||
|
|
||||||
copy {
|
copy {
|
||||||
@@ -198,7 +207,7 @@ task buildDeb(dependsOn: build) {
|
|||||||
ant.replace(
|
ant.replace(
|
||||||
file: "${debBuildDebianPath}/control",
|
file: "${debBuildDebianPath}/control",
|
||||||
token: 'Version: 0',
|
token: 'Version: 0',
|
||||||
value: "Version: ${v}"
|
value: "Version: ${debVersion}"
|
||||||
)
|
)
|
||||||
|
|
||||||
ant.replace(
|
ant.replace(
|
||||||
@@ -234,7 +243,7 @@ task buildDeb(dependsOn: build) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
task dockerBuild(type: Exec, dependsOn: build) {
|
task dockerBuild(type: Exec, dependsOn: shadowJar) {
|
||||||
commandLine 'docker', 'build', '-t', dockerImageTag, project.rootDir
|
commandLine 'docker', 'build', '-t', dockerImageTag, project.rootDir
|
||||||
|
|
||||||
doLast {
|
doLast {
|
||||||
|
@@ -1,8 +1,11 @@
|
|||||||
# Table of Contents
|
# Table of Contents
|
||||||
|
- [Identity Concepts in Matrix](concepts.md)
|
||||||
|
- [Getting Started](getting-started.md)
|
||||||
- [Build from sources](build.md) (Optional)
|
- [Build from sources](build.md) (Optional)
|
||||||
- Installation
|
- Installation
|
||||||
- [Debian package](install/debian.md)
|
- [Debian package](install/debian.md)
|
||||||
- [ArchLinux](install/archlinux.md)
|
- [ArchLinux](install/archlinux.md)
|
||||||
|
- [NixOS](install/nixos.md)
|
||||||
- [Docker](install/docker.md)
|
- [Docker](install/docker.md)
|
||||||
- [From source](install/source.md)
|
- [From source](install/source.md)
|
||||||
- [Architecture overview](architecture.md)
|
- [Architecture overview](architecture.md)
|
||||||
@@ -20,3 +23,4 @@
|
|||||||
- [SendGrid](threepids/notification/sendgrid-handler.md)
|
- [SendGrid](threepids/notification/sendgrid-handler.md)
|
||||||
- [Sessions](threepids/session/session.md)
|
- [Sessions](threepids/session/session.md)
|
||||||
- [Views](threepids/session/session-views.md)
|
- [Views](threepids/session/session-views.md)
|
||||||
|
- [FAQ](faq.md)
|
||||||
|
@@ -18,12 +18,9 @@ TCP 443
|
|||||||
| +-------------------+
|
| +-------------------+
|
||||||
TCP 8090 +-> | mxisd |
|
TCP 8090 +-> | mxisd |
|
||||||
| |
|
| |
|
||||||
| - Profile's 3PIDs >----+
|
| - Profile's 3PIDs |
|
||||||
| - 3PID Invites | | +--------------------------+
|
| - 3PID Invites |
|
||||||
+-|-----------------+ +>----------> | Central Identity service |
|
+-|-----------------+
|
||||||
| | TCP 443 | Matrix.org / Vector.im |
|
|
||||||
| | +--------------------------+
|
|
||||||
+>-------------------->+
|
|
||||||
|
|
|
|
||||||
TCP 443
|
TCP 443
|
||||||
| +------------------------+
|
| +------------------------+
|
||||||
|
@@ -12,14 +12,13 @@
|
|||||||
|
|
||||||
### Build
|
### Build
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/kamax-io/mxisd.git
|
git clone https://github.com/kamax-matrix/mxisd.git
|
||||||
cd mxisd
|
cd mxisd
|
||||||
./gradlew build
|
./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).
|
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:
|
Start the server in foreground to validate the build and configuration:
|
||||||
```bash
|
```bash
|
||||||
@@ -29,12 +28,14 @@ java -jar build/libs/mxisd.jar
|
|||||||
Ensure the signing key is available:
|
Ensure the signing key is available:
|
||||||
```bash
|
```bash
|
||||||
$ curl 'http://localhost:8090/_matrix/identity/api/v1/pubkey/ed25519:0'
|
$ curl 'http://localhost:8090/_matrix/identity/api/v1/pubkey/ed25519:0'
|
||||||
|
|
||||||
{"public_key":"..."}
|
{"public_key":"..."}
|
||||||
```
|
```
|
||||||
|
|
||||||
Test basic recursive lookup (requires Internet connection with access to TCP 443):
|
Test basic recursive lookup (requires Internet connection with access to TCP 443):
|
||||||
```bash
|
```bash
|
||||||
$ curl 'http://localhost:8090/_matrix/identity/api/v1/lookup?medium=email&address=mxisd-federation-test@kamax.io'
|
$ 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",...}
|
{"address":"mxisd-federation-test@kamax.io","medium":"email","mxid":"@mxisd-lookup-test:kamax.io",...}
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -57,7 +58,7 @@ Requirements:
|
|||||||
|
|
||||||
[Build mxisd](#build) then:
|
[Build mxisd](#build) then:
|
||||||
```bash
|
```bash
|
||||||
./gradlew buildDeb
|
./gradlew debBuild
|
||||||
```
|
```
|
||||||
You will find the debian package in `build/dist`.
|
You will find the debian package in `build/dist`.
|
||||||
Then follow the instruction in the [Debian package](install/debian.md) document.
|
Then follow the instruction in the [Debian package](install/debian.md) document.
|
||||||
|
@@ -1,7 +1,6 @@
|
|||||||
# Configuration
|
# Configuration
|
||||||
- [Concepts](#concepts)
|
- [Concepts](#concepts)
|
||||||
- [Syntax](#syntax)
|
- [Syntax](#syntax)
|
||||||
- [Variables](#variables)
|
|
||||||
- [Matrix](#matrix)
|
- [Matrix](#matrix)
|
||||||
- [Server](#server)
|
- [Server](#server)
|
||||||
- [Storage](#storage)
|
- [Storage](#storage)
|
||||||
@@ -11,36 +10,15 @@
|
|||||||
|
|
||||||
## Concepts
|
## Concepts
|
||||||
### Syntax
|
### Syntax
|
||||||
The configuration file is [YAML](http://yaml.org/) based, allowing two types of syntax.
|
The configuration file is [YAML](http://yaml.org/) based:
|
||||||
|
|
||||||
Properties-like:
|
|
||||||
```yaml
|
|
||||||
my.config.item: 'value'
|
|
||||||
```
|
|
||||||
|
|
||||||
Object-like:
|
|
||||||
```yaml
|
```yaml
|
||||||
my:
|
my:
|
||||||
config:
|
config:
|
||||||
item: 'value'
|
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
|
||||||
`matrix.domain`
|
`matrix.domain`
|
||||||
@@ -53,7 +31,9 @@ Namespace to create arbitrary list of Identity servers, usable in other parts of
|
|||||||
|
|
||||||
Example:
|
Example:
|
||||||
```yaml
|
```yaml
|
||||||
matrix.identity.servers:
|
matrix:
|
||||||
|
identity:
|
||||||
|
servers:
|
||||||
myOtherServers:
|
myOtherServers:
|
||||||
- 'https://other1.example.org'
|
- 'https://other1.example.org'
|
||||||
- 'https://other2.example.org'
|
- 'https://other2.example.org'
|
||||||
@@ -82,19 +62,23 @@ See the dedicated documents:
|
|||||||
|
|
||||||
Example:
|
Example:
|
||||||
```yaml
|
```yaml
|
||||||
notification.handler.email: 'sendgrid'
|
notification:
|
||||||
notification.handler.msisdn: 'raw'
|
handler:
|
||||||
|
email: 'sendgrid'
|
||||||
|
msisdn: 'raw'
|
||||||
```
|
```
|
||||||
- Emails notifications would use the `sendgrid` handler, which define its own configuration under `notification.handlers.sendgrid`
|
- 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
|
### Handlers
|
||||||
- `notification.handers.<handler ID>`: Handler-specific configuration for the given handler ID. Repeatable.
|
- `notification.handers.<handler ID>`: Handler-specific configuration for the given handler ID. Repeatable.
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
```yaml
|
```yaml
|
||||||
notification.handlers.raw: ...
|
notification:
|
||||||
notification.handlers.sendgrid: ...
|
handlers:
|
||||||
|
raw: ...
|
||||||
|
sendgrid: ...
|
||||||
```
|
```
|
||||||
|
|
||||||
Built-in:
|
Built-in:
|
||||||
|
16
docs/faq.md
16
docs/faq.md
@@ -19,8 +19,9 @@ started and answer questions you might have.
|
|||||||
### Do I need to use mxisd if I run a Homeserver?
|
### 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.
|
No, but it is strongly recommended, even if you don't use any Identity store or integration.
|
||||||
|
|
||||||
In its default configuration, mxisd will talk to the central Matrix Identity servers and use other federated public
|
In its default configuration, mxisd uses other federated public servers when performing queries.
|
||||||
servers when performing queries, giving you access to at least the same information as if you were not running it.
|
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
|
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.
|
privacy consequences, which is not the case with the central Matrix.org servers.
|
||||||
@@ -70,18 +71,15 @@ So really, you should go with mxisd.
|
|||||||
### Will I loose access to the central Matrix.org/Vector.im Identity data if I use mxisd?
|
### Will I loose access to the central Matrix.org/Vector.im Identity data if I use mxisd?
|
||||||
No.
|
No.
|
||||||
|
|
||||||
In its default configuration, mxisd act as a proxy to Matrix.org/Vector.im. You will have access to the same data and
|
In its default configuration, mxisd does not talk to the central Identity server matrix.org to avoid leaking your private
|
||||||
behaviour than if you were using them directly. There is no downside in using mxisd with the default configuration.
|
data and those of people you might know.
|
||||||
|
|
||||||
mxisd can also be configured not to talk to the central Identity servers if you wish.
|
mxisd [can be configured](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!
|
### So mxisd is just a big hack! I don't want to use non-official features!
|
||||||
mxisd primary concern is to always be compatible with the Matrix ecosystem and the Identity service API.
|
mxisd primary concerns are your privacy and to always be compatible with the Matrix ecosystem and the Identity service API.
|
||||||
Whenever the API will be updated and/or enhanced, mxisd will follow, remaining 100% compatible with the ecosystem.
|
Whenever the API will be updated and/or enhanced, mxisd will follow, remaining 100% compatible with the ecosystem.
|
||||||
|
|
||||||
Therefore, using mxisd is a safe choice. It will be like using the central Matrix.org Identity servers, yet not closing
|
|
||||||
the door to a growing list of enhancements and integrations.
|
|
||||||
|
|
||||||
### Should I use mxisd if I don't host my own Homeserver?
|
### Should I use mxisd if I don't host my own Homeserver?
|
||||||
No.
|
No.
|
||||||
|
|
||||||
|
@@ -74,7 +74,15 @@ See your Identity store [documentation](../stores/README.md) on how to enable th
|
|||||||
|
|
||||||
|
|
||||||
## Advanced
|
## Advanced
|
||||||
The Authentication feature allows users to login to their Homeserver by using their 3PIDs in a configured Identity store.
|
The Authentication feature allows users to:
|
||||||
|
- Rewrite usernames matching a pattern to be mapped to another username via a 3PID.
|
||||||
|
- login to their Homeserver by using their 3PIDs in a configured Identity store.
|
||||||
|
|
||||||
|
This feature also allows to work around the following issues:
|
||||||
|
- Lowercase all usernames for synapse, allowing case-insensitive login
|
||||||
|
- Unable to login on synapse if username is numerical
|
||||||
|
- Any generic transformation of username prior to sending to synapse, bypassing the restriction that password providers
|
||||||
|
cannot change the localpart being authenticated.
|
||||||
|
|
||||||
### Overview
|
### Overview
|
||||||
This is performed by intercepting the Homeserver endpoint `/_matrix/client/r0/login` as depicted below:
|
This is performed by intercepting the Homeserver endpoint `/_matrix/client/r0/login` as depicted below:
|
||||||
@@ -109,10 +117,10 @@ Steps of user authentication using a 3PID:
|
|||||||
4. The response from the Homeserver is sent back to the client, believing it was the HS which directly answered.
|
4. The response from the Homeserver is sent back to the client, believing it was the HS which directly answered.
|
||||||
|
|
||||||
### Requirements
|
### Requirements
|
||||||
- [Basic Authentication configured and working](#basic)
|
|
||||||
- Reverse proxy setup
|
|
||||||
- Homeserver
|
|
||||||
- Compatible [Identity store](../stores/README.md)
|
- Compatible [Identity store](../stores/README.md)
|
||||||
|
- [Basic Authentication configured and working](#basic)
|
||||||
|
- Client and Homeserver using the [C2S API r0.4.x](https://matrix.org/docs/spec/client_server/r0.4.0.html) or later
|
||||||
|
- Reverse proxy setup
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
#### Reverse Proxy
|
#### Reverse Proxy
|
||||||
@@ -143,12 +151,53 @@ the internal IP of the Homeserver so it can talk to it directly to integrate its
|
|||||||
|
|
||||||
To do so, put the following configuration in your mxisd configuration:
|
To do so, put the following configuration in your mxisd configuration:
|
||||||
```yaml
|
```yaml
|
||||||
dns.overwrite.homeserver.client:
|
dns:
|
||||||
|
overwrite:
|
||||||
|
homeserver:
|
||||||
|
client:
|
||||||
- name: 'example.org'
|
- name: 'example.org'
|
||||||
value: 'http://localhost:8008'
|
value: 'http://localhost:8008'
|
||||||
```
|
```
|
||||||
`name` must be the hostname of the URL that clients use when connecting to the Homeserver.
|
`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`
|
You can use `${server.name}` to auto-populate the `value` using the `server.name` configuration option and avoid duplicating it.
|
||||||
using the `matrix.domain` configuration option and avoid duplicating it.
|
In case the hostname is the same as your Matrix domain and `server.name` is not explicitely set in the config, `server.name` will default to
|
||||||
|
`matrix.domain` and will still probably have the correct value.
|
||||||
|
|
||||||
`value` is the base internal URL of the Homeserver, without any `/_matrix/..` or trailing `/`.
|
`value` is the base internal URL of the Homeserver, without any `/_matrix/..` or trailing `/`.
|
||||||
|
|
||||||
|
#### Username rewrite
|
||||||
|
In mxisd config:
|
||||||
|
```yaml
|
||||||
|
auth:
|
||||||
|
rewrite:
|
||||||
|
user:
|
||||||
|
rules:
|
||||||
|
- regex: <your regexp>
|
||||||
|
medium: 'your.custom.medium.type'
|
||||||
|
```
|
||||||
|
`rules` takes a list of rules. Rules have two properties:
|
||||||
|
- `regexp`: The regex pattern to match. This **MUST** match the full string. See [Java regex](https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html) for syntax.
|
||||||
|
- `medium`: Custom 3PID type that will be used in the 3PID lookup. This can be anything you want and needs to be supported
|
||||||
|
by your Identity store config and/or code.
|
||||||
|
|
||||||
|
Rules are matched in listed order.
|
||||||
|
|
||||||
|
Common regexp patterns:
|
||||||
|
- Numerical usernames: `[0-9]+`
|
||||||
|
|
||||||
|
##### LDAP Example
|
||||||
|
If your users use their numerical employee IDs, which cannot be used with synapse, you can make it work with (relevant config only):
|
||||||
|
```yaml
|
||||||
|
auth:
|
||||||
|
rewrite:
|
||||||
|
user:
|
||||||
|
rules:
|
||||||
|
- regex: '[0-9]+'
|
||||||
|
medium: 'kmx.employee.id'
|
||||||
|
|
||||||
|
ldap:
|
||||||
|
attribute:
|
||||||
|
threepid:
|
||||||
|
kmx.employee.id:
|
||||||
|
- 'ldapAttributeForEmployeeId'
|
||||||
|
```
|
||||||
|
@@ -5,15 +5,18 @@ 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.
|
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.
|
**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.
|
of working configuration.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
```yaml
|
```yaml
|
||||||
lookup.recursive.bridge.enabled: <boolean>
|
lookup:
|
||||||
lookup.recursive.bridge.recursiveOnly: <boolean>
|
recursive:
|
||||||
lookup.recursive.bridge.server: <URL to the bridge endpoint for all 3PID medium>
|
bridge:
|
||||||
lookup.recursive.bridge.mappings:
|
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>
|
<3PID MEDIUM HERE>: <URL to dedicated bridge for that medium>
|
||||||
|
|
||||||
```
|
```
|
||||||
|
@@ -123,20 +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:
|
To do so, use the following configuration:
|
||||||
```yaml
|
```yaml
|
||||||
dns.overwrite.homeserver.client:
|
dns:
|
||||||
|
overwrite:
|
||||||
|
homeserver:
|
||||||
|
client:
|
||||||
- name: 'example.org'
|
- name: 'example.org'
|
||||||
value: 'http://localhost:8008'
|
value: 'http://localhost:8008'
|
||||||
```
|
```
|
||||||
`name` must be the hostname of the URL that clients use when connecting to the Homeserver.
|
- `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
|
- `value` is the base internal URL of the Homeserver, without any `/_matrix/..` or trailing `/`.
|
||||||
the `matrix.domain` configuration option and avoid duplicating it.
|
|
||||||
|
|
||||||
`value` is the base internal URL of the Homeserver, without any `/_matrix/..` or trailing `/`.
|
|
||||||
|
|
||||||
## Next steps
|
## Next steps
|
||||||
### Homeserver results
|
### Homeserver results
|
||||||
You can configure if the Homeserver should be queried at all when doing a directory search.
|
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:
|
To disable Homeserver results, set the following in mxisd configuration file:
|
||||||
```yaml
|
```yaml
|
||||||
directory.exclude.homeserever: 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
|
||||||
```
|
```
|
||||||
|
72
docs/features/experimental/application-service.md
Normal file
72
docs/features/experimental/application-service.md
Normal file
@@ -0,0 +1,72 @@
|
|||||||
|
# Integration as an 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.
|
||||||
|
|
||||||
|
## 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.
|
||||||
|
|
||||||
|
### 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
|
||||||
|
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>'
|
||||||
|
```
|
||||||
|
|
||||||
|
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
|
||||||
|
#### Synapse
|
||||||
|
Create a new appservice registration file. Futher config will assume it is in `/etc/matrix-synapse/appservice-mxisd.yaml`
|
||||||
|
```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: []
|
||||||
|
```
|
||||||
|
`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'
|
||||||
|
- ...
|
||||||
|
```
|
||||||
|
|
||||||
|
Restart synapse when done to register mxisd.
|
||||||
|
|
||||||
|
#### Others
|
||||||
|
See your Homeserver documentation on how to integrate.
|
||||||
|
|
||||||
|
### Test
|
||||||
|
Invite a user which is part of your domain while an appropriate Identity store is used.
|
16
docs/features/experimental/profile.md
Normal file
16
docs/features/experimental/profile.md
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
# Profile
|
||||||
|
**WARNING**: The following sub-features are considered experimental and not officially supported. Use at your own peril.
|
||||||
|
|
||||||
|
## Public Profile enhancement
|
||||||
|
This feature allows to enhance a public profile query with more info than just Matrix ID and Display name, allowing for
|
||||||
|
custom applications to retrieve custom data not currently provided by synapse, per example.
|
||||||
|
|
||||||
|
**WARNING**: This information can be queried without authentication as per the specification. Do not enable unless in a
|
||||||
|
controlled environment.
|
||||||
|
|
||||||
|
### Configuration
|
||||||
|
#### Reverse proxy
|
||||||
|
##### Apache
|
||||||
|
```apache
|
||||||
|
ProxyPassMatch "^/_matrix/client/r0/profile/([^/]+)$" "http://127.0.0.1:8090/_matrix/client/r0/profile/$1"
|
||||||
|
```
|
@@ -5,8 +5,8 @@ Federated Identity server using the DNS domain part of the 3PID.
|
|||||||
Emails are the best candidate for this kind of resolution which are DNS domain based already.
|
Emails are the best candidate for this kind of resolution which are DNS domain based already.
|
||||||
On the other hand, Phone numbers cannot be resolved this way.
|
On the other hand, Phone numbers cannot be resolved this way.
|
||||||
|
|
||||||
For 3PIDs which are not compatible with the DNS system, mxisd will talk to the central Identity server of matrix.org by
|
For 3PIDs which are not compatible with the DNS system, mxisd can be configured to talk to fallback Identity servers like
|
||||||
default.
|
the central matrix.org one. See the [Identity feature](identity.md#lookups) for instructions on how to enable it.
|
||||||
|
|
||||||
Outbound federation is enabled by default while inbound federation is opt-in and require a specific DNS record.
|
Outbound federation is enabled by default while inbound federation is opt-in and require a specific DNS record.
|
||||||
|
|
||||||
@@ -17,16 +17,14 @@ Outbound federation is enabled by default while inbound federation is opt-in and
|
|||||||
| | | +------> +----------+
|
| | | +------> +----------+
|
||||||
| | | |
|
| | | |
|
||||||
| Invites / Lookups | | |
|
| Invites / Lookups | | |
|
||||||
Federated | +--------+ | | | +-------------------+
|
Federated | +--------+ | | |
|
||||||
Identity ---->| Remote |>-----------+ +------> | Remote Federated |
|
Identity ---->| Remote |>-----------+ |
|
||||||
Server | +--------+ | | | mxisd servers |
|
Server | +--------+ | |
|
||||||
| | | +-------------------+
|
| | |
|
||||||
| +--------+ | |
|
| +--------+ | | +-------------------+
|
||||||
Homeserver --->| Local |>------------------+
|
Homeserver --->| Local |>------------------+------> | Remote Federated |
|
||||||
and clients | +--------+ | | +--------------------------+
|
and clients | +--------+ | | mxisd servers |
|
||||||
+-------------------+ +------> | Central Identity service |
|
+-------------------+ +-------------------+
|
||||||
| Matrix.org / Vector.im |
|
|
||||||
+--------------------------+
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Inbound
|
## Inbound
|
||||||
@@ -42,10 +40,21 @@ 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,
|
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:
|
use the following mxisd configuration options:
|
||||||
```yaml
|
```yaml
|
||||||
lookup.recursive.enabled: false
|
lookup:
|
||||||
invite.resolution.recursive: false
|
recursive:
|
||||||
session.policy.validation.forLocal.toRemote.enabled: false
|
enabled: false
|
||||||
session.policy.validation.forRemote.toRemote.enabled: false
|
invite:
|
||||||
|
resolution:
|
||||||
|
recursive: false
|
||||||
|
session:
|
||||||
|
policy:
|
||||||
|
validation:
|
||||||
|
forLocal:
|
||||||
|
toRemote:
|
||||||
|
enabled: false
|
||||||
|
forRemote:
|
||||||
|
toRemote:
|
||||||
|
enabled: false
|
||||||
```
|
```
|
||||||
|
|
||||||
There is currently no way to selectively disable federation towards specific servers, but this feature is planned.
|
There is currently no way to selectively disable federation towards specific servers, but this feature is planned.
|
||||||
|
@@ -3,6 +3,17 @@
|
|||||||
|
|
||||||
Implementation of the [Unofficial Matrix Identity Service API](https://kamax.io/matrix/api/identity_service/unstable.html).
|
Implementation of the [Unofficial Matrix Identity Service API](https://kamax.io/matrix/api/identity_service/unstable.html).
|
||||||
|
|
||||||
|
## 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'
|
||||||
|
```
|
||||||
|
**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
|
## Room Invitations
|
||||||
Resolution can be customized using the following configuration:
|
Resolution can be customized using the following configuration:
|
||||||
|
|
||||||
|
@@ -1,9 +1,10 @@
|
|||||||
# Profile enhancement
|
# Profile
|
||||||
**WARNING**: Alpha feature not officially supported. Do not use.
|
The profile feature does not do anything on its own and acts as a support feature for others, allowing to retrieve
|
||||||
|
information about a user based on its Matrix ID by querying enabled [Identity stores](../stores/README.md).
|
||||||
|
|
||||||
## Configuration
|
Currently supported:
|
||||||
### Reverse proxy
|
- Display name
|
||||||
#### Apache
|
- 3PIDs
|
||||||
```apache
|
- Roles/Groups
|
||||||
ProxyPassMatch "^/_matrix/client/r0/profile/([^/]+)$" "http://127.0.0.1:8090/_matrix/client/r0/profile/$1"
|
|
||||||
```
|
Experimental sub-features are also available. See [the dedicated document](experimental/profile.md).
|
||||||
|
@@ -12,7 +12,7 @@ This will be a good ground work for further integration with features and your e
|
|||||||
|
|
||||||
## Preparation
|
## Preparation
|
||||||
You will need:
|
You will need:
|
||||||
- Homeserver
|
- Working Homeserver, ideally with working federation
|
||||||
- Reverse proxy with regular TLS/SSL certificate (Let's encrypt) for your mxisd domain
|
- 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
|
As synapse requires an HTTPS connection when talking to an Identity service, **a reverse proxy is required** as mxisd does
|
||||||
@@ -20,7 +20,7 @@ not support HTTPS listener at this time.
|
|||||||
|
|
||||||
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 hostname.
|
||||||
|
|
||||||
Be aware of a [NAT/Reverse proxy gotcha](https://github.com/kamax-io/mxisd/wiki/Gotchas#nating) if you use the same
|
Be aware of a [NAT/Reverse proxy gotcha](https://github.com/kamax-matrix/mxisd/wiki/Gotchas#nating) if you use the same
|
||||||
hostname.
|
hostname.
|
||||||
|
|
||||||
The following Quick Start guide assumes you will host the Homeserver and mxisd under the same hostname.
|
The following Quick Start guide assumes you will host the Homeserver and mxisd under the same hostname.
|
||||||
@@ -29,20 +29,29 @@ If you would like a high-level view of the infrastructure and how each feature i
|
|||||||
|
|
||||||
## Install
|
## Install
|
||||||
Install via:
|
Install via:
|
||||||
- [Debian package](install/debian.md)
|
|
||||||
- [Docker image](install/docker.md)
|
- [Docker image](install/docker.md)
|
||||||
|
- [Debian package](install/debian.md)
|
||||||
|
- [ArchLinux](install/archlinux.md)
|
||||||
|
- [NixOS](install/nixos.md)
|
||||||
- [Sources](build.md)
|
- [Sources](build.md)
|
||||||
|
|
||||||
See the [Latest release](https://github.com/kamax-io/mxisd/releases/latest) for links to each.
|
See the [Latest release](https://github.com/kamax-matrix/mxisd/releases/latest) for links to each.
|
||||||
|
|
||||||
## Configure
|
## 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.
|
||||||
|
|
||||||
|
> **NOTE**: Details about configuration syntax and format are described [here](configure.md)
|
||||||
|
|
||||||
Create/edit a minimal configuration (see installer doc for the location):
|
Create/edit a minimal configuration (see installer doc for the location):
|
||||||
```yaml
|
```yaml
|
||||||
matrix.domain: 'example.org'
|
matrix:
|
||||||
key.path: '/path/to/signing.key.file'
|
domain: 'example.org'
|
||||||
storage.provider.sqlite.database: '/path/to/mxisd.db'
|
key:
|
||||||
|
path: '/path/to/signing.key.file'
|
||||||
|
storage:
|
||||||
|
provider:
|
||||||
|
sqlite:
|
||||||
|
database: '/path/to/mxisd.db'
|
||||||
```
|
```
|
||||||
- `matrix.domain` should be set to your Homeserver domain (`server_name` in synapse configuration)
|
- `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.
|
- `key.path` will store the signing keys, which must be kept safe! If the file does not exist, keys will be generated for you.
|
||||||
@@ -118,10 +127,15 @@ It is recommended to remove `matrix.org` and `vector.im` (or any other default e
|
|||||||
your own Identity server is authoritative for your HS.
|
your own Identity server is authoritative for your HS.
|
||||||
|
|
||||||
## Validate
|
## Validate
|
||||||
Log in using your Matrix client and set `https://example.org` as your Identity server URL, replacing `example.org` by
|
**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.
|
the relevant hostname which you configured in your reverse proxy.
|
||||||
Invite `mxisd-federation-test@kamax.io` to a room, which should be turned into a Matrix invite to `@mxisd-lookup-test:kamax.io`.
|
2. Create a new empty room. All further actions will take place in this room.
|
||||||
At this point, the test user will join the room, send a congratulation message and leave.
|
3. Invite `mxisd-federation-test@kamax.io`
|
||||||
|
4. The 3PID invite should be turned into a Matrix invite to `@mxisd-lookup-test:kamax.io`.
|
||||||
|
5. The invited test user will join the room, send a congratulation message and leave.
|
||||||
**NOTE:** You might not see a suggestion for the e-mail address, which is normal. Still proceed with the invite.
|
**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 worked, it means you are up and running and can enjoy mxisd in its basic mode! Congratulations!
|
||||||
|
@@ -1,6 +1,9 @@
|
|||||||
# Debian package
|
# Debian package
|
||||||
|
## Requirements
|
||||||
|
- Any distribution that supports Java 8
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
1. Download the [latest release](https://github.com/kamax-io/mxisd/releases/latest)
|
1. Download the [latest release](https://github.com/kamax-matrix/mxisd/releases/latest)
|
||||||
2. Run:
|
2. Run:
|
||||||
```bash
|
```bash
|
||||||
dpkg -i /path/to/downloaded/mxisd.deb
|
dpkg -i /path/to/downloaded/mxisd.deb
|
||||||
|
8
docs/install/nixos.md
Normal file
8
docs/install/nixos.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# NixOS package
|
||||||
|
mxisd is available as a NixOS package in the official repos.
|
||||||
|
|
||||||
|
It is maintained by [maximilian](https://matrix.to/#/@maximilian:transformierende-gesellschaft.org), a community member.
|
||||||
|
|
||||||
|
Related resources:
|
||||||
|
- [NixOS](https://nixos.org/)
|
||||||
|
- [The module definition](https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/services/networking/mxisd.nix)
|
@@ -2,37 +2,43 @@
|
|||||||
## Instructions
|
## Instructions
|
||||||
Follow the [build instructions](../build.md) then:
|
Follow the [build instructions](../build.md) then:
|
||||||
|
|
||||||
1. Prepare files and directories:
|
### Prepare files and directories:
|
||||||
```bash
|
```bash
|
||||||
# Create a dedicated user
|
# Create a dedicated user
|
||||||
useradd -r mxisd
|
useradd -r mxisd
|
||||||
|
|
||||||
# Create bin directory
|
|
||||||
mkdir /opt/mxisd
|
|
||||||
|
|
||||||
# Create config directory and set ownership
|
# Create config directory and set ownership
|
||||||
mkdir -p /etc/opt/mxisd
|
mkdir -p /etc/mxisd
|
||||||
chown -R mxisd /etc/opt/mxisd
|
|
||||||
|
|
||||||
# Create data directory and set ownership
|
# Create data directory and set ownership
|
||||||
mkdir -p /var/opt/mxisd
|
mkdir -p /var/lib/mxisd
|
||||||
chown -R mxisd /var/opt/mxisd
|
chown -R mxisd /var/lib/mxisd
|
||||||
|
|
||||||
# Copy <repo root>/build/libs/mxisd.jar to bin directory
|
# Create bin directory, copy the jar and launch scriot to bin directory
|
||||||
cp ./build/libs/mxisd.jar /opt/mxisd/
|
mkdir /usr/lib/mxisd
|
||||||
chown mxisd /opt/mxisd/mxisd.jar
|
cp ./build/libs/mxisd.jar /usr/lib/mxisd/
|
||||||
chmod a+x /opt/mxisd/mxisd.jar
|
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
|
# 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
|
### Prepare config file
|
||||||
4. Enable service for auto-startup
|
Copy the sample config file `./mxisd.example.yaml` to `/etc/mxisd/mxisd.yaml`, edit to your needs
|
||||||
|
|
||||||
|
### Prepare Systemd
|
||||||
|
1. Copy `src/systemd/mxisd.service` to `/etc/systemd/system/` and edit if needed
|
||||||
|
2. Enable service for auto-startup
|
||||||
```bash
|
```bash
|
||||||
systemctl enable mxisd
|
systemctl enable mxisd
|
||||||
```
|
```
|
||||||
5. Start mxisd
|
|
||||||
|
### Run
|
||||||
```bash
|
```bash
|
||||||
systemctl start mxisd
|
systemctl start mxisd
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Debug
|
||||||
|
mxisd logs to stdout, which is normally sent to `/var/log/syslog` or `/var/log/messages`.
|
||||||
|
@@ -1,7 +1,8 @@
|
|||||||
# Identity Stores
|
# Identity Stores
|
||||||
- [Synapse](synapse.md)
|
- [Synapse](synapse.md) - Turn your SynapseDB into a self-contained Identity store
|
||||||
- [LDAP-based](ldap.md)
|
- [LDAP-based](ldap.md) - Any LDAP-based product like Active Directory, Samba, NetIQ, OpenLDAP
|
||||||
- [SQL Databases](sql.md)
|
- [SQL Databases](sql.md) - Most common databases like MariaDB, MySQL, PostgreSQL, SQLite
|
||||||
- [Website / Web service / Web app](rest.md)
|
- [Website / Web service / Web app](rest.md) - Arbitrary REST endpoints
|
||||||
- [Google Firebase](firebase.md)
|
- [Executables](exec.md) - Run arbitrary executables with configurable stdin, arguments, environment and stdout
|
||||||
- [Wordpress](wordpress.md)
|
- [Wordpress](wordpress.md) - Connect your Wordpress-powered website DB
|
||||||
|
- [Google Firebase](firebase.md) - Use your Firebase users (with experimental SSO support!)
|
||||||
|
498
docs/stores/exec.md
Normal file
498
docs/stores/exec.md
Normal file
@@ -0,0 +1,498 @@
|
|||||||
|
# Exec Identity Store
|
||||||
|
- [Features](#features)
|
||||||
|
- [Overview](#overview)
|
||||||
|
- [Configuration](#configuration)
|
||||||
|
- [Global](#global)
|
||||||
|
- [Tokens](#tokens)
|
||||||
|
- [Executable](#executable)
|
||||||
|
- [Input](#input)
|
||||||
|
- [Output](#output)
|
||||||
|
- [Examples](#examples)
|
||||||
|
- [Per-Feature](#per-feature)
|
||||||
|
- [Authentication](#authentication)
|
||||||
|
- [Tokens](#tokens-1)
|
||||||
|
- [Input](#input-1)
|
||||||
|
- [Output](#output-1)
|
||||||
|
- [Directory](#directory)
|
||||||
|
- [Tokens](#tokens-2)
|
||||||
|
- [Input](#input-2)
|
||||||
|
- [Output](#output-2)
|
||||||
|
- [Identity](#identity)
|
||||||
|
- [Single Lookup](#single-lookup)
|
||||||
|
- [Tokens](#tokens-3)
|
||||||
|
- [Input](#input-3)
|
||||||
|
- [Output](#output-3)
|
||||||
|
- [Bulk Lookup](#bulk-lookup)
|
||||||
|
- [Tokens](#tokens-4)
|
||||||
|
- [Input](#input-4)
|
||||||
|
- [Output](#output-4)
|
||||||
|
- [Profile](#profile)
|
||||||
|
- [Tokens](#tokens-5)
|
||||||
|
- [Input](#input-5)
|
||||||
|
- [Output](#output-5)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Features
|
||||||
|
| Name | Supported |
|
||||||
|
|-------------------------------------------------|-----------|
|
||||||
|
| [Authentication](../features/authentication.md) | Yes |
|
||||||
|
| [Directory](../features/directory.md) | Yes |
|
||||||
|
| [Identity](../features/identity.md) | Yes |
|
||||||
|
| [Profile](#profile) | 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.
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
Each request can be mapping to a fully customizable command configuration.
|
||||||
|
The various parameters can be provided via any combination of:
|
||||||
|
- [Standard Input](https://en.wikipedia.org/wiki/Standard_streams#Standard_input_(stdin))
|
||||||
|
- [Command-line arguments](https://en.wikipedia.org/wiki/Command-line_interface#Arguments)
|
||||||
|
- [Environment variables](https://en.wikipedia.org/wiki/Environment_variable)
|
||||||
|
|
||||||
|
Each of those supports a set of customizable token which will be replaced prior to running the command, allowing to
|
||||||
|
provide the input values in any number of ways.
|
||||||
|
|
||||||
|
Success and data will be provided via any combination of:
|
||||||
|
- [Exit status](https://en.wikipedia.org/wiki/Exit_status)
|
||||||
|
- [Standard Output](https://en.wikipedia.org/wiki/Standard_streams#Standard_output_(stdout))
|
||||||
|
|
||||||
|
Each of those supports a set of configuration item to decide how to process the value and/or in which format.
|
||||||
|
|
||||||
|
All values, inputs and outputs are UTF-8 encoded.
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
Each feature comes with a set of possible lookup/action which is mapped to a generic configuration item block.
|
||||||
|
We will use the term `Executable` for each lookup/action and `Processor` for each configuration block.
|
||||||
|
|
||||||
|
### Global
|
||||||
|
```yaml
|
||||||
|
exec:
|
||||||
|
enabled: <boolean>
|
||||||
|
```
|
||||||
|
Enable/disable the Identity store at a global/default level. Each feature can still be individually enabled/disabled.
|
||||||
|
|
||||||
|
#### Tokens
|
||||||
|
The following options allow to globally set tokens for value replacement across all features and processors config.
|
||||||
|
Not all features use all tokens, and each feature might also have its own specific tokens. See each feature documentation.
|
||||||
|
|
||||||
|
They can be set within the following scope:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
exec:
|
||||||
|
token:
|
||||||
|
<token>: '<value>'
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
The following tokens and default values are available:
|
||||||
|
```yaml
|
||||||
|
localpart: '{localpart}'
|
||||||
|
```
|
||||||
|
Localpart of Matrix User IDs
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
domain: '{domain}'
|
||||||
|
```
|
||||||
|
Domain of Matrix User IDs
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
mxid: '{mxid}'
|
||||||
|
```
|
||||||
|
Full representation of Matrix User IDs
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
medium: '{medium}'
|
||||||
|
```
|
||||||
|
Medium of 3PIDs
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
address: '{address}'
|
||||||
|
```
|
||||||
|
Address of 3PIDs
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
type: '{type}'
|
||||||
|
```
|
||||||
|
Type of query
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
query: '{query}'
|
||||||
|
```
|
||||||
|
Query value
|
||||||
|
|
||||||
|
### Executable
|
||||||
|
*Executable*s have the following options:
|
||||||
|
```yaml
|
||||||
|
command: '/path/to/executableOrScript'
|
||||||
|
|
||||||
|
```
|
||||||
|
Set the executable (relative or absolute) path to be executed. If no command is given, the action will return a "neutral"
|
||||||
|
result if possible or be skipped altogether.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Command line arguments can be given via a list via both YAML formats:
|
||||||
|
```yaml
|
||||||
|
args:
|
||||||
|
- '-t'
|
||||||
|
- '{token}'
|
||||||
|
- '-v'
|
||||||
|
- 'value'
|
||||||
|
```
|
||||||
|
or
|
||||||
|
```yaml
|
||||||
|
args: ['-t', '{token}', '-v', 'value]
|
||||||
|
```
|
||||||
|
Each argument will be processed for token replacement.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Environment variables can be given as key/value pairs:
|
||||||
|
```yaml
|
||||||
|
env:
|
||||||
|
ENV_VAR_1: 'value'
|
||||||
|
ENV_VAR_2: '{token}'
|
||||||
|
```
|
||||||
|
Each variable value will be processed for token replacement.
|
||||||
|
|
||||||
|
#### Input
|
||||||
|
Standard input can be configured in the namespaces `input` with:
|
||||||
|
- `type`: The format to use
|
||||||
|
- `template`: The full or partial template with tokens to be used when generating the input
|
||||||
|
|
||||||
|
Not all features and *Executable*s allow for a template to be provided.
|
||||||
|
Templates for listed-based input are not supported at this time.
|
||||||
|
Default templates may be provided per *Executable*.
|
||||||
|
|
||||||
|
The following types are available:
|
||||||
|
- `json`: Use JSON format, shared with the [REST Identity Store](rest.md)
|
||||||
|
- `plain`: Use a custom multi-lines, optionally tab-separated input
|
||||||
|
|
||||||
|
#### Output
|
||||||
|
Standard output can be configured in the namespaces `output` with:
|
||||||
|
- `type`: The format to use
|
||||||
|
- `template`: The full or partial template with tokens to be used when processing the output
|
||||||
|
|
||||||
|
Not all features and *Executable*s allow for a template to be provided.
|
||||||
|
Templates for listed-based output are not supported at this time.
|
||||||
|
Default templates may be provided per *Executable*.
|
||||||
|
|
||||||
|
The following types are available:
|
||||||
|
- `json`: Use JSON format, shared with the [REST Identity Store](rest.md)
|
||||||
|
- `plain`: Use a custom multi-lines, optionally tab-separated output
|
||||||
|
|
||||||
|
### Examples
|
||||||
|
#### Basic
|
||||||
|
```yaml
|
||||||
|
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 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
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
#### 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]
|
||||||
|
```
|
||||||
|
With:
|
||||||
|
- The Identity store enabled for all features
|
||||||
|
- A global specific token `{matrixId}` for Matrix User IDs, replacing the default `{mxid}`
|
||||||
|
|
||||||
|
Running `/path/to/executable` providing:
|
||||||
|
- A custom token for localpart, `{username}`, used as a 2nd command-line argument
|
||||||
|
- An extracted Matrix User ID `localpart` provided as the second command line argument, the first one being `-u`
|
||||||
|
- A password, the extracted Matrix `domain` and the full User ID as arbitrary environment variables, respectively
|
||||||
|
`PASSWORD`, `MATRIX_DOMAIN` and `MATRIX_USER_ID`
|
||||||
|
|
||||||
|
After execution:
|
||||||
|
- Process stdout as [JSON](https://en.wikipedia.org/wiki/JSON)
|
||||||
|
- Consider exit status `0` and `128` as success and try to process the stdout for data
|
||||||
|
- Consider exit status `1` and `129` as failure and try to process the stdout for error code and message
|
||||||
|
|
||||||
|
### Per Feature
|
||||||
|
See each dedicated [Feature](#features) section.
|
||||||
|
|
||||||
|
## Authentication
|
||||||
|
The Authentication feature can be enabled/disabled using:
|
||||||
|
```yaml
|
||||||
|
exec:
|
||||||
|
auth:
|
||||||
|
enabled: <true/false>
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
This feature provides a single *Executable* under the namespace:
|
||||||
|
```yaml
|
||||||
|
exec:
|
||||||
|
auth:
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
### Tokens
|
||||||
|
The following tokens/default values are specific to this feature:
|
||||||
|
```yaml
|
||||||
|
password: '{password}'
|
||||||
|
```
|
||||||
|
The provided password
|
||||||
|
|
||||||
|
### Input
|
||||||
|
Supported input types and default templates:
|
||||||
|
|
||||||
|
#### JSON (`json`)
|
||||||
|
Same as the [REST Identity Store](rest.md);
|
||||||
|
|
||||||
|
#### Plain (`plain`)
|
||||||
|
Default template:
|
||||||
|
```
|
||||||
|
{localpart}
|
||||||
|
{domain}
|
||||||
|
{mxid}
|
||||||
|
{password}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Output
|
||||||
|
Supported output types and default templates:
|
||||||
|
|
||||||
|
#### JSON (`json`)
|
||||||
|
Same as the [REST Identity Store](rest.md);
|
||||||
|
|
||||||
|
#### Plain (`plain`)
|
||||||
|
**NOTE:** This has limited support. Use the JSON type for full support.
|
||||||
|
|
||||||
|
Default template:
|
||||||
|
```
|
||||||
|
[success status, true or 1 are interpreted as success]
|
||||||
|
[display name of the user]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Directory
|
||||||
|
The Directory feature can be enabled/disabled using:
|
||||||
|
```yaml
|
||||||
|
exec:
|
||||||
|
directory:
|
||||||
|
enabled: <true/false>
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Two search types configuration namespace are available, using the same input/output formats and templates:
|
||||||
|
|
||||||
|
By name:
|
||||||
|
```yaml
|
||||||
|
exec:
|
||||||
|
directory:
|
||||||
|
search:
|
||||||
|
byName:
|
||||||
|
...
|
||||||
|
```
|
||||||
|
By 3PID:
|
||||||
|
```yaml
|
||||||
|
exec:
|
||||||
|
directory:
|
||||||
|
search:
|
||||||
|
byThreepid:
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Tokens
|
||||||
|
No specific tokens are available.
|
||||||
|
|
||||||
|
#### Input
|
||||||
|
Supported input types and default templates:
|
||||||
|
|
||||||
|
##### JSON (`json`)
|
||||||
|
Same as the [REST Identity Store](rest.md);
|
||||||
|
|
||||||
|
##### Plain (`plain`)
|
||||||
|
Default template:
|
||||||
|
```
|
||||||
|
[type of search, following the REST Identity store format]
|
||||||
|
[query string]
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Output
|
||||||
|
Supported output types and default templates:
|
||||||
|
|
||||||
|
##### JSON (`json`)
|
||||||
|
Same as the [REST Identity Store](rest.md);
|
||||||
|
|
||||||
|
##### Plain (`plain`)
|
||||||
|
**Not supported at this time.** Use the JSON type.
|
||||||
|
|
||||||
|
## Identity
|
||||||
|
The Identity feature can be enabled/disabled using:
|
||||||
|
```yaml
|
||||||
|
exec.identity.enabled: <true/false>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Single lookup
|
||||||
|
Configuration namespace:
|
||||||
|
```yaml
|
||||||
|
exec.identity.lookup.single:
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Tokens
|
||||||
|
No specific tokens are available.
|
||||||
|
|
||||||
|
#### Input
|
||||||
|
Supported input types and default templates:
|
||||||
|
|
||||||
|
##### JSON (`json`)
|
||||||
|
Same as the [REST Identity Store](rest.md);
|
||||||
|
|
||||||
|
##### Plain (`plain`)
|
||||||
|
Default template:
|
||||||
|
```
|
||||||
|
{medium}
|
||||||
|
{address}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Output
|
||||||
|
Supported output types and default templates:
|
||||||
|
|
||||||
|
##### JSON (`json`)
|
||||||
|
Same as the [REST Identity Store](rest.md);
|
||||||
|
|
||||||
|
##### Plain (`plain`)
|
||||||
|
Default template:
|
||||||
|
```
|
||||||
|
[User ID type, as documented in the REST Identity Store]
|
||||||
|
[User ID value]
|
||||||
|
```
|
||||||
|
|
||||||
|
The User ID type will default to `localpart` if:
|
||||||
|
- Only one line is returned
|
||||||
|
- The first line is empty
|
||||||
|
|
||||||
|
### Bulk lookup
|
||||||
|
Configuration namespace:
|
||||||
|
```yaml
|
||||||
|
exec:
|
||||||
|
identity:
|
||||||
|
lookup:
|
||||||
|
bulk:
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Tokens
|
||||||
|
No specific tokens are available.
|
||||||
|
|
||||||
|
#### Input
|
||||||
|
Supported input types and default templates:
|
||||||
|
|
||||||
|
##### JSON (`json`)
|
||||||
|
**NOTE:** Custom Templates are not supported.
|
||||||
|
|
||||||
|
Same as the [REST Identity Store](rest.md).
|
||||||
|
|
||||||
|
##### Plain (`plain`)
|
||||||
|
**Not supported at this time.** Use the JSON type.
|
||||||
|
|
||||||
|
#### Output
|
||||||
|
Supported output types and default templates:
|
||||||
|
|
||||||
|
##### JSON (`json`)
|
||||||
|
**NOTE:** Custom Templates are not supported.
|
||||||
|
|
||||||
|
Same as the [REST Identity Store](rest.md).
|
||||||
|
|
||||||
|
##### Plain (`plain`)
|
||||||
|
**Not supported at this time.** Use the JSON type.
|
||||||
|
|
||||||
|
## Profile
|
||||||
|
The Profile feature can be enabled/disabled using:
|
||||||
|
```yaml
|
||||||
|
exec:
|
||||||
|
profile:
|
||||||
|
enabled: <true/false>
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
The following *Executable*s namespace are available, share the same input/output formats and templates:
|
||||||
|
|
||||||
|
Get Display name:
|
||||||
|
```yaml
|
||||||
|
exec:
|
||||||
|
profile:
|
||||||
|
displayName:
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
Get 3PIDs:
|
||||||
|
```yaml
|
||||||
|
exec:
|
||||||
|
profile:
|
||||||
|
threePid:
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
Get Roles:
|
||||||
|
```yaml
|
||||||
|
exec:
|
||||||
|
profile:
|
||||||
|
role:
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### Tokens
|
||||||
|
No specific tokens are available.
|
||||||
|
|
||||||
|
### Input
|
||||||
|
Supported input types and default templates:
|
||||||
|
|
||||||
|
#### JSON (`json`)
|
||||||
|
Same as the [REST Identity Store](rest.md);
|
||||||
|
|
||||||
|
#### Plain (`plain`)
|
||||||
|
Default template:
|
||||||
|
```
|
||||||
|
{localpart}
|
||||||
|
{domain}
|
||||||
|
{mxid}
|
||||||
|
```
|
||||||
|
### Output
|
||||||
|
Supported output types and default templates:
|
||||||
|
|
||||||
|
#### JSON (`json`)
|
||||||
|
Same as the [REST Identity Store](rest.md);
|
||||||
|
|
||||||
|
#### Plain (`plain`)
|
||||||
|
**Not supported at this time.** Use the JSON type.
|
@@ -7,6 +7,7 @@ https://firebase.google.com/
|
|||||||
| Authentication | Yes |
|
| Authentication | Yes |
|
||||||
| Directory | No |
|
| Directory | No |
|
||||||
| Identity | Yes |
|
| Identity | Yes |
|
||||||
|
| Profile | No |
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
This backend requires a suitable Matrix client capable of performing Firebase authentication and passing the following
|
This backend requires a suitable Matrix client capable of performing Firebase authentication and passing the following
|
||||||
@@ -18,35 +19,41 @@ If your client is Riot, you will need a custom version.
|
|||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
```yaml
|
```yaml
|
||||||
firebase.enabled: <boolean>
|
firebase:
|
||||||
|
enabled: <boolean>
|
||||||
```
|
```
|
||||||
Enable/disable this identity store.
|
Enable/disable this identity store.
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
```yaml
|
```yaml
|
||||||
firebase.enabled: <boolean>
|
firebase:
|
||||||
|
enabled: <boolean>
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
firebase.credentials: <string>
|
firebase:
|
||||||
|
credentials: <string>
|
||||||
```
|
```
|
||||||
Path to the credentials file provided by Google Firebase to use with an external app.
|
Path to the credentials file provided by Google Firebase to use with an external app.
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
```yaml
|
```yaml
|
||||||
firebase.credentials: '/path/to/firebase/credentials.json'
|
firebase:
|
||||||
|
credentials: '/path/to/firebase/credentials.json'
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
firebase.database: <string>
|
firebase:
|
||||||
|
database: <string>
|
||||||
```
|
```
|
||||||
URL to your Firebase database.
|
URL to your Firebase database.
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
```yaml
|
```yaml
|
||||||
firebase.database: 'https://my-project.firebaseio.com/'
|
firebase:
|
||||||
|
database: 'https://my-project.firebaseio.com/'
|
||||||
```
|
```
|
||||||
|
@@ -13,31 +13,40 @@ For NetIQ, replace all the `ldap` prefix in the configuration by `netiq`.
|
|||||||
| Authentication | Yes |
|
| Authentication | Yes |
|
||||||
| Directory | Yes |
|
| Directory | Yes |
|
||||||
| Identity | Yes |
|
| Identity | Yes |
|
||||||
|
| Profile | Yes |
|
||||||
|
|
||||||
## Getting started
|
## Getting started
|
||||||
### Base
|
### Base
|
||||||
To use your LDAP backend, add the bare minimum configuration in mxisd config file:
|
To use your LDAP backend, add the bare minimum configuration in mxisd config file:
|
||||||
```yaml
|
```yaml
|
||||||
ldap.enabled: true
|
ldap:
|
||||||
ldap.connection.host: 'ldapHostnameOrIp'
|
enabled: true
|
||||||
ldap.connection.port: 389
|
connection:
|
||||||
ldap.connection.bindDn: 'CN=My Mxisd User,OU=Users,DC=example,DC=org'
|
host: 'ldapHostnameOrIp'
|
||||||
ldap.connection.bindPassword: 'TheUserPassword'
|
port: 389
|
||||||
ldap.connection.baseDn: 'OU=Users,DC=example,DC=org'
|
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.
|
These are standard LDAP connection configuration. mxisd will try to connect on port default port 389 without encryption.
|
||||||
|
|
||||||
|
If you would like to use several Base DNs, simply add more entries under `baseDNs`.
|
||||||
|
|
||||||
### TLS/SSL connection
|
### TLS/SSL connection
|
||||||
If you would like to use a TLS/SSL connection, use the following configuration options (STARTLS not supported):
|
If you would like to use a TLS/SSL connection, use the following configuration options (STARTLS not supported):
|
||||||
```yaml
|
```yaml
|
||||||
ldap.connection.tls: true
|
ldap:
|
||||||
ldap.connection.port: 12345
|
connection:
|
||||||
|
tls: true
|
||||||
|
port: 12345
|
||||||
```
|
```
|
||||||
|
|
||||||
### Filter results
|
### Filter results
|
||||||
You can also set a default global filter on any LDAP queries:
|
You can also set a default global filter on any LDAP queries:
|
||||||
```yaml
|
```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 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.
|
This can be overwritten or append in each specific flow describe below.
|
||||||
@@ -60,8 +69,11 @@ most certainly configure those mappings.
|
|||||||
|
|
||||||
The following example would set the `sAMAccountName` attribute as a Matrix User ID localpart:
|
The following example would set the `sAMAccountName` attribute as a Matrix User ID localpart:
|
||||||
```yaml
|
```yaml
|
||||||
ldap.attribute.uid.type: 'uid'
|
ldap:
|
||||||
ldap.attribute.uid.value: 'sAMAccountName'
|
attribute:
|
||||||
|
uid:
|
||||||
|
type: 'uid'
|
||||||
|
value: 'sAMAccountName'
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Display name
|
#### Display name
|
||||||
@@ -69,7 +81,9 @@ Use `ldap.attribute.name`.
|
|||||||
|
|
||||||
The following example would set the display name to the value of the `cn` attribute:
|
The following example would set the display name to the value of the `cn` attribute:
|
||||||
```yaml
|
```yaml
|
||||||
ldap.attribute.name: 'cn'
|
ldap:
|
||||||
|
attribute:
|
||||||
|
name: 'cn'
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 3PIDs
|
#### 3PIDs
|
||||||
@@ -78,11 +92,13 @@ 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)
|
The following example would overwrite the [default list of attributes](../../src/main/resources/application.yaml#L67)
|
||||||
for emails and phone number:
|
for emails and phone number:
|
||||||
```yaml
|
```yaml
|
||||||
ldap.attribute.threepid.email:
|
ldap:
|
||||||
|
attribute:
|
||||||
|
threepid:
|
||||||
|
email:
|
||||||
- 'mail'
|
- 'mail'
|
||||||
- 'otherMailAttribute'
|
- 'otherMailAttribute'
|
||||||
|
msisdn:
|
||||||
ldap.attribute.threepid.msisdn:
|
|
||||||
- 'phone'
|
- 'phone'
|
||||||
- 'otherPhoneAttribute'
|
- 'otherPhoneAttribute'
|
||||||
```
|
```
|
||||||
@@ -113,7 +129,10 @@ To set a specific filter applied during directory search, use `ldap.directory.fi
|
|||||||
|
|
||||||
If you would like to use extra attributes in search that are not 3PIDs, like nicknames, group names, employee number:
|
If you would like to use extra attributes in search that are not 3PIDs, like nicknames, group names, employee number:
|
||||||
```yaml
|
```yaml
|
||||||
ldap.directory.attribute.other:
|
ldap:
|
||||||
|
directory:
|
||||||
|
attribute:
|
||||||
|
other:
|
||||||
- 'myNicknameAttribute'
|
- 'myNicknameAttribute'
|
||||||
- 'memberOf'
|
- 'memberOf'
|
||||||
- 'employeeNumberAttribute'
|
- 'employeeNumberAttribute'
|
||||||
|
@@ -3,37 +3,45 @@ The REST backend allows you to query identity data in existing webapps, like:
|
|||||||
- Forums (phpBB, Discourse, etc.)
|
- Forums (phpBB, Discourse, etc.)
|
||||||
- Custom Identity stores (Keycloak, ...)
|
- Custom Identity stores (Keycloak, ...)
|
||||||
- CRMs (Wordpress, ...)
|
- CRMs (Wordpress, ...)
|
||||||
- self-hosted clouds (Nextcloud, ownCloud, ...)
|
- Self-hosted clouds (Nextcloud, ownCloud, ...)
|
||||||
|
|
||||||
To integrate this backend with your webapp, you will need to implement three specific REST endpoints detailed below.
|
To integrate this backend with your webapp, you will need to implement the REST endpoints described below.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
| Name | Supported? |
|
| Name | Supported? |
|
||||||
|----------------|------------|
|
|-------------------------------------------------|------------|
|
||||||
| Authentication | Yes |
|
| [Authentication](../features/authentication.md) | Yes |
|
||||||
| Directory | Yes |
|
| [Directory](../features/directory.md) | Yes |
|
||||||
| Identity | Yes |
|
| [Identity](../features/identity.md) | Yes |
|
||||||
|
| [Profile](../features/profile.md) | Yes |
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
| Key | Default | Description |
|
| Key | Default | Description |
|
||||||
|----------------------------------|------------------------------------------------|------------------------------------------------------|
|
|--------------------------------------|------------------------------------------------|------------------------------------------------------|
|
||||||
| `rest.enabled` | `false` | Globally enable/disable the REST backend |
|
| `rest.enabled` | `false` | Globally enable/disable the REST backend |
|
||||||
| `rest.host` | *None* | Default base URL to use for the different endpoints. |
|
| `rest.host` | *None* | Default base URL to use for the different endpoints. |
|
||||||
| `rest.endpoints.auth` | `/_mxisd/backend/api/v1/auth/login` | Validate credentials and get user profile |
|
| `rest.endpoints.auth` | `/_mxisd/backend/api/v1/auth/login` | Validate credentials and get user profile |
|
||||||
| `rest.endpoints.directory` | `/_mxisd/backend/api/v1/directory/user/search` | Search for users by arbitrary input |
|
| `rest.endpoints.directory` | `/_mxisd/backend/api/v1/directory/user/search` | Search for users by arbitrary input |
|
||||||
| `rest.endpoints.identity.single` | `/_mxisd/backend/api/v1/identity/single` | Endpoint to query a single 3PID |
|
| `rest.endpoints.identity.single` | `/_mxisd/backend/api/v1/identity/single` | Endpoint to query a single 3PID |
|
||||||
| `rest.endpoints.identity.bulk` | `/_mxisd/backend/api/v1/identity/bulk` | Endpoint to query a list of 3PID |
|
| `rest.endpoints.identity.bulk` | `/_mxisd/backend/api/v1/identity/bulk` | Endpoint to query a list of 3PID |
|
||||||
|
| `rest.endpoints.profile.displayName` | `/_mxisd/backend/api/v1/profile/displayName` | Query the display name for a Matrix ID
|
||||||
|
| `rest.endpoints.profile.threepids` | `/_mxisd/backend/api/v1/profile/threepids` | Query the 3PIDs for a Matrix ID
|
||||||
|
| `rest.endpoints.profile.roles` | `/_mxisd/backend/api/v1/profile/roles` | Query the Roles for a Matrix ID
|
||||||
|
|
||||||
Endpoint values can handle two formats:
|
Endpoint values can handle two formats:
|
||||||
- URL Path starting with `/` that gets happened to the `rest.host`
|
- URL Path starting with `/` that gets happened to the `rest.host`
|
||||||
- Full URL, if you want each endpoint to go to a specific server/protocol/port
|
- Full URL, if you want each endpoint to go to a specific server/protocol/port
|
||||||
|
|
||||||
|
If an endpoint value is configured as an empty string, it will disable that specific feature, essentially bypassing the
|
||||||
|
Identity store for that specific query.
|
||||||
|
|
||||||
`rest.host` is mandatory if at least one endpoint is not a full URL.
|
`rest.host` is mandatory if at least one endpoint is not a full URL.
|
||||||
|
|
||||||
## Endpoints
|
## Endpoints
|
||||||
### Authentication
|
### Authentication
|
||||||
HTTP method: `POST`
|
- Method: `POST`
|
||||||
Content-type: JSON UTF-8
|
- Content-Type: `application/json` (JSON)
|
||||||
|
- Encoding: `UTF8`
|
||||||
|
|
||||||
#### Request Body
|
#### Request Body
|
||||||
```json
|
```json
|
||||||
@@ -86,8 +94,9 @@ If the authentication succeed:
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Directory
|
### Directory
|
||||||
HTTP method: `POST`
|
- Method: `POST`
|
||||||
Content-type: JSON UTF-8
|
- Content-Type: `application/json` (JSON)
|
||||||
|
- Encoding: `UTF8`
|
||||||
|
|
||||||
#### Request Body
|
#### Request Body
|
||||||
```json
|
```json
|
||||||
@@ -112,7 +121,7 @@ If users found:
|
|||||||
"user_id": "UserIdLocalpart"
|
"user_id": "UserIdLocalpart"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
...
|
"...": "..."
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
@@ -128,10 +137,11 @@ If no user found:
|
|||||||
|
|
||||||
### Identity
|
### Identity
|
||||||
#### Single 3PID lookup
|
#### Single 3PID lookup
|
||||||
HTTP method: `POST`
|
- Method: `POST`
|
||||||
Content-type: JSON UTF-8
|
- Content-Type: `application/json` (JSON)
|
||||||
|
- Encoding: `UTF8`
|
||||||
|
|
||||||
#### Request Body
|
##### Request Body
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"lookup": {
|
"lookup": {
|
||||||
@@ -141,7 +151,7 @@ Content-type: JSON UTF-8
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Response Body
|
##### Response Body
|
||||||
If a match was found:
|
If a match was found:
|
||||||
- `lookup.id.type` supported values: `localpart`, `mxid`
|
- `lookup.id.type` supported values: `localpart`, `mxid`
|
||||||
```json
|
```json
|
||||||
@@ -163,10 +173,11 @@ If no match was found:
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### Bulk 3PID lookup
|
#### Bulk 3PID lookup
|
||||||
HTTP method: `POST`
|
- Method: `POST`
|
||||||
Content-type: JSON UTF-8
|
- Content-Type: `application/json` (JSON)
|
||||||
|
- Encoding: `UTF8`
|
||||||
|
|
||||||
#### Request Body
|
##### Request Body
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"lookup": [
|
"lookup": [
|
||||||
@@ -182,7 +193,7 @@ Content-type: JSON UTF-8
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Response Body
|
##### Response Body
|
||||||
For all entries where a match was found:
|
For all entries where a match was found:
|
||||||
- `lookup[].id.type` supported values: `localpart`, `mxid`
|
- `lookup[].id.type` supported values: `localpart`, `mxid`
|
||||||
```json
|
```json
|
||||||
@@ -214,3 +225,46 @@ If no match was found:
|
|||||||
"lookup": []
|
"lookup": []
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Profile
|
||||||
|
#### Request Body
|
||||||
|
For all requests, the values are the same:
|
||||||
|
- Method: `POST`
|
||||||
|
- Content-Type: `application/json` (JSON)
|
||||||
|
- Encoding: `UTF8`
|
||||||
|
|
||||||
|
With body (example values):
|
||||||
|
##### Request Body
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"mxid": "@john.doe:example.org",
|
||||||
|
"localpart": "john.doe",
|
||||||
|
"domain": "example.org"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
#### Response Body
|
||||||
|
For all responses, the same object structure will be parsed, making the non-relevant fields as optional.
|
||||||
|
|
||||||
|
Structure with example values:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"profile": {
|
||||||
|
"display_name": "John Doe",
|
||||||
|
"threepids": [
|
||||||
|
{
|
||||||
|
"medium": "email",
|
||||||
|
"address": "john.doe@example.org"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"...": "..."
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"roles": [
|
||||||
|
"DomainUsers",
|
||||||
|
"SalesOrg",
|
||||||
|
"..."
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
The base `profile` key is mandatory. `display_name`, `threepids` and `roles` are only to be returned on the relevant request.
|
||||||
|
@@ -11,22 +11,25 @@
|
|||||||
| Authentication | No |
|
| Authentication | No |
|
||||||
| Directory | Yes |
|
| Directory | Yes |
|
||||||
| Identity | Yes |
|
| Identity | Yes |
|
||||||
|
| Profile | Yes |
|
||||||
|
|
||||||
Due to the implementation complexity of supporting arbitrary hashing/encoding mechanisms or auth flow, Authentication
|
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
|
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
|
## Configuration
|
||||||
### Basic
|
### Basic
|
||||||
```yaml
|
```yaml
|
||||||
sql.enabled: <boolean>
|
sql:
|
||||||
|
enabled: <boolean>
|
||||||
```
|
```
|
||||||
Enable/disable the identity store
|
Enable/disable the identity store
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
sql.type: <string>
|
sql:
|
||||||
|
type: <string>
|
||||||
```
|
```
|
||||||
Set the SQL backend to use:
|
Set the SQL backend to use:
|
||||||
- `sqlite`
|
- `sqlite`
|
||||||
@@ -37,14 +40,16 @@ Set the SQL backend to use:
|
|||||||
### Connection
|
### Connection
|
||||||
#### SQLite
|
#### SQLite
|
||||||
```yaml
|
```yaml
|
||||||
sql.connection: <string>
|
sql:
|
||||||
|
connection: <string>
|
||||||
```
|
```
|
||||||
Set the value to the absolute path to the Synapse SQLite DB file.
|
Set the value to the absolute path to the Synapse SQLite DB file.
|
||||||
Example: `/path/to/sqlite/file.db`
|
Example: `/path/to/sqlite/file.db`
|
||||||
|
|
||||||
#### Others
|
#### Others
|
||||||
```yaml
|
```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:
|
Set the connection info for the database by replacing the following values:
|
||||||
- `HOST`: Hostname of the SQL server
|
- `HOST`: Hostname of the SQL server
|
||||||
@@ -57,14 +62,17 @@ This follow the JDBC URI syntax. See [official website](https://docs.oracle.com/
|
|||||||
|
|
||||||
### Directory
|
### Directory
|
||||||
```yaml
|
```yaml
|
||||||
sql.directory.enabled: false
|
sql:
|
||||||
|
directory:
|
||||||
|
enabled: false
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
sql.directory.query:
|
sql:
|
||||||
|
directory:
|
||||||
|
query:
|
||||||
name:
|
name:
|
||||||
type: <string>
|
type: <string>
|
||||||
value: <string>
|
value: <string>
|
||||||
@@ -82,7 +90,9 @@ For each query, `type` can be used to tell mxisd how to process the ID column:
|
|||||||
|
|
||||||
Example:
|
Example:
|
||||||
```yaml
|
```yaml
|
||||||
sql.directory.query:
|
sql:
|
||||||
|
directory:
|
||||||
|
query:
|
||||||
name:
|
name:
|
||||||
type: 'localpart'
|
type: 'localpart'
|
||||||
value: 'SELECT idColumn, displayNameColumn FROM table WHERE displayNameColumn LIKE ?'
|
value: 'SELECT idColumn, displayNameColumn FROM table WHERE displayNameColumn LIKE ?'
|
||||||
@@ -93,6 +103,8 @@ sql.directory.query:
|
|||||||
|
|
||||||
### Identity
|
### Identity
|
||||||
```yaml
|
```yaml
|
||||||
sql.identity.type: <string>
|
sql:
|
||||||
sql.identity.query: <string>
|
identity:
|
||||||
|
type: <string>
|
||||||
|
query: <string>
|
||||||
```
|
```
|
||||||
|
@@ -7,20 +7,23 @@ Synapse's Database itself can be used as an Identity store.
|
|||||||
| Authentication | No |
|
| Authentication | No |
|
||||||
| Directory | Yes |
|
| Directory | Yes |
|
||||||
| Identity | Yes |
|
| Identity | Yes |
|
||||||
|
| Profile | Yes |
|
||||||
|
|
||||||
Authentication is done by Synapse itself.
|
Authentication is done by Synapse itself.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
### Basic
|
### Basic
|
||||||
```yaml
|
```yaml
|
||||||
synapseSql.enabled: <boolean>
|
synapseSql:
|
||||||
|
enabled: <boolean>
|
||||||
```
|
```
|
||||||
Enable/disable the identity store
|
Enable/disable the identity store
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
synapseSql.type: <string>
|
synapseSql:
|
||||||
|
type: <string>
|
||||||
```
|
```
|
||||||
Set the SQL backend to use which is configured in synapse:
|
Set the SQL backend to use which is configured in synapse:
|
||||||
- `sqlite`
|
- `sqlite`
|
||||||
@@ -28,14 +31,16 @@ Set the SQL backend to use which is configured in synapse:
|
|||||||
|
|
||||||
### SQLite
|
### SQLite
|
||||||
```yaml
|
```yaml
|
||||||
synapseSql.connection: <string>
|
synapseSql:
|
||||||
|
connection: <string>
|
||||||
```
|
```
|
||||||
Set the value to the absolute path to the Synapse SQLite DB file.
|
Set the value to the absolute path to the Synapse SQLite DB file.
|
||||||
Example: `/path/to/synapse/sqliteFile.db`
|
Example: `/path/to/synapse/sqliteFile.db`
|
||||||
|
|
||||||
### PostgreSQL
|
### PostgreSQL
|
||||||
```yaml
|
```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:
|
Set the connection info for the database by replacing the following values:
|
||||||
- `HOST`: Hostname of the SQL server
|
- `HOST`: Hostname of the SQL server
|
||||||
|
@@ -10,6 +10,7 @@ Two types of connections are required for full support:
|
|||||||
| Authentication | Yes |
|
| Authentication | Yes |
|
||||||
| Directory | Yes |
|
| Directory | Yes |
|
||||||
| Identity | Yes |
|
| Identity | Yes |
|
||||||
|
| Profile | No |
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
- [Wordpress](https://wordpress.org/download/) >= 4.4
|
- [Wordpress](https://wordpress.org/download/) >= 4.4
|
||||||
@@ -33,25 +34,42 @@ If this is not the case for your installation, the mxisd URL will need to be app
|
|||||||
### mxisd
|
### mxisd
|
||||||
Enable in the configuration:
|
Enable in the configuration:
|
||||||
```yaml
|
```yaml
|
||||||
wordpress.enabled: true
|
wordpress:
|
||||||
|
enabled: true
|
||||||
```
|
```
|
||||||
Configure the URL to your Wordpress installation - see above about added `/index.php`:
|
Configure the URL to your Wordpress installation - see above about added `/index.php`:
|
||||||
```yaml
|
```yaml
|
||||||
wordpress.rest.base: 'http://localhost:8080'
|
wordpress:
|
||||||
|
rest:
|
||||||
|
base: 'http://localhost:8080'
|
||||||
```
|
```
|
||||||
Configure the SQL connection to your Wordpress database:
|
Configure the SQL connection to your Wordpress database:
|
||||||
```yaml
|
```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:
|
By default, MySQL database is expected. If you use another database, use:
|
||||||
```yaml
|
```yaml
|
||||||
wordpress.sql.type: <string>
|
wordpress:
|
||||||
|
sql:
|
||||||
|
type: <string>
|
||||||
```
|
```
|
||||||
With possible values:
|
With possible values:
|
||||||
- `mysql`
|
- `mysql`
|
||||||
- `mariadb`
|
- `mariadb`
|
||||||
- `postgresql`
|
- `postgresql`
|
||||||
- `sqlite`
|
- `sqlite`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
To configure the tables prefix for default queries, in case a custom value was set during Wordpress install:
|
||||||
|
```yaml
|
||||||
|
wordpress:
|
||||||
|
sql:
|
||||||
|
tablePrefix: <string>
|
||||||
|
```
|
||||||
|
By default, the value is set to `wp_`.
|
||||||
|
@@ -5,7 +5,9 @@ Connector ID: `smtp`
|
|||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
```yaml
|
```yaml
|
||||||
threepid.medium.email:
|
threepid:
|
||||||
|
medium:
|
||||||
|
email:
|
||||||
identity:
|
identity:
|
||||||
from: 'identityServerEmail@example.org'
|
from: 'identityServerEmail@example.org'
|
||||||
name: 'My Identity Server'
|
name: 'My Identity Server'
|
||||||
|
@@ -5,7 +5,12 @@ Connector ID: `twilio`
|
|||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
```yaml
|
```yaml
|
||||||
threepid.medium.msisdn.connectors.twilio.accountSid: 'myAccountSid'
|
threepid:
|
||||||
threepid.medium.msisdn.connectors.twilio.authToken: 'myAuthToken'
|
medium:
|
||||||
threepid.medium.msisdn.connectors.twilio.number: '+123456789'
|
msisdn:
|
||||||
|
connectors:
|
||||||
|
twilio:
|
||||||
|
accountSid: 'myAccountSid'
|
||||||
|
authToken: 'myAuthToken'
|
||||||
|
number: '+123456789'
|
||||||
```
|
```
|
||||||
|
@@ -18,13 +18,16 @@ This handler can be used with the 3PID types:
|
|||||||
## Configuration
|
## Configuration
|
||||||
Enabled by default or with:
|
Enabled by default or with:
|
||||||
```yaml
|
```yaml
|
||||||
notification.handler.email: 'raw'
|
notification:
|
||||||
|
handler:
|
||||||
|
email: 'raw'
|
||||||
```
|
```
|
||||||
|
|
||||||
**WARNING:** Will be consolidated soon, prone to breaking changes.
|
**WARNING:** Will be consolidated soon, prone to breaking changes.
|
||||||
Structure and default values:
|
Structure and default values:
|
||||||
```yaml
|
```yaml
|
||||||
threepid.medium:
|
threepid:
|
||||||
|
medium:
|
||||||
email:
|
email:
|
||||||
identity:
|
identity:
|
||||||
from: ''
|
from: ''
|
||||||
|
@@ -1,7 +1,39 @@
|
|||||||
# SendGrid Notification handler
|
# SendGrid Notification handler
|
||||||
To be completed. See [raw possible configuration items](https://github.com/kamax-io/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
|
```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:
|
||||||
|
local:
|
||||||
|
subject: <Subject of the email notification sent for local 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>
|
||||||
|
remote:
|
||||||
|
subject: <Subject of the email notification sent for remote 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>
|
||||||
```
|
```
|
||||||
|
@@ -11,7 +11,9 @@ placeholders and also have their own individual set of placeholders.
|
|||||||
## Configuration
|
## Configuration
|
||||||
To configure paths to the various templates:
|
To configure paths to the various templates:
|
||||||
```yaml
|
```yaml
|
||||||
threepid.medium.<YOUR 3PID MEDIUM HERE>:
|
threepid:
|
||||||
|
medium:
|
||||||
|
<YOUR 3PID MEDIUM HERE>:
|
||||||
generators:
|
generators:
|
||||||
template:
|
template:
|
||||||
invite: '/path/to/invite-template.eml'
|
invite: '/path/to/invite-template.eml'
|
||||||
@@ -19,6 +21,8 @@ threepid.medium.<YOUR 3PID MEDIUM HERE>:
|
|||||||
validation:
|
validation:
|
||||||
local: '/path/to/validate-local-template.eml'
|
local: '/path/to/validate-local-template.eml'
|
||||||
remote: 'path/to/validate-remote-template.eml'
|
remote: 'path/to/validate-remote-template.eml'
|
||||||
|
generic:
|
||||||
|
matrixId: '/path/to/mxid-invite-template.eml'
|
||||||
```
|
```
|
||||||
The `template` generator is usually the default, so no further configuration is needed.
|
The `template` generator is usually the default, so no further configuration is needed.
|
||||||
|
|
||||||
|
@@ -1,20 +1,22 @@
|
|||||||
# Web pages for the 3PID sessions
|
# 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
|
## Configuration
|
||||||
Pseudo-configuration to illustrate the structure:
|
Pseudo-configuration to illustrate the structure:
|
||||||
```yaml
|
```yaml
|
||||||
# CONFIGURATION EXAMPLE
|
# CONFIGURATION EXAMPLE
|
||||||
# DO NOT COPY/PASTE THIS IN YOUR CONFIGURATION
|
# DO NOT COPY/PASTE THIS IN YOUR CONFIGURATION
|
||||||
view.session.local:
|
view:
|
||||||
|
session:
|
||||||
|
local:
|
||||||
onTokenSubmit:
|
onTokenSubmit:
|
||||||
success: '/path/to/session/local/tokenSubmitSuccess-page.html'
|
success: '/path/to/session/local/tokenSubmitSuccess-page.html'
|
||||||
failure: '/path/to/session/local/tokenSubmitFailure-page.html'
|
failure: '/path/to/session/local/tokenSubmitFailure-page.html'
|
||||||
view.session.localRemote:
|
localRemote:
|
||||||
onTokenSubmit:
|
onTokenSubmit:
|
||||||
success: '/path/to/session/localRemote/tokenSubmitSuccess-page.html'
|
success: '/path/to/session/localRemote/tokenSubmitSuccess-page.html'
|
||||||
failure: '/path/to/session/local/tokenSubmitFailure-page.html'
|
failure: '/path/to/session/local/tokenSubmitFailure-page.html'
|
||||||
view.session.remote:
|
remote:
|
||||||
onRequest:
|
onRequest:
|
||||||
success: '/path/to/session/remote/requestSuccess-page.html'
|
success: '/path/to/session/remote/requestSuccess-page.html'
|
||||||
failure: '/path/to/session/remote/requestFailure-page.html'
|
failure: '/path/to/session/remote/requestFailure-page.html'
|
||||||
@@ -55,7 +57,7 @@ client if they do not wish to proceed any further.
|
|||||||
|
|
||||||
#### Placeholders
|
#### Placeholders
|
||||||
##### Success
|
##### Success
|
||||||
`<a th:href="${remoteSessionLink}">text</a>` can be used to display the link to start a Remote 3PID session.
|
`<a href="${remoteSessionLink}">text</a>` can be used to display the link to start a Remote 3PID session.
|
||||||
|
|
||||||
##### Failure
|
##### Failure
|
||||||
No object/placeholder are currently available.
|
No object/placeholder are currently available.
|
||||||
@@ -70,7 +72,7 @@ the remote Identity server and, once that is done, click a link to validate the
|
|||||||
|
|
||||||
#### Placeholders
|
#### Placeholders
|
||||||
##### Success
|
##### Success
|
||||||
`<a th:href="${checkLink}">text</a>` can be used to display the link to validate the Remote 3PID session.
|
`<a href="${checkLink}">text</a>` can be used to display the link to validate the Remote 3PID session.
|
||||||
|
|
||||||
##### Failure
|
##### Failure
|
||||||
No object/placeholder are currently available.
|
No object/placeholder are currently available.
|
||||||
|
@@ -18,48 +18,62 @@
|
|||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
When adding an email, a phone number or any other kind of 3PID (Third-Party Identifier) in a Matrix client,
|
When adding an email, a phone number or any other kind of 3PID (Third-Party Identifier) in a Matrix client,
|
||||||
the identity server is called to validate the 3PID.
|
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.
|
||||||
|
|
||||||
Once this 3PID is validated, the Homeserver will publish the user Matrix ID on the Identity Server and
|
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.
|
add this 3PID to the Matrix account which initiated the request.
|
||||||
|
|
||||||
## Purpose
|
|
||||||
This serves two purposes:
|
This serves two purposes:
|
||||||
- Add the 3PID as an administrative/login info for the Homeserver directly
|
- 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
|
- Publish, or *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.
|
by a 3PID, allowing it to be resolved to a Matrix ID.
|
||||||
|
|
||||||
## Federation
|
## Federation
|
||||||
Federation is based on the principle that one can get a domain name and serve services and information within that
|
In a federated set up, identity servers must cooperate to find the Matrix ID associated with a 3PID.
|
||||||
domain namespace in a way which can be discovered following a specific protocol or specification.
|
|
||||||
|
|
||||||
In the Matrix eco-system, some 3PID can be federated (e.g. emails) while some others cannot (phone numbers).
|
Federation is based on the principle that each server is responsible for its own (dns) domain.
|
||||||
Also, Matrix users might add 3PIDs that would not point to the Identity server that actually holds the 3PID binding.
|
Therefore only those 3PID can be federated that can be distinguished by their
|
||||||
|
domain such as email addresses.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
Example: a user from Homeserver `example.org` adds an email `john@gmail.com`.
|
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
|
If a federated lookup was performed, Identity servers would try to find the 3PID bind at the `gmail.com` server, and
|
||||||
not `example.org`.
|
not `example.org`.
|
||||||
|
|
||||||
To allow global publishing of 3PID bindings to be found anywhere within the current protocol specification, one would
|
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
|
||||||
perform a *Remote session* and *Remote bind*, effectively starting a new 3PID session with another Identity server on
|
- 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.
|
behalf of the user.
|
||||||
|
|
||||||
To ensure lookup works consistency within the current Matrix network, the central Matrix.org Identity Server should be
|
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.
|
used to store *remote* sessions and binds.
|
||||||
|
|
||||||
On the flip side, at the time of writing, the Matrix specification and the central Matrix.org servers do not allow to
|
However, at the time of writing, the Matrix specification and the central Matrix.org servers do not allow to remote a 3PID bind.
|
||||||
remote a 3PID bind. This means that once a 3PID is published (email, phone number, etc.), it cannot be easily removed
|
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.
|
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
|
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.
|
on where such identifiers can be made publicly visible.
|
||||||
|
|
||||||
To ensure full control, validation management rely on two concepts:
|
To ensure full control, validation management relies on two concepts:
|
||||||
- The scope of 3PID being validated
|
- The scope of 3PID being validated
|
||||||
- The scope of 3PID sessions that should be possible/offered
|
- The scope of 3PID sessions that should be possible/offered
|
||||||
|
|
||||||
### 3PID scope
|
### 3PID scope
|
||||||
3PID can either be scoped as local or remote.
|
3PID can either be scoped as local or remote.
|
||||||
|
|
||||||
Local means that they can looked up using federation and that such federation call would end up on the local
|
Local means that they can be looked up using federation and that such a federation call would end up on the local
|
||||||
Identity Server.
|
Identity Server.
|
||||||
Remote means that they cannot be lookup using federation or that a federation call would not end up on the local
|
Remote means that they cannot be lookup using federation or that a federation call would not end up on the local
|
||||||
Identity Server.
|
Identity Server.
|
||||||
@@ -119,14 +133,17 @@ file unless you want to specifically overwrite them.
|
|||||||
```yaml
|
```yaml
|
||||||
# CONFIGURATION EXAMPLE
|
# CONFIGURATION EXAMPLE
|
||||||
# DO NOT COPY/PASTE THIS IN YOUR CONFIGURATION
|
# DO NOT COPY/PASTE THIS IN YOUR CONFIGURATION
|
||||||
session.policy.validation.enabled: true
|
session:
|
||||||
session.policy.validation.forLocal:
|
policy:
|
||||||
|
validation:
|
||||||
|
enabled: true
|
||||||
|
forLocal:
|
||||||
enabled: true
|
enabled: true
|
||||||
toLocal: true
|
toLocal: true
|
||||||
toRemote:
|
toRemote:
|
||||||
enabled: true
|
enabled: true
|
||||||
server: 'configExample' # Not to be included in config! Already present in default config!
|
server: 'configExample' # Not to be included in config! Already present in default config!
|
||||||
session.policy.validation.forRemote:
|
forRemote:
|
||||||
enabled: true
|
enabled: true
|
||||||
toLocal: true
|
toLocal: true
|
||||||
toRemote:
|
toRemote:
|
||||||
@@ -139,7 +156,7 @@ session.policy.validation.forRemote:
|
|||||||
`session.policy.validation` is the core configuration to control what users configured to use your Identity server
|
`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 is divided contains 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.
|
It is also divided into two sections: `forLocal` and `forRemote` which refers to the 3PID scopes.
|
||||||
|
|
||||||
Each scope is divided into three parts:
|
Each scope is divided into three parts:
|
||||||
@@ -205,13 +222,16 @@ On the flip side, people with *Remote* 3PID scopes will not be found from other
|
|||||||
|
|
||||||
Use the following values:
|
Use the following values:
|
||||||
```yaml
|
```yaml
|
||||||
session.policy.validation.enabled: true
|
session:
|
||||||
session.policy.validation.forLocal:
|
policy:
|
||||||
|
validation:
|
||||||
|
enabled: true
|
||||||
|
forLocal:
|
||||||
enabled: true
|
enabled: true
|
||||||
toLocal: true
|
toLocal: true
|
||||||
toRemote:
|
toRemote:
|
||||||
enabled: false
|
enabled: false
|
||||||
session.policy.validation.forRemote:
|
forRemote:
|
||||||
enabled: true
|
enabled: true
|
||||||
toLocal: true
|
toLocal: true
|
||||||
toRemote:
|
toRemote:
|
||||||
@@ -231,13 +251,16 @@ Typical use cases:
|
|||||||
|
|
||||||
Use the following values:
|
Use the following values:
|
||||||
```yaml
|
```yaml
|
||||||
session.policy.validation.enabled: true
|
session:
|
||||||
session.policy.validation.forLocal:
|
policy:
|
||||||
|
validation:
|
||||||
|
enabled: true
|
||||||
|
forLocal:
|
||||||
enabled: true
|
enabled: true
|
||||||
toLocal: false
|
toLocal: false
|
||||||
toRemote:
|
toRemote:
|
||||||
enabled: true
|
enabled: true
|
||||||
session.policy.validation.forRemote:
|
forRemote:
|
||||||
enabled: true
|
enabled: true
|
||||||
toLocal: false
|
toLocal: false
|
||||||
toRemote:
|
toRemote:
|
||||||
@@ -258,5 +281,8 @@ It is therefore recommended to not fully disable sessions but instead restrict s
|
|||||||
|
|
||||||
Use the following values to enable this mode:
|
Use the following values to enable this mode:
|
||||||
```yaml
|
```yaml
|
||||||
session.policy.validation.enabled: false
|
session:
|
||||||
|
policy:
|
||||||
|
validation:
|
||||||
|
enabled: false
|
||||||
```
|
```
|
||||||
|
116
mxisd.example.yaml
Normal file
116
mxisd.example.yaml
Normal file
@@ -0,0 +1,116 @@
|
|||||||
|
# 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
|
||||||
|
|
||||||
|
#######################
|
||||||
|
# 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.
|
||||||
|
matrix:
|
||||||
|
domain: ''
|
||||||
|
|
||||||
|
|
||||||
|
################
|
||||||
|
# Signing keys #
|
||||||
|
################
|
||||||
|
# Absolute path for the Identity Server signing key.
|
||||||
|
# This is **NOT** your homeserver key.
|
||||||
|
# The signing key is auto-generated during execution time if not present.
|
||||||
|
#
|
||||||
|
# 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
|
||||||
|
#
|
||||||
|
key:
|
||||||
|
path: ''
|
||||||
|
|
||||||
|
|
||||||
|
# Path to the SQLite DB file for mxisd internal storage
|
||||||
|
#
|
||||||
|
# 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.
|
||||||
|
# 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
|
||||||
|
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
|
||||||
|
|
||||||
|
# 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
|
||||||
|
#
|
||||||
|
tls: 1
|
||||||
|
|
||||||
|
# Login for SMTP
|
||||||
|
login: "matrix-identity@example.org"
|
||||||
|
|
||||||
|
# Password for the account
|
||||||
|
password: "ThePassword"
|
@@ -1,6 +1,6 @@
|
|||||||
Package: mxisd
|
Package: mxisd
|
||||||
Maintainer: Kamax.io <foss@kamax.io>
|
Maintainer: Kamax.io <foss@kamax.io>
|
||||||
Homepage: https://github.com/kamax-io/mxisd
|
Homepage: https://github.com/kamax-matrix/mxisd
|
||||||
Description: Federated Matrix Identity Server
|
Description: Federated Matrix Identity Server
|
||||||
Architecture: all
|
Architecture: all
|
||||||
Depends: openjdk-8-jre | openjdk-8-jre-headless | openjdk-8-jdk | openjdk-8-jdk-headless
|
Depends: openjdk-8-jre | openjdk-8-jre-headless | openjdk-8-jdk | openjdk-8-jdk-headless
|
||||||
|
@@ -6,8 +6,8 @@ useradd -r mxisd || true
|
|||||||
# Set permissions for data directory
|
# Set permissions for data directory
|
||||||
chown -R mxisd:mxisd %DEB_DATA_DIR%
|
chown -R mxisd:mxisd %DEB_DATA_DIR%
|
||||||
|
|
||||||
# Create symlink to mxusd
|
# Create symlink to mxisd run script
|
||||||
ln -sfT /usr/lib/mxisd/mxisd.jar /usr/bin/mxisd
|
ln -sfT /usr/lib/mxisd/mxisd /usr/bin/mxisd
|
||||||
|
|
||||||
# Enable systemd service
|
# Enable systemd service
|
||||||
systemctl enable mxisd.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
|
if [[ -n "$CONF_FILE_PATH" ]] && [ ! -f "$CONF_FILE_PATH" ]; then
|
||||||
echo "Generating config file $CONF_FILE_PATH"
|
echo "Generating config file $CONF_FILE_PATH"
|
||||||
touch "CONF_FILE_PATH"
|
touch "CONF_FILE_PATH"
|
||||||
|
|
||||||
if [[ -n "$MATRIX_DOMAIN" ]]; then
|
if [[ -n "$MATRIX_DOMAIN" ]]; then
|
||||||
echo "Setting matrix domain to $MATRIX_DOMAIN"
|
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
|
fi
|
||||||
|
|
||||||
if [[ -n "$SIGN_KEY_PATH" ]]; then
|
if [[ -n "$SIGN_KEY_PATH" ]]; then
|
||||||
echo "Setting signing key path to $SIGN_KEY_PATH"
|
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
|
fi
|
||||||
|
|
||||||
if [[ -n "$SQLITE_DATABASE_PATH" ]]; then
|
if [[ -n "$SQLITE_DATABASE_PATH" ]]; then
|
||||||
echo "Setting SQLite DB path to $SQLITE_DATABASE_PATH"
|
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
|
fi
|
||||||
|
|
||||||
echo "Starting mxisd..."
|
echo "Starting mxisd..."
|
||||||
echo
|
echo
|
||||||
fi
|
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
|
||||||
|
@@ -37,6 +37,7 @@ import java.util.List;
|
|||||||
* both IPv4 and IPv6.
|
* both IPv4 and IPv6.
|
||||||
*/
|
*/
|
||||||
public class CIDRUtils {
|
public class CIDRUtils {
|
||||||
|
|
||||||
private final String cidr;
|
private final String cidr;
|
||||||
|
|
||||||
private InetAddress inetAddress;
|
private InetAddress inetAddress;
|
||||||
@@ -44,7 +45,6 @@ public class CIDRUtils {
|
|||||||
private InetAddress endAddress;
|
private InetAddress endAddress;
|
||||||
private final int prefixLength;
|
private final int prefixLength;
|
||||||
|
|
||||||
|
|
||||||
public CIDRUtils(String cidr) throws UnknownHostException {
|
public CIDRUtils(String cidr) throws UnknownHostException {
|
||||||
|
|
||||||
this.cidr = cidr;
|
this.cidr = cidr;
|
||||||
@@ -66,7 +66,6 @@ public class CIDRUtils {
|
|||||||
|
|
||||||
|
|
||||||
private void calculate() throws UnknownHostException {
|
private void calculate() throws UnknownHostException {
|
||||||
|
|
||||||
ByteBuffer maskBuffer;
|
ByteBuffer maskBuffer;
|
||||||
int targetSize;
|
int targetSize;
|
||||||
if (inetAddress.getAddress().length == 4) {
|
if (inetAddress.getAddress().length == 4) {
|
||||||
@@ -120,14 +119,9 @@ public class CIDRUtils {
|
|||||||
}
|
}
|
||||||
|
|
||||||
public String getNetworkAddress() {
|
public String getNetworkAddress() {
|
||||||
|
|
||||||
return this.startAddress.getHostAddress();
|
return this.startAddress.getHostAddress();
|
||||||
}
|
}
|
||||||
|
|
||||||
public String getBroadcastAddress() {
|
|
||||||
return this.endAddress.getHostAddress();
|
|
||||||
}
|
|
||||||
|
|
||||||
public boolean isInRange(String ipAddress) throws UnknownHostException {
|
public boolean isInRange(String ipAddress) throws UnknownHostException {
|
||||||
InetAddress address = InetAddress.getByName(ipAddress);
|
InetAddress address = InetAddress.getByName(ipAddress);
|
||||||
BigInteger start = new BigInteger(1, this.startAddress.getAddress());
|
BigInteger start = new BigInteger(1, this.startAddress.getAddress());
|
||||||
@@ -139,4 +133,5 @@ public class CIDRUtils {
|
|||||||
|
|
||||||
return (st == -1 || st == 0) && (te == -1 || te == 0);
|
return (st == -1 || st == 0) && (te == -1 || te == 0);
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
114
src/main/java/io/kamax/mxisd/HttpMxisd.java
Normal file
114
src/main/java/io/kamax/mxisd/HttpMxisd.java
Normal file
@@ -0,0 +1,114 @@
|
|||||||
|
/*
|
||||||
|
* 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.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.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.profile.v1.InternalProfileHandler;
|
||||||
|
import io.kamax.mxisd.http.undertow.handler.profile.v1.ProfileHandler;
|
||||||
|
import io.kamax.mxisd.http.undertow.handler.status.StatusHandler;
|
||||||
|
import io.undertow.Handlers;
|
||||||
|
import io.undertow.Undertow;
|
||||||
|
import io.undertow.server.HttpHandler;
|
||||||
|
|
||||||
|
public class HttpMxisd {
|
||||||
|
|
||||||
|
// Core
|
||||||
|
private Mxisd m;
|
||||||
|
|
||||||
|
// I/O
|
||||||
|
private Undertow httpSrv;
|
||||||
|
|
||||||
|
public HttpMxisd(MxisdConfig cfg) {
|
||||||
|
m = new Mxisd(cfg);
|
||||||
|
}
|
||||||
|
|
||||||
|
public void start() {
|
||||||
|
m.start();
|
||||||
|
|
||||||
|
HttpHandler asNotFoundHandler = SaneHandler.around(new AsNotFoundHandler(m.getAs()));
|
||||||
|
HttpHandler asTxnHandler = SaneHandler.around(new AsTransactionHandler(m.getAs()));
|
||||||
|
HttpHandler storeInvHandler = SaneHandler.around(new StoreInviteHandler(m.getConfig().getServer(), m.getInvitationManager(), 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()
|
||||||
|
|
||||||
|
// Status endpoints
|
||||||
|
.get(StatusHandler.Path, SaneHandler.around(new StatusHandler()))
|
||||||
|
|
||||||
|
// 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()))
|
||||||
|
|
||||||
|
// Identity endpoints
|
||||||
|
.get(HelloHandler.Path, SaneHandler.around(new HelloHandler()))
|
||||||
|
.get(SingleLookupHandler.Path, SaneHandler.around(new SingleLookupHandler(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.getInvitationManager())))
|
||||||
|
.get(RemoteIdentityAPIv1.SESSION_REQUEST_TOKEN, SaneHandler.around(new RemoteSessionStartHandler(m.getSession(), m.getConfig().getView())))
|
||||||
|
.get(RemoteIdentityAPIv1.SESSION_CHECK, SaneHandler.around(new RemoteSessionCheckHandler(m.getSession(), m.getConfig().getView())))
|
||||||
|
|
||||||
|
// Profile endpoints
|
||||||
|
.get(ProfileHandler.Path, SaneHandler.around(new ProfileHandler(m.getProfile())))
|
||||||
|
.get(InternalProfileHandler.Path, SaneHandler.around(new InternalProfileHandler(m.getProfile())))
|
||||||
|
|
||||||
|
// Application Service endpoints
|
||||||
|
.get("/_matrix/app/v1/users/**", asNotFoundHandler)
|
||||||
|
.get("/users/**", asNotFoundHandler) // Legacy endpoint
|
||||||
|
.get("/_matrix/app/v1/rooms/**", asNotFoundHandler)
|
||||||
|
.get("/rooms/**", asNotFoundHandler) // Legacy endpoint
|
||||||
|
.put(AsTransactionHandler.Path, asTxnHandler)
|
||||||
|
.put("/transactions/{" + AsTransactionHandler.ID + "}", asTxnHandler) // Legacy endpoint
|
||||||
|
|
||||||
|
).build();
|
||||||
|
|
||||||
|
httpSrv.start();
|
||||||
|
}
|
||||||
|
|
||||||
|
public void stop() {
|
||||||
|
httpSrv.stop();
|
||||||
|
|
||||||
|
m.stop();
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
172
src/main/java/io/kamax/mxisd/Mxisd.java
Normal file
172
src/main/java/io/kamax/mxisd/Mxisd.java
Normal file
@@ -0,0 +1,172 @@
|
|||||||
|
/*
|
||||||
|
* 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.matrix.crypto.KeyManager;
|
||||||
|
import io.kamax.matrix.crypto.SignatureManager;
|
||||||
|
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.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.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.session.SessionMananger;
|
||||||
|
import io.kamax.mxisd.storage.IStorage;
|
||||||
|
import io.kamax.mxisd.storage.ormlite.OrmLiteSqliteStorage;
|
||||||
|
import org.apache.http.impl.client.CloseableHttpClient;
|
||||||
|
import org.apache.http.impl.client.HttpClients;
|
||||||
|
|
||||||
|
import java.util.ServiceLoader;
|
||||||
|
|
||||||
|
public class Mxisd {
|
||||||
|
|
||||||
|
protected MxisdConfig cfg;
|
||||||
|
|
||||||
|
protected CloseableHttpClient httpClient;
|
||||||
|
protected IRemoteIdentityServerFetcher srvFetcher;
|
||||||
|
|
||||||
|
protected IStorage store;
|
||||||
|
|
||||||
|
protected KeyManager keyMgr;
|
||||||
|
protected SignatureManager signMgr;
|
||||||
|
|
||||||
|
// Features
|
||||||
|
protected AuthManager authMgr;
|
||||||
|
protected DirectoryManager dirMgr;
|
||||||
|
protected LookupStrategy idStrategy;
|
||||||
|
protected InvitationManager invMgr;
|
||||||
|
protected ProfileManager pMgr;
|
||||||
|
protected AppSvcManager asHander;
|
||||||
|
protected SessionMananger sessMgr;
|
||||||
|
protected NotificationManager notifMgr;
|
||||||
|
|
||||||
|
public Mxisd(MxisdConfig cfg) {
|
||||||
|
this.cfg = cfg.build();
|
||||||
|
}
|
||||||
|
|
||||||
|
protected void build() {
|
||||||
|
httpClient = HttpClients.custom()
|
||||||
|
.setUserAgent("mxisd")
|
||||||
|
.setMaxConnPerRoute(Integer.MAX_VALUE)
|
||||||
|
.setMaxConnTotal(Integer.MAX_VALUE)
|
||||||
|
.build();
|
||||||
|
|
||||||
|
srvFetcher = new RemoteIdentityServerFetcher(httpClient);
|
||||||
|
|
||||||
|
store = new OrmLiteSqliteStorage(cfg);
|
||||||
|
keyMgr = CryptoFactory.getKeyManager(cfg.getKey());
|
||||||
|
signMgr = CryptoFactory.getSignatureManager(keyMgr, cfg.getServer());
|
||||||
|
ClientDnsOverwrite clientDns = new ClientDnsOverwrite(cfg.getDns().getOverwrite());
|
||||||
|
FederationDnsOverwrite fedDns = new FederationDnsOverwrite(cfg.getDns().getOverwrite());
|
||||||
|
Synapse 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 SessionMananger(cfg.getSession(), cfg.getMatrix(), store, notifMgr, httpClient);
|
||||||
|
invMgr = new InvitationManager(cfg.getInvite(), store, idStrategy, signMgr, fedDns, notifMgr);
|
||||||
|
authMgr = new AuthManager(cfg, AuthProviders.get(), idStrategy, invMgr, clientDns, httpClient);
|
||||||
|
dirMgr = new DirectoryManager(cfg.getDirectory(), clientDns, httpClient, DirectoryProviders.get());
|
||||||
|
asHander = new AppSvcManager(cfg, store, pMgr, notifMgr, synapse);
|
||||||
|
}
|
||||||
|
|
||||||
|
public MxisdConfig getConfig() {
|
||||||
|
return cfg;
|
||||||
|
}
|
||||||
|
|
||||||
|
public CloseableHttpClient getHttpClient() {
|
||||||
|
return httpClient;
|
||||||
|
}
|
||||||
|
|
||||||
|
public IRemoteIdentityServerFetcher getServerFetcher() {
|
||||||
|
return srvFetcher;
|
||||||
|
}
|
||||||
|
|
||||||
|
public KeyManager getKeyManager() {
|
||||||
|
return keyMgr;
|
||||||
|
}
|
||||||
|
|
||||||
|
public InvitationManager getInvitationManager() {
|
||||||
|
return invMgr;
|
||||||
|
}
|
||||||
|
|
||||||
|
public LookupStrategy getIdentity() {
|
||||||
|
return idStrategy;
|
||||||
|
}
|
||||||
|
|
||||||
|
public AuthManager getAuth() {
|
||||||
|
return authMgr;
|
||||||
|
}
|
||||||
|
|
||||||
|
public SessionMananger getSession() {
|
||||||
|
return sessMgr;
|
||||||
|
}
|
||||||
|
|
||||||
|
public DirectoryManager getDirectory() {
|
||||||
|
return dirMgr;
|
||||||
|
}
|
||||||
|
|
||||||
|
public ProfileManager getProfile() {
|
||||||
|
return pMgr;
|
||||||
|
}
|
||||||
|
|
||||||
|
public SignatureManager getSign() {
|
||||||
|
return signMgr;
|
||||||
|
}
|
||||||
|
|
||||||
|
public AppSvcManager getAs() {
|
||||||
|
return asHander;
|
||||||
|
}
|
||||||
|
|
||||||
|
public NotificationManager getNotif() {
|
||||||
|
return notifMgr;
|
||||||
|
}
|
||||||
|
|
||||||
|
public void start() {
|
||||||
|
build();
|
||||||
|
}
|
||||||
|
|
||||||
|
public void stop() {
|
||||||
|
// no-op
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
69
src/main/java/io/kamax/mxisd/MxisdStandaloneExec.java
Normal file
69
src/main/java/io/kamax/mxisd/MxisdStandaloneExec.java
Normal file
@@ -0,0 +1,69 @@
|
|||||||
|
/*
|
||||||
|
* 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 org.apache.commons.lang3.StringUtils;
|
||||||
|
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.util.Arrays;
|
||||||
|
import java.util.Iterator;
|
||||||
|
import java.util.Objects;
|
||||||
|
|
||||||
|
public class MxisdStandaloneExec {
|
||||||
|
|
||||||
|
public static void main(String[] args) throws IOException {
|
||||||
|
MxisdConfig cfg = null;
|
||||||
|
|
||||||
|
Iterator<String> argsIt = Arrays.asList(args).iterator();
|
||||||
|
while (argsIt.hasNext()) {
|
||||||
|
String arg = argsIt.next();
|
||||||
|
if (StringUtils.equals("-c", arg)) {
|
||||||
|
String cfgFile = argsIt.next();
|
||||||
|
cfg = YamlConfigLoader.loadFromFile(cfgFile);
|
||||||
|
System.out.println("Loaded configuration from " + cfgFile);
|
||||||
|
} else {
|
||||||
|
System.out.println("Invalid argument: " + arg);
|
||||||
|
System.exit(1);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (Objects.isNull(cfg)) {
|
||||||
|
cfg = YamlConfigLoader.tryLoadFromFile("mxisd.yaml").orElseGet(MxisdConfig::new);
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
HttpMxisd mxisd = new HttpMxisd(cfg);
|
||||||
|
Runtime.getRuntime().addShutdownHook(new Thread(() -> {
|
||||||
|
mxisd.stop();
|
||||||
|
System.out.println("------------- mxisd stopped -------------");
|
||||||
|
}));
|
||||||
|
mxisd.start();
|
||||||
|
|
||||||
|
System.out.println("------------- mxisd started -------------");
|
||||||
|
} catch (Throwable t) {
|
||||||
|
t.printStackTrace();
|
||||||
|
System.exit(1);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@@ -1,8 +1,8 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2017 Maxime Dor
|
* Copyright (C) 2017 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://max.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU Affero General Public License as
|
* it under the terms of the GNU Affero General Public License as
|
||||||
@@ -30,6 +30,10 @@ public class UserID {
|
|||||||
// stub for (de)serialization
|
// stub for (de)serialization
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public UserID(UserIdType type, String value) {
|
||||||
|
this(type.getId(), value);
|
||||||
|
}
|
||||||
|
|
||||||
public UserID(String type, String value) {
|
public UserID(String type, String value) {
|
||||||
this.type = type;
|
this.type = type;
|
||||||
this.value = value;
|
this.value = value;
|
||||||
|
@@ -1,8 +1,8 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2017 Maxime Dor
|
* Copyright (C) 2017 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://max.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU Affero General Public License as
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
223
src/main/java/io/kamax/mxisd/as/AppSvcManager.java
Normal file
223
src/main/java/io/kamax/mxisd/as/AppSvcManager.java
Normal file
@@ -0,0 +1,223 @@
|
|||||||
|
/*
|
||||||
|
* 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.MatrixConfig;
|
||||||
|
import io.kamax.mxisd.config.MxisdConfig;
|
||||||
|
import io.kamax.mxisd.exception.HttpMatrixException;
|
||||||
|
import io.kamax.mxisd.exception.NotAllowedException;
|
||||||
|
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 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;
|
||||||
|
|
||||||
|
public class AppSvcManager {
|
||||||
|
|
||||||
|
private transient final Logger log = LoggerFactory.getLogger(AppSvcManager.class);
|
||||||
|
|
||||||
|
private final GsonParser parser;
|
||||||
|
|
||||||
|
private MatrixConfig cfg;
|
||||||
|
private IStorage store;
|
||||||
|
private ProfileManager profiler;
|
||||||
|
private NotificationManager notif;
|
||||||
|
private Synapse synapse;
|
||||||
|
|
||||||
|
private Map<String, CompletableFuture<String>> transactionsInProgress;
|
||||||
|
|
||||||
|
public AppSvcManager(MxisdConfig cfg, IStorage store, ProfileManager profiler, NotificationManager notif, Synapse synapse) {
|
||||||
|
this.cfg = cfg.getMatrix();
|
||||||
|
this.store = store;
|
||||||
|
this.profiler = profiler;
|
||||||
|
this.notif = notif;
|
||||||
|
this.synapse = synapse;
|
||||||
|
|
||||||
|
parser = new GsonParser();
|
||||||
|
transactionsInProgress = new ConcurrentHashMap<>();
|
||||||
|
}
|
||||||
|
|
||||||
|
public AppSvcManager withToken(String token) {
|
||||||
|
if (StringUtils.isBlank(token)) {
|
||||||
|
throw new HttpMatrixException(401, "M_UNAUTHORIZED", "No HS token");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!StringUtils.equals(cfg.getListener().getToken().getHs(), token)) {
|
||||||
|
throw new NotAllowedException("Invalid HS token");
|
||||||
|
}
|
||||||
|
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public CompletableFuture<String> processTransaction(String txnId, InputStream is) {
|
||||||
|
if (StringUtils.isEmpty(txnId)) {
|
||||||
|
throw new IllegalArgumentException("Transaction ID cannot be empty");
|
||||||
|
}
|
||||||
|
|
||||||
|
synchronized (this) {
|
||||||
|
Optional<ASTransactionDao> dao = store.getTransactionResult(cfg.getListener().getLocalpart(), 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.getListener().getLocalpart(), 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;
|
||||||
|
}
|
||||||
|
|
||||||
|
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");
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
30
src/main/java/io/kamax/mxisd/as/IMatrixIdInvite.java
Normal file
30
src/main/java/io/kamax/mxisd/as/IMatrixIdInvite.java
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
/*
|
||||||
|
* 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 io.kamax.matrix._MatrixID;
|
||||||
|
import io.kamax.mxisd.invitation.IThreePidInvite;
|
||||||
|
|
||||||
|
public interface IMatrixIdInvite extends IThreePidInvite {
|
||||||
|
|
||||||
|
_MatrixID getInvitee();
|
||||||
|
|
||||||
|
}
|
77
src/main/java/io/kamax/mxisd/as/MatrixIdInvite.java
Normal file
77
src/main/java/io/kamax/mxisd/as/MatrixIdInvite.java
Normal file
@@ -0,0 +1,77 @@
|
|||||||
|
/*
|
||||||
|
* 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 io.kamax.matrix._MatrixID;
|
||||||
|
|
||||||
|
import java.util.HashMap;
|
||||||
|
import java.util.Map;
|
||||||
|
import java.util.Objects;
|
||||||
|
|
||||||
|
public class MatrixIdInvite implements IMatrixIdInvite {
|
||||||
|
|
||||||
|
private String roomId;
|
||||||
|
private _MatrixID sender;
|
||||||
|
private _MatrixID invitee;
|
||||||
|
private String medium;
|
||||||
|
private String address;
|
||||||
|
private Map<String, String> properties;
|
||||||
|
|
||||||
|
public MatrixIdInvite(String roomId, _MatrixID sender, _MatrixID invitee, String medium, String address, Map<String, String> properties) {
|
||||||
|
this.roomId = Objects.requireNonNull(roomId);
|
||||||
|
this.sender = Objects.requireNonNull(sender);
|
||||||
|
this.invitee = Objects.requireNonNull(invitee);
|
||||||
|
this.medium = Objects.requireNonNull(medium);
|
||||||
|
this.address = Objects.requireNonNull(address);
|
||||||
|
this.properties = new HashMap<>(Objects.requireNonNull(properties));
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public _MatrixID getSender() {
|
||||||
|
return sender;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String getMedium() {
|
||||||
|
return medium;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String getAddress() {
|
||||||
|
return address;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public _MatrixID getInvitee() {
|
||||||
|
return invitee;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String getRoomId() {
|
||||||
|
return roomId;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public Map<String, String> getProperties() {
|
||||||
|
return properties;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@@ -1,8 +1,8 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2017 Maxime Dor
|
* Copyright (C) 2017 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://max.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU Affero General Public License as
|
* it under the terms of the GNU Affero General Public License as
|
||||||
@@ -20,37 +20,92 @@
|
|||||||
|
|
||||||
package io.kamax.mxisd.auth;
|
package io.kamax.mxisd.auth;
|
||||||
|
|
||||||
|
import com.google.gson.Gson;
|
||||||
|
import com.google.gson.JsonObject;
|
||||||
|
import com.google.gson.JsonParser;
|
||||||
|
import com.google.gson.JsonSyntaxException;
|
||||||
|
import com.google.i18n.phonenumbers.NumberParseException;
|
||||||
|
import com.google.i18n.phonenumbers.PhoneNumberUtil;
|
||||||
|
import com.google.i18n.phonenumbers.Phonenumber;
|
||||||
import io.kamax.matrix.MatrixID;
|
import io.kamax.matrix.MatrixID;
|
||||||
import io.kamax.matrix.ThreePid;
|
import io.kamax.matrix.ThreePid;
|
||||||
import io.kamax.matrix._MatrixID;
|
import io.kamax.matrix._MatrixID;
|
||||||
import io.kamax.matrix._ThreePid;
|
import io.kamax.matrix._ThreePid;
|
||||||
|
import io.kamax.matrix.json.GsonUtil;
|
||||||
import io.kamax.mxisd.UserIdType;
|
import io.kamax.mxisd.UserIdType;
|
||||||
import io.kamax.mxisd.auth.provider.AuthenticatorProvider;
|
import io.kamax.mxisd.auth.provider.AuthenticatorProvider;
|
||||||
import io.kamax.mxisd.auth.provider.BackendAuthResult;
|
import io.kamax.mxisd.auth.provider.BackendAuthResult;
|
||||||
|
import io.kamax.mxisd.config.AuthenticationConfig;
|
||||||
import io.kamax.mxisd.config.MatrixConfig;
|
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;
|
import io.kamax.mxisd.invitation.InvitationManager;
|
||||||
import io.kamax.mxisd.lookup.ThreePidMapping;
|
import io.kamax.mxisd.lookup.ThreePidMapping;
|
||||||
|
import io.kamax.mxisd.lookup.strategy.LookupStrategy;
|
||||||
|
import io.kamax.mxisd.util.RestClientUtils;
|
||||||
|
import org.apache.commons.io.IOUtils;
|
||||||
|
import org.apache.commons.lang.StringUtils;
|
||||||
|
import org.apache.http.HttpEntity;
|
||||||
|
import org.apache.http.client.methods.CloseableHttpResponse;
|
||||||
|
import org.apache.http.client.methods.HttpPost;
|
||||||
|
import org.apache.http.client.utils.URIBuilder;
|
||||||
|
import org.apache.http.impl.client.CloseableHttpClient;
|
||||||
|
import org.apache.http.util.EntityUtils;
|
||||||
import org.slf4j.Logger;
|
import org.slf4j.Logger;
|
||||||
import org.slf4j.LoggerFactory;
|
import org.slf4j.LoggerFactory;
|
||||||
import org.springframework.beans.factory.annotation.Autowired;
|
|
||||||
import org.springframework.stereotype.Service;
|
|
||||||
|
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.net.URI;
|
||||||
|
import java.nio.charset.StandardCharsets;
|
||||||
import java.util.ArrayList;
|
import java.util.ArrayList;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
|
import java.util.Objects;
|
||||||
|
|
||||||
@Service
|
|
||||||
public class AuthManager {
|
public class AuthManager {
|
||||||
|
|
||||||
private Logger log = LoggerFactory.getLogger(AuthManager.class);
|
private static final String TypeKey = "type";
|
||||||
|
private static final String UserKey = "user";
|
||||||
|
private static final String IdentifierKey = "identifier";
|
||||||
|
private static final String ThreepidMediumKey = "medium";
|
||||||
|
private static final String ThreepidAddressKey = "address";
|
||||||
|
private static final String UserIdTypeValue = "m.id.user";
|
||||||
|
private static final String ThreepidTypeValue = "m.id.thirdparty";
|
||||||
|
|
||||||
@Autowired
|
private transient final Logger log = LoggerFactory.getLogger(AuthManager.class);
|
||||||
private List<AuthenticatorProvider> providers = new ArrayList<>();
|
private final Gson gson = GsonUtil.get(); // FIXME replace
|
||||||
|
|
||||||
@Autowired
|
private List<AuthenticatorProvider> providers;
|
||||||
private MatrixConfig mxCfg;
|
private MatrixConfig mxCfg;
|
||||||
|
private AuthenticationConfig cfg;
|
||||||
@Autowired
|
|
||||||
private InvitationManager invMgr;
|
private InvitationManager invMgr;
|
||||||
|
private ClientDnsOverwrite dns;
|
||||||
|
private LookupStrategy strategy;
|
||||||
|
private CloseableHttpClient client;
|
||||||
|
|
||||||
|
public AuthManager(
|
||||||
|
MxisdConfig cfg,
|
||||||
|
List<? extends AuthenticatorProvider> providers,
|
||||||
|
LookupStrategy strategy,
|
||||||
|
InvitationManager invMgr,
|
||||||
|
ClientDnsOverwrite dns,
|
||||||
|
CloseableHttpClient client
|
||||||
|
) {
|
||||||
|
this.cfg = cfg.getAuth();
|
||||||
|
this.mxCfg = cfg.getMatrix();
|
||||||
|
this.providers = new ArrayList<>(providers);
|
||||||
|
this.strategy = strategy;
|
||||||
|
this.invMgr = invMgr;
|
||||||
|
this.dns = dns;
|
||||||
|
this.client = client;
|
||||||
|
}
|
||||||
|
|
||||||
|
public String resolveProxyUrl(URI target) {
|
||||||
|
URIBuilder builder = dns.transform(target);
|
||||||
|
String urlToLogin = builder.toString();
|
||||||
|
log.info("Proxy resolution: {} to {}", target.toString(), urlToLogin);
|
||||||
|
return urlToLogin;
|
||||||
|
}
|
||||||
|
|
||||||
public UserAuthResult authenticate(String id, String password) {
|
public UserAuthResult authenticate(String id, String password) {
|
||||||
_MatrixID mxid = MatrixID.asAcceptable(id);
|
_MatrixID mxid = MatrixID.asAcceptable(id);
|
||||||
@@ -59,9 +114,10 @@ public class AuthManager {
|
|||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
log.info("Attempting authentication with store {}", provider.getClass().getSimpleName());
|
||||||
|
|
||||||
BackendAuthResult result = provider.authenticate(mxid, password);
|
BackendAuthResult result = provider.authenticate(mxid, password);
|
||||||
if (result.isSuccess()) {
|
if (result.isSuccess()) {
|
||||||
|
|
||||||
String mxId;
|
String mxId;
|
||||||
if (UserIdType.Localpart.is(result.getId().getType())) {
|
if (UserIdType.Localpart.is(result.getId().getType())) {
|
||||||
mxId = MatrixID.from(result.getId().getValue(), mxCfg.getDomain()).acceptable().getId();
|
mxId = MatrixID.from(result.getId().getValue(), mxCfg.getDomain()).acceptable().getId();
|
||||||
@@ -91,4 +147,128 @@ public class AuthManager {
|
|||||||
return new UserAuthResult().failure();
|
return new UserAuthResult().failure();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public String proxyLogin(URI target, String body) {
|
||||||
|
JsonObject reqJsonObject = io.kamax.matrix.json.GsonUtil.parseObj(body);
|
||||||
|
|
||||||
|
GsonUtil.findObj(reqJsonObject, IdentifierKey).ifPresent(obj -> {
|
||||||
|
GsonUtil.findString(obj, TypeKey).ifPresent(type -> {
|
||||||
|
if (StringUtils.equals(type, UserIdTypeValue)) {
|
||||||
|
log.info("Login request is User ID type");
|
||||||
|
|
||||||
|
if (cfg.getRewrite().getUser().getRules().isEmpty()) {
|
||||||
|
log.info("No User ID rewrite rules to apply");
|
||||||
|
} else {
|
||||||
|
log.info("User ID rewrite rules: checking for a match");
|
||||||
|
|
||||||
|
String userId = GsonUtil.getStringOrThrow(obj, UserKey);
|
||||||
|
for (AuthenticationConfig.Rule m : cfg.getRewrite().getUser().getRules()) {
|
||||||
|
if (m.getPattern().matcher(userId).matches()) {
|
||||||
|
log.info("Found matching pattern, resolving to 3PID with medium {}", m.getMedium());
|
||||||
|
|
||||||
|
// Remove deprecated login info on the top object if exists to avoid duplication
|
||||||
|
reqJsonObject.remove(UserKey);
|
||||||
|
obj.addProperty(TypeKey, ThreepidTypeValue);
|
||||||
|
obj.addProperty(ThreepidMediumKey, m.getMedium());
|
||||||
|
obj.addProperty(ThreepidAddressKey, userId);
|
||||||
|
|
||||||
|
log.info("Rewrite to 3PID done");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
log.info("User ID rewrite rules: done checking rules");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
GsonUtil.findObj(reqJsonObject, IdentifierKey).ifPresent(obj -> {
|
||||||
|
GsonUtil.findString(obj, TypeKey).ifPresent(type -> {
|
||||||
|
if (StringUtils.equals(type, ThreepidTypeValue)) {
|
||||||
|
// Remove deprecated login info if exists to avoid duplication
|
||||||
|
reqJsonObject.remove(ThreepidMediumKey);
|
||||||
|
reqJsonObject.remove(ThreepidAddressKey);
|
||||||
|
|
||||||
|
GsonUtil.findPrimitive(obj, ThreepidMediumKey).ifPresent(medium -> {
|
||||||
|
GsonUtil.findPrimitive(obj, ThreepidAddressKey).ifPresent(address -> {
|
||||||
|
log.info("Login request with medium '{}' and address '{}'", medium.getAsString(), address.getAsString());
|
||||||
|
strategy.findLocal(medium.getAsString(), address.getAsString()).ifPresent(lookupDataOpt -> {
|
||||||
|
obj.remove(ThreepidMediumKey);
|
||||||
|
obj.remove(ThreepidAddressKey);
|
||||||
|
obj.addProperty(TypeKey, UserIdTypeValue);
|
||||||
|
obj.addProperty(UserKey, lookupDataOpt.getMxid().getLocalPart());
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
if (StringUtils.equals(type, "m.id.phone")) {
|
||||||
|
// Remove deprecated login info if exists to avoid duplication
|
||||||
|
reqJsonObject.remove(ThreepidMediumKey);
|
||||||
|
reqJsonObject.remove(ThreepidAddressKey);
|
||||||
|
|
||||||
|
GsonUtil.findPrimitive(obj, "number").ifPresent(number -> {
|
||||||
|
GsonUtil.findPrimitive(obj, "country").ifPresent(country -> {
|
||||||
|
log.info("Login request with phone '{}'-'{}'", country.getAsString(), number.getAsString());
|
||||||
|
try {
|
||||||
|
PhoneNumberUtil phoneUtil = PhoneNumberUtil.getInstance();
|
||||||
|
Phonenumber.PhoneNumber phoneNumber = phoneUtil.parse(number.getAsString(), country.getAsString());
|
||||||
|
String msisdn = phoneUtil.format(phoneNumber, PhoneNumberUtil.PhoneNumberFormat.E164).replace("+", "");
|
||||||
|
String medium = "msisdn";
|
||||||
|
strategy.findLocal(medium, msisdn).ifPresent(lookupDataOpt -> {
|
||||||
|
obj.remove("country");
|
||||||
|
obj.remove("number");
|
||||||
|
obj.addProperty(TypeKey, UserIdTypeValue);
|
||||||
|
obj.addProperty(UserKey, lookupDataOpt.getMxid().getLocalPart());
|
||||||
|
});
|
||||||
|
} catch (NumberParseException e) {
|
||||||
|
log.error("Not a valid phone number");
|
||||||
|
throw new RuntimeException(e);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// invoke 'login' on homeserver
|
||||||
|
HttpPost httpPost = RestClientUtils.post(resolveProxyUrl(target), gson, reqJsonObject);
|
||||||
|
try (CloseableHttpResponse httpResponse = client.execute(httpPost)) {
|
||||||
|
// check http status
|
||||||
|
int status = httpResponse.getStatusLine().getStatusCode();
|
||||||
|
log.info("http status = {}", status);
|
||||||
|
if (status != 200) {
|
||||||
|
// try to get possible json error message from response
|
||||||
|
// otherwise just get returned plain error message
|
||||||
|
String errcode = String.valueOf(httpResponse.getStatusLine().getStatusCode());
|
||||||
|
String error = EntityUtils.toString(httpResponse.getEntity());
|
||||||
|
if (httpResponse.getEntity() != null) {
|
||||||
|
try {
|
||||||
|
JsonObject bodyJson = new JsonParser().parse(error).getAsJsonObject();
|
||||||
|
if (bodyJson.has("errcode")) {
|
||||||
|
errcode = bodyJson.get("errcode").getAsString();
|
||||||
|
}
|
||||||
|
if (bodyJson.has("error")) {
|
||||||
|
error = bodyJson.get("error").getAsString();
|
||||||
|
}
|
||||||
|
throw new RemoteLoginException(status, errcode, error, bodyJson);
|
||||||
|
} catch (JsonSyntaxException e) {
|
||||||
|
log.warn("Response body is not JSON");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
throw new RemoteLoginException(status, errcode, error);
|
||||||
|
}
|
||||||
|
|
||||||
|
// return response
|
||||||
|
HttpEntity entity = httpResponse.getEntity();
|
||||||
|
if (Objects.isNull(entity)) {
|
||||||
|
log.warn("Expected HS to return data but got nothing");
|
||||||
|
return "";
|
||||||
|
} else {
|
||||||
|
return IOUtils.toString(httpResponse.getEntity().getContent(), StandardCharsets.UTF_8);
|
||||||
|
}
|
||||||
|
} catch (IOException e) {
|
||||||
|
throw new RuntimeException(e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
42
src/main/java/io/kamax/mxisd/auth/AuthProviders.java
Normal file
42
src/main/java/io/kamax/mxisd/auth/AuthProviders.java
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
/*
|
||||||
|
* mxisd - Matrix Identity Server Daemon
|
||||||
|
* Copyright (C) 2017 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.auth;
|
||||||
|
|
||||||
|
import io.kamax.mxisd.auth.provider.AuthenticatorProvider;
|
||||||
|
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.function.Supplier;
|
||||||
|
import java.util.stream.Collectors;
|
||||||
|
|
||||||
|
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 List<? extends AuthenticatorProvider> get() {
|
||||||
|
return suppliers.stream().map(Supplier::get).collect(Collectors.toList());
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@@ -1,8 +1,8 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2017 Maxime Dor
|
* Copyright (C) 2017 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://max.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU Affero General Public License as
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
@@ -1,8 +1,8 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2017 Maxime Dor
|
* Copyright (C) 2017 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://max.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU Affero General Public License as
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
@@ -1,8 +1,8 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2017 Maxime Dor
|
* Copyright (C) 2017 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://max.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU Affero General Public License as
|
* it under the terms of the GNU Affero General Public License as
|
||||||
@@ -38,6 +38,10 @@ public class BackendAuthResult {
|
|||||||
return displayName;
|
return displayName;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public void setDisplayName(String displayName) {
|
||||||
|
this.displayName = displayName;
|
||||||
|
}
|
||||||
|
|
||||||
public Set<ThreePid> getThreePids() {
|
public Set<ThreePid> getThreePids() {
|
||||||
return threePids;
|
return threePids;
|
||||||
}
|
}
|
||||||
@@ -73,6 +77,10 @@ public class BackendAuthResult {
|
|||||||
private UserID id;
|
private UserID id;
|
||||||
private BackendAuthProfile profile = new BackendAuthProfile();
|
private BackendAuthProfile profile = new BackendAuthProfile();
|
||||||
|
|
||||||
|
public void setSuccess(boolean success) {
|
||||||
|
this.success = success;
|
||||||
|
}
|
||||||
|
|
||||||
public Boolean isSuccess() {
|
public Boolean isSuccess() {
|
||||||
return success;
|
return success;
|
||||||
}
|
}
|
||||||
@@ -81,6 +89,10 @@ public class BackendAuthResult {
|
|||||||
return id;
|
return id;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public void setId(UserID id) {
|
||||||
|
this.id = id;
|
||||||
|
}
|
||||||
|
|
||||||
public BackendAuthProfile getProfile() {
|
public BackendAuthProfile getProfile() {
|
||||||
return profile;
|
return profile;
|
||||||
}
|
}
|
||||||
|
@@ -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> {
|
||||||
|
|
||||||
|
}
|
@@ -1,8 +1,8 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2017 Maxime Dor
|
* Copyright (C) 2018 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://max.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU Affero General Public License as
|
* it under the terms of the GNU Affero General Public License as
|
||||||
@@ -18,16 +18,20 @@
|
|||||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package io.kamax.mxisd;
|
package io.kamax.mxisd.backend.exec;
|
||||||
|
|
||||||
import org.springframework.boot.SpringApplication;
|
import io.kamax.mxisd.auth.provider.BackendAuthResult;
|
||||||
import org.springframework.boot.autoconfigure.SpringBootApplication;
|
|
||||||
|
|
||||||
@SpringBootApplication
|
public class ExecAuthResult extends BackendAuthResult {
|
||||||
public class MatrixIdentityServerApplication {
|
|
||||||
|
|
||||||
public static void main(String[] args) {
|
private int exitStatus;
|
||||||
SpringApplication.run(MatrixIdentityServerApplication.class, args);
|
|
||||||
|
public int getExitStatus() {
|
||||||
|
return exitStatus;
|
||||||
|
}
|
||||||
|
|
||||||
|
public void setExitStatus(int exitStatus) {
|
||||||
|
this.exitStatus = exitStatus;
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
125
src/main/java/io/kamax/mxisd/backend/exec/ExecAuthStore.java
Normal file
125
src/main/java/io/kamax/mxisd/backend/exec/ExecAuthStore.java
Normal file
@@ -0,0 +1,125 @@
|
|||||||
|
/*
|
||||||
|
* 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 com.google.gson.JsonObject;
|
||||||
|
import com.google.gson.JsonPrimitive;
|
||||||
|
import io.kamax.matrix._MatrixID;
|
||||||
|
import io.kamax.matrix.json.GsonUtil;
|
||||||
|
import io.kamax.mxisd.UserID;
|
||||||
|
import io.kamax.mxisd.UserIdType;
|
||||||
|
import io.kamax.mxisd.auth.provider.AuthenticatorProvider;
|
||||||
|
import io.kamax.mxisd.backend.rest.RestAuthRequestJson;
|
||||||
|
import io.kamax.mxisd.config.ExecConfig;
|
||||||
|
import io.kamax.mxisd.exception.InternalServerError;
|
||||||
|
import org.apache.commons.lang3.StringUtils;
|
||||||
|
import org.slf4j.Logger;
|
||||||
|
import org.slf4j.LoggerFactory;
|
||||||
|
|
||||||
|
import java.util.Objects;
|
||||||
|
import java.util.Optional;
|
||||||
|
|
||||||
|
public class ExecAuthStore extends ExecStore implements AuthenticatorProvider {
|
||||||
|
|
||||||
|
private transient final Logger log = LoggerFactory.getLogger(ExecAuthStore.class);
|
||||||
|
|
||||||
|
private ExecConfig.Auth cfg;
|
||||||
|
|
||||||
|
public ExecAuthStore(ExecConfig cfg) {
|
||||||
|
this.cfg = Objects.requireNonNull(cfg.getAuth());
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public boolean isEnabled() {
|
||||||
|
return cfg.isEnabled();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public ExecAuthResult authenticate(_MatrixID uId, String password) {
|
||||||
|
Objects.requireNonNull(uId);
|
||||||
|
Objects.requireNonNull(password);
|
||||||
|
|
||||||
|
log.info("Performing authentication for {}", uId.getId());
|
||||||
|
|
||||||
|
ExecAuthResult result = new ExecAuthResult();
|
||||||
|
result.setId(new UserID(UserIdType.Localpart, uId.getLocalPart()));
|
||||||
|
|
||||||
|
Processor<ExecAuthResult> p = new Processor<>(cfg);
|
||||||
|
|
||||||
|
p.addTokenMapper(cfg.getToken().getLocalpart(), uId::getLocalPart);
|
||||||
|
p.addTokenMapper(cfg.getToken().getDomain(), uId::getDomain);
|
||||||
|
p.addTokenMapper(cfg.getToken().getMxid(), uId::getId);
|
||||||
|
p.addTokenMapper(cfg.getToken().getPassword(), () -> password);
|
||||||
|
|
||||||
|
p.addJsonInputTemplate(tokens -> {
|
||||||
|
RestAuthRequestJson json = new RestAuthRequestJson();
|
||||||
|
json.setLocalpart(tokens.getLocalpart());
|
||||||
|
json.setDomain(tokens.getDomain());
|
||||||
|
json.setMxid(tokens.getMxid());
|
||||||
|
json.setPassword(tokens.getPassword());
|
||||||
|
return json;
|
||||||
|
});
|
||||||
|
p.addInputTemplate(PlainType, tokens -> tokens.getLocalpart() + System.lineSeparator() +
|
||||||
|
tokens.getDomain() + System.lineSeparator() +
|
||||||
|
tokens.getMxid() + System.lineSeparator() +
|
||||||
|
tokens.getPassword() + System.lineSeparator()
|
||||||
|
);
|
||||||
|
|
||||||
|
p.withExitHandler(pr -> result.setExitStatus(pr.getExitValue()));
|
||||||
|
|
||||||
|
p.withSuccessHandler(pr -> result.setSuccess(true));
|
||||||
|
p.withSuccessDefault(o -> result);
|
||||||
|
p.addSuccessMapper(JsonType, output -> {
|
||||||
|
JsonObject data = GsonUtil.getObj(GsonUtil.parseObj(output), "auth");
|
||||||
|
GsonUtil.findPrimitive(data, "success")
|
||||||
|
.map(JsonPrimitive::getAsBoolean)
|
||||||
|
.ifPresent(result::setSuccess);
|
||||||
|
GsonUtil.findObj(data, "profile")
|
||||||
|
.flatMap(profile -> GsonUtil.findString(profile, "display_name"))
|
||||||
|
.ifPresent(v -> result.getProfile().setDisplayName(v));
|
||||||
|
|
||||||
|
return result;
|
||||||
|
});
|
||||||
|
p.addSuccessMapper(PlainType, output -> {
|
||||||
|
String[] lines = output.split("\\R");
|
||||||
|
if (lines.length > 2) {
|
||||||
|
throw new InternalServerError("Exec auth command returned more than 2 lines (" + lines.length + ")");
|
||||||
|
}
|
||||||
|
|
||||||
|
result.setSuccess(Optional.ofNullable(StringUtils.isEmpty(lines[0]) ? null : lines[0])
|
||||||
|
.map(v -> StringUtils.equalsAnyIgnoreCase(v, "true", "1"))
|
||||||
|
.orElse(result.isSuccess()));
|
||||||
|
|
||||||
|
if (lines.length == 2) {
|
||||||
|
Optional.ofNullable(StringUtils.isEmpty(lines[1]) ? null : lines[1])
|
||||||
|
.ifPresent(v -> result.getProfile().setDisplayName(v));
|
||||||
|
}
|
||||||
|
|
||||||
|
return result;
|
||||||
|
});
|
||||||
|
|
||||||
|
p.withFailureHandler(pr -> result.setSuccess(false));
|
||||||
|
p.withFailureDefault(o -> result);
|
||||||
|
|
||||||
|
return p.execute();
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@@ -0,0 +1,86 @@
|
|||||||
|
/*
|
||||||
|
* 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.matrix.MatrixID;
|
||||||
|
import io.kamax.matrix.json.GsonUtil;
|
||||||
|
import io.kamax.mxisd.config.ExecConfig;
|
||||||
|
import io.kamax.mxisd.config.MatrixConfig;
|
||||||
|
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;
|
||||||
|
|
||||||
|
public class ExecDirectoryStore extends ExecStore implements DirectoryProvider {
|
||||||
|
|
||||||
|
private ExecConfig.Directory cfg;
|
||||||
|
private MatrixConfig mxCfg;
|
||||||
|
|
||||||
|
public ExecDirectoryStore(MxisdConfig cfg) {
|
||||||
|
this(cfg.getExec().getDirectory(), cfg.getMatrix());
|
||||||
|
}
|
||||||
|
|
||||||
|
public ExecDirectoryStore(ExecConfig.Directory cfg, MatrixConfig mxCfg) {
|
||||||
|
this.cfg = cfg;
|
||||||
|
this.mxCfg = mxCfg;
|
||||||
|
}
|
||||||
|
|
||||||
|
private UserDirectorySearchResult search(ExecConfig.Process cfg, UserDirectorySearchRequest request) {
|
||||||
|
if (StringUtils.isEmpty(cfg.getCommand())) {
|
||||||
|
return UserDirectorySearchResult.empty();
|
||||||
|
}
|
||||||
|
|
||||||
|
Processor<UserDirectorySearchResult> p = new Processor<>(cfg);
|
||||||
|
|
||||||
|
p.addJsonInputTemplate(tokens -> new UserDirectorySearchRequest(tokens.getType(), tokens.getQuery()));
|
||||||
|
p.addInputTemplate(PlainType, tokens -> tokens.getType() + System.lineSeparator() + tokens.getQuery());
|
||||||
|
|
||||||
|
p.addTokenMapper(cfg.getToken().getType(), request::getBy);
|
||||||
|
p.addTokenMapper(cfg.getToken().getQuery(), request::getSearchTerm);
|
||||||
|
|
||||||
|
p.addSuccessMapper(JsonType, output -> {
|
||||||
|
if (StringUtils.isBlank(output)) {
|
||||||
|
return UserDirectorySearchResult.empty();
|
||||||
|
}
|
||||||
|
|
||||||
|
UserDirectorySearchResult response = GsonUtil.get().fromJson(output, UserDirectorySearchResult.class);
|
||||||
|
for (UserDirectorySearchResult.Result result : response.getResults()) {
|
||||||
|
result.setUserId(MatrixID.asAcceptable(result.getUserId(), mxCfg.getDomain()).getId());
|
||||||
|
}
|
||||||
|
return response;
|
||||||
|
});
|
||||||
|
p.withFailureDefault(output -> new UserDirectorySearchResult());
|
||||||
|
|
||||||
|
return p.execute();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public UserDirectorySearchResult searchByDisplayName(String query) {
|
||||||
|
return search(cfg.getSearch().getByName(), new UserDirectorySearchRequest("name", query));
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public UserDirectorySearchResult searchBy3pid(String query) {
|
||||||
|
return search(cfg.getSearch().getByName(), new UserDirectorySearchRequest("threepid", query));
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
200
src/main/java/io/kamax/mxisd/backend/exec/ExecIdentityStore.java
Normal file
200
src/main/java/io/kamax/mxisd/backend/exec/ExecIdentityStore.java
Normal file
@@ -0,0 +1,200 @@
|
|||||||
|
/*
|
||||||
|
* 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 com.google.gson.JsonArray;
|
||||||
|
import com.google.gson.JsonParseException;
|
||||||
|
import io.kamax.matrix.MatrixID;
|
||||||
|
import io.kamax.matrix.ThreePid;
|
||||||
|
import io.kamax.matrix._MatrixID;
|
||||||
|
import io.kamax.matrix.json.GsonUtil;
|
||||||
|
import io.kamax.mxisd.UserID;
|
||||||
|
import io.kamax.mxisd.UserIdType;
|
||||||
|
import io.kamax.mxisd.backend.rest.LookupBulkResponseJson;
|
||||||
|
import io.kamax.mxisd.backend.rest.LookupSingleResponseJson;
|
||||||
|
import io.kamax.mxisd.config.ExecConfig;
|
||||||
|
import io.kamax.mxisd.config.MatrixConfig;
|
||||||
|
import io.kamax.mxisd.exception.InternalServerError;
|
||||||
|
import io.kamax.mxisd.lookup.SingleLookupReply;
|
||||||
|
import io.kamax.mxisd.lookup.SingleLookupRequest;
|
||||||
|
import io.kamax.mxisd.lookup.ThreePidMapping;
|
||||||
|
import io.kamax.mxisd.lookup.provider.IThreePidProvider;
|
||||||
|
import org.apache.commons.lang3.StringUtils;
|
||||||
|
import org.slf4j.Logger;
|
||||||
|
import org.slf4j.LoggerFactory;
|
||||||
|
|
||||||
|
import java.util.Collections;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.Objects;
|
||||||
|
import java.util.Optional;
|
||||||
|
import java.util.stream.Collectors;
|
||||||
|
|
||||||
|
public class ExecIdentityStore extends ExecStore implements IThreePidProvider {
|
||||||
|
|
||||||
|
private transient final Logger log = LoggerFactory.getLogger(ExecIdentityStore.class);
|
||||||
|
|
||||||
|
private final ExecConfig.Identity cfg;
|
||||||
|
private final MatrixConfig mxCfg;
|
||||||
|
|
||||||
|
public ExecIdentityStore(ExecConfig cfg, MatrixConfig mxCfg) {
|
||||||
|
this(cfg.getIdentity(), mxCfg);
|
||||||
|
}
|
||||||
|
|
||||||
|
public ExecIdentityStore(ExecConfig.Identity cfg, MatrixConfig mxCfg) {
|
||||||
|
this.cfg = cfg;
|
||||||
|
this.mxCfg = mxCfg;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public boolean isLocal() {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public int getPriority() {
|
||||||
|
return cfg.getPriority();
|
||||||
|
}
|
||||||
|
|
||||||
|
private ExecConfig.Process getSingleCfg() {
|
||||||
|
return cfg.getLookup().getSingle();
|
||||||
|
}
|
||||||
|
|
||||||
|
private _MatrixID getUserId(UserID id) {
|
||||||
|
if (Objects.isNull(id)) {
|
||||||
|
throw new JsonParseException("User id key is not present");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (UserIdType.Localpart.is(id.getType())) {
|
||||||
|
return MatrixID.asAcceptable(id.getValue(), mxCfg.getDomain());
|
||||||
|
}
|
||||||
|
|
||||||
|
if (UserIdType.MatrixID.is(id.getType())) {
|
||||||
|
return MatrixID.asAcceptable(id.getValue());
|
||||||
|
}
|
||||||
|
|
||||||
|
throw new InternalServerError("Unknown user type: " + id.getType());
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public Optional<SingleLookupReply> find(SingleLookupRequest request) {
|
||||||
|
Processor<Optional<SingleLookupReply>> p = new Processor<>();
|
||||||
|
p.withConfig(cfg.getLookup().getSingle());
|
||||||
|
|
||||||
|
p.addTokenMapper(getSingleCfg().getToken().getMedium(), request::getType);
|
||||||
|
p.addTokenMapper(getSingleCfg().getToken().getAddress(), request::getThreePid);
|
||||||
|
|
||||||
|
p.addJsonInputTemplate(tokens -> new ThreePid(tokens.getMedium(), tokens.getAddress()));
|
||||||
|
p.addInputTemplate(PlainType, tokens -> tokens.getMedium()
|
||||||
|
+ System.lineSeparator()
|
||||||
|
+ tokens.getAddress()
|
||||||
|
);
|
||||||
|
|
||||||
|
p.addSuccessMapper(JsonType, output -> {
|
||||||
|
if (StringUtils.isBlank(output)) {
|
||||||
|
return Optional.empty();
|
||||||
|
}
|
||||||
|
|
||||||
|
return GsonUtil.findObj(GsonUtil.parseObj(output), "lookup")
|
||||||
|
.filter(obj -> !obj.entrySet().isEmpty())
|
||||||
|
.map(json -> GsonUtil.get().fromJson(json, LookupSingleResponseJson.class))
|
||||||
|
.map(lookup -> getUserId(lookup.getId()))
|
||||||
|
.map(mxId -> new SingleLookupReply(request, mxId));
|
||||||
|
});
|
||||||
|
|
||||||
|
p.addSuccessMapper(PlainType, output -> {
|
||||||
|
String[] lines = output.split("\\R");
|
||||||
|
if (lines.length > 2) {
|
||||||
|
throw new InternalServerError("Exec auth command returned more than 2 lines (" + lines.length + ")");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (lines.length == 1 && StringUtils.isBlank(lines[0])) {
|
||||||
|
return Optional.empty();
|
||||||
|
}
|
||||||
|
|
||||||
|
String type = StringUtils.trimToEmpty(lines.length == 1 ? UserIdType.Localpart.getId() : lines[0]);
|
||||||
|
String value = StringUtils.trimToEmpty(lines.length == 2 ? lines[1] : lines[0]);
|
||||||
|
|
||||||
|
if (UserIdType.Localpart.is(type)) {
|
||||||
|
return Optional.of(new SingleLookupReply(request, MatrixID.asAcceptable(value, mxCfg.getDomain())));
|
||||||
|
}
|
||||||
|
|
||||||
|
if (UserIdType.MatrixID.is(type)) {
|
||||||
|
return Optional.of(new SingleLookupReply(request, MatrixID.asAcceptable(value)));
|
||||||
|
}
|
||||||
|
|
||||||
|
throw new InternalServerError("Invalid user type: " + type);
|
||||||
|
});
|
||||||
|
|
||||||
|
p.withFailureDefault(o -> Optional.empty());
|
||||||
|
|
||||||
|
return p.execute();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public List<ThreePidMapping> populate(List<ThreePidMapping> mappings) {
|
||||||
|
Processor<List<ThreePidMapping>> p = new Processor<>();
|
||||||
|
p.withConfig(cfg.getLookup().getBulk());
|
||||||
|
|
||||||
|
p.addInput(JsonType, () -> {
|
||||||
|
JsonArray tpids = GsonUtil.asArray(mappings.stream()
|
||||||
|
.map(mapping -> GsonUtil.get().toJsonTree(new ThreePid(mapping.getMedium(), mapping.getValue())))
|
||||||
|
.collect(Collectors.toList()));
|
||||||
|
return GsonUtil.get().toJson(GsonUtil.makeObj("lookup", tpids));
|
||||||
|
});
|
||||||
|
p.addInput(PlainType, () -> {
|
||||||
|
StringBuilder input = new StringBuilder();
|
||||||
|
for (ThreePidMapping mapping : mappings) {
|
||||||
|
input.append(mapping.getMedium()).append("\t").append(mapping.getValue()).append(System.lineSeparator());
|
||||||
|
}
|
||||||
|
return input.toString();
|
||||||
|
});
|
||||||
|
|
||||||
|
p.addSuccessMapper(JsonType, output -> {
|
||||||
|
if (StringUtils.isBlank(output)) {
|
||||||
|
return Collections.emptyList();
|
||||||
|
}
|
||||||
|
|
||||||
|
LookupBulkResponseJson response = GsonUtil.get().fromJson(output, LookupBulkResponseJson.class);
|
||||||
|
return response.getLookup().stream().map(item -> {
|
||||||
|
ThreePidMapping mapping = new ThreePidMapping();
|
||||||
|
mapping.setMedium(item.getMedium());
|
||||||
|
mapping.setValue(item.getAddress());
|
||||||
|
|
||||||
|
if (UserIdType.Localpart.is(item.getId().getType())) {
|
||||||
|
mapping.setValue(MatrixID.asAcceptable(item.getId().getValue(), mxCfg.getDomain()).getId());
|
||||||
|
return mapping;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (UserIdType.MatrixID.is(item.getId().getType())) {
|
||||||
|
mapping.setValue(MatrixID.asAcceptable(item.getId().getValue()).getId());
|
||||||
|
return mapping;
|
||||||
|
}
|
||||||
|
|
||||||
|
throw new InternalServerError("Invalid user type: " + item.getId().getType());
|
||||||
|
}).collect(Collectors.toList());
|
||||||
|
});
|
||||||
|
|
||||||
|
p.withFailureDefault(output -> Collections.emptyList());
|
||||||
|
|
||||||
|
return p.execute();
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@@ -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()));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@@ -0,0 +1,94 @@
|
|||||||
|
/*
|
||||||
|
* 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.matrix._MatrixID;
|
||||||
|
import io.kamax.matrix._ThreePid;
|
||||||
|
import io.kamax.matrix.json.GsonUtil;
|
||||||
|
import io.kamax.mxisd.config.ExecConfig;
|
||||||
|
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 java.util.Collections;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.Optional;
|
||||||
|
|
||||||
|
public class ExecProfileStore extends ExecStore implements ProfileProvider {
|
||||||
|
|
||||||
|
private ExecConfig.Profile cfg;
|
||||||
|
|
||||||
|
public ExecProfileStore(ExecConfig cfg) {
|
||||||
|
this(cfg.getProfile());
|
||||||
|
}
|
||||||
|
|
||||||
|
public ExecProfileStore(ExecConfig.Profile cfg) {
|
||||||
|
this.cfg = cfg;
|
||||||
|
}
|
||||||
|
|
||||||
|
private Optional<JsonProfileResult> getFull(_MatrixID userId, ExecConfig.Process cfg) {
|
||||||
|
Processor<Optional<JsonProfileResult>> p = new Processor<>(cfg);
|
||||||
|
|
||||||
|
p.addJsonInputTemplate(tokens -> new JsonProfileRequest(tokens.getLocalpart(), tokens.getDomain(), tokens.getMxid()));
|
||||||
|
p.addInputTemplate(PlainType, tokens -> tokens.getLocalpart() + System.lineSeparator()
|
||||||
|
+ tokens.getDomain() + System.lineSeparator()
|
||||||
|
+ tokens.getMxid() + System.lineSeparator()
|
||||||
|
);
|
||||||
|
|
||||||
|
p.addTokenMapper(cfg.getToken().getLocalpart(), userId::getLocalPart);
|
||||||
|
p.addTokenMapper(cfg.getToken().getDomain(), userId::getDomain);
|
||||||
|
p.addTokenMapper(cfg.getToken().getMxid(), userId::getId);
|
||||||
|
|
||||||
|
p.withFailureDefault(v -> Optional.empty());
|
||||||
|
|
||||||
|
p.addSuccessMapper(JsonType, output -> {
|
||||||
|
if (StringUtils.isBlank(output)) {
|
||||||
|
return Optional.empty();
|
||||||
|
}
|
||||||
|
|
||||||
|
return GsonUtil.findObj(GsonUtil.parseObj(output), "profile")
|
||||||
|
.map(obj -> GsonUtil.get().fromJson(obj, JsonProfileResult.class));
|
||||||
|
});
|
||||||
|
|
||||||
|
return p.execute();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public Optional<String> getDisplayName(_MatrixID userId) {
|
||||||
|
return getFull(userId, cfg.getDisplayName()).map(JsonProfileResult::getDisplayName);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public List<_ThreePid> getThreepids(_MatrixID userId) {
|
||||||
|
return getFull(userId, cfg.getThreePid())
|
||||||
|
.map(p -> Collections.<_ThreePid>unmodifiableList(p.getThreepids()))
|
||||||
|
.orElseGet(Collections::emptyList);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public List<String> getRoles(_MatrixID userId) {
|
||||||
|
return getFull(userId, cfg.getRole())
|
||||||
|
.map(JsonProfileResult::getRoles)
|
||||||
|
.orElseGet(Collections::emptyList);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
252
src/main/java/io/kamax/mxisd/backend/exec/ExecStore.java
Normal file
252
src/main/java/io/kamax/mxisd/backend/exec/ExecStore.java
Normal file
@@ -0,0 +1,252 @@
|
|||||||
|
/*
|
||||||
|
* 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.matrix.json.GsonUtil;
|
||||||
|
import io.kamax.mxisd.config.ExecConfig;
|
||||||
|
import io.kamax.mxisd.exception.InternalServerError;
|
||||||
|
import org.apache.commons.io.IOUtils;
|
||||||
|
import org.slf4j.Logger;
|
||||||
|
import org.slf4j.LoggerFactory;
|
||||||
|
import org.zeroturnaround.exec.ProcessExecutor;
|
||||||
|
import org.zeroturnaround.exec.ProcessResult;
|
||||||
|
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.nio.charset.StandardCharsets;
|
||||||
|
import java.util.*;
|
||||||
|
import java.util.concurrent.TimeoutException;
|
||||||
|
import java.util.function.Consumer;
|
||||||
|
import java.util.function.Function;
|
||||||
|
import java.util.function.Supplier;
|
||||||
|
import java.util.stream.Collectors;
|
||||||
|
|
||||||
|
public class ExecStore {
|
||||||
|
|
||||||
|
public static final String JsonType = "json";
|
||||||
|
public static final String PlainType = "plain";
|
||||||
|
|
||||||
|
protected static String toJson(Object o) {
|
||||||
|
return GsonUtil.get().toJson(o);
|
||||||
|
}
|
||||||
|
|
||||||
|
private transient final Logger log = LoggerFactory.getLogger(ExecStore.class);
|
||||||
|
|
||||||
|
private Supplier<ProcessExecutor> executorSupplier = () -> new ProcessExecutor().readOutput(true);
|
||||||
|
|
||||||
|
public void setExecutorSupplier(Supplier<ProcessExecutor> supplier) {
|
||||||
|
executorSupplier = supplier;
|
||||||
|
}
|
||||||
|
|
||||||
|
public class Processor<V> {
|
||||||
|
|
||||||
|
private ExecConfig.Process cfg;
|
||||||
|
|
||||||
|
private Supplier<Optional<String>> inputSupplier;
|
||||||
|
private Function<String, String> inputTypeMapper;
|
||||||
|
private Function<String, String> inputUnknownTypeMapper;
|
||||||
|
private Map<String, Supplier<String>> inputTypeSuppliers;
|
||||||
|
|
||||||
|
private Map<String, Function<ExecConfig.TokenOverride, String>> inputTypeTemplates;
|
||||||
|
private Supplier<String> inputTypeNoTemplateHandler;
|
||||||
|
private Map<String, Supplier<String>> tokenMappers;
|
||||||
|
private Function<String, String> tokenHandler;
|
||||||
|
|
||||||
|
private Consumer<ProcessResult> onExitHandler;
|
||||||
|
private Consumer<ProcessResult> successHandler;
|
||||||
|
private Map<String, Function<String, V>> successMappers;
|
||||||
|
private Function<String, V> successDefault;
|
||||||
|
private Consumer<ProcessResult> failureHandler;
|
||||||
|
private Map<String, Function<String, V>> failureMappers;
|
||||||
|
private Function<String, V> failureDefault;
|
||||||
|
private Consumer<ProcessResult> unknownHandler;
|
||||||
|
private Map<String, Function<String, V>> unknownMappers;
|
||||||
|
private Function<String, V> unknownDefault;
|
||||||
|
|
||||||
|
public Processor(ExecConfig.Process cfg) {
|
||||||
|
this();
|
||||||
|
withConfig(cfg);
|
||||||
|
}
|
||||||
|
|
||||||
|
public Processor() {
|
||||||
|
tokenMappers = new HashMap<>();
|
||||||
|
inputTypeSuppliers = new HashMap<>();
|
||||||
|
inputTypeTemplates = new HashMap<>();
|
||||||
|
|
||||||
|
withTokenHandler(tokenHandler = input -> {
|
||||||
|
for (Map.Entry<String, Supplier<String>> entry : tokenMappers.entrySet()) {
|
||||||
|
input = input.replace(entry.getKey(), entry.getValue().get());
|
||||||
|
}
|
||||||
|
return input;
|
||||||
|
});
|
||||||
|
|
||||||
|
inputTypeNoTemplateHandler = () -> cfg.getInput().getType()
|
||||||
|
.map(type -> inputTypeTemplates.get(type).apply(cfg.getToken()))
|
||||||
|
.orElse("");
|
||||||
|
|
||||||
|
inputUnknownTypeMapper = type -> tokenHandler.apply(cfg.getInput().getTemplate().orElseGet(inputTypeNoTemplateHandler));
|
||||||
|
|
||||||
|
inputTypeMapper = type -> {
|
||||||
|
if (!inputTypeSuppliers.containsKey(type)) {
|
||||||
|
return inputUnknownTypeMapper.apply(type);
|
||||||
|
}
|
||||||
|
|
||||||
|
return inputTypeSuppliers.get(type).get();
|
||||||
|
};
|
||||||
|
|
||||||
|
inputSupplier = () -> cfg.getInput().getType().map(type -> inputTypeMapper.apply(type));
|
||||||
|
|
||||||
|
withExitHandler(pr -> {
|
||||||
|
});
|
||||||
|
|
||||||
|
successHandler = pr -> {
|
||||||
|
};
|
||||||
|
successMappers = new HashMap<>();
|
||||||
|
successDefault = output -> {
|
||||||
|
log.info("{} stdout: {}{}", cfg.getCommand(), System.lineSeparator(), output);
|
||||||
|
throw new InternalServerError("Exec command has no success handler configured. This is a bug. Please report.");
|
||||||
|
};
|
||||||
|
|
||||||
|
failureHandler = pr -> {
|
||||||
|
};
|
||||||
|
failureMappers = new HashMap<>();
|
||||||
|
failureDefault = output -> {
|
||||||
|
log.info("{} stdout: {}{}", cfg.getCommand(), System.lineSeparator(), output);
|
||||||
|
throw new InternalServerError("Exec command has no failure handler configured. This is a bug. Please report.");
|
||||||
|
};
|
||||||
|
|
||||||
|
unknownHandler = pr -> log.warn("Unexpected exit status: {}", pr.getExitValue());
|
||||||
|
unknownMappers = new HashMap<>();
|
||||||
|
withUnknownDefault(output -> {
|
||||||
|
log.error("{} stdout:{}{}", cfg.getCommand(), System.lineSeparator(), output);
|
||||||
|
throw new InternalServerError("Exec command returned with unexpected exit status");
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
public void withConfig(ExecConfig.Process cfg) {
|
||||||
|
this.cfg = cfg;
|
||||||
|
}
|
||||||
|
|
||||||
|
public void addTokenMapper(String token, Supplier<String> data) {
|
||||||
|
tokenMappers.put(token, data);
|
||||||
|
}
|
||||||
|
|
||||||
|
public void withTokenHandler(Function<String, String> handler) {
|
||||||
|
tokenHandler = handler;
|
||||||
|
}
|
||||||
|
|
||||||
|
public void addInput(String type, Supplier<String> handler) {
|
||||||
|
inputTypeSuppliers.put(type, handler);
|
||||||
|
}
|
||||||
|
|
||||||
|
protected void addInputTemplate(String type, Function<ExecConfig.TokenOverride, String> template) {
|
||||||
|
inputTypeTemplates.put(type, template);
|
||||||
|
}
|
||||||
|
|
||||||
|
public void addJsonInputTemplate(Function<ExecConfig.TokenOverride, Object> template) {
|
||||||
|
inputTypeTemplates.put(JsonType, token -> GsonUtil.get().toJson(template.apply(token)));
|
||||||
|
}
|
||||||
|
|
||||||
|
public void withExitHandler(Consumer<ProcessResult> handler) {
|
||||||
|
onExitHandler = handler;
|
||||||
|
}
|
||||||
|
|
||||||
|
public void withSuccessHandler(Consumer<ProcessResult> handler) {
|
||||||
|
successHandler = handler;
|
||||||
|
}
|
||||||
|
|
||||||
|
public void addSuccessMapper(String type, Function<String, V> mapper) {
|
||||||
|
successMappers.put(type, mapper);
|
||||||
|
}
|
||||||
|
|
||||||
|
public void withSuccessDefault(Function<String, V> mapper) {
|
||||||
|
successDefault = mapper;
|
||||||
|
}
|
||||||
|
|
||||||
|
public void withFailureHandler(Consumer<ProcessResult> handler) {
|
||||||
|
failureHandler = handler;
|
||||||
|
}
|
||||||
|
|
||||||
|
public void addFailureMapper(String type, Function<String, V> mapper) {
|
||||||
|
failureMappers.put(type, mapper);
|
||||||
|
}
|
||||||
|
|
||||||
|
public void withFailureDefault(Function<String, V> mapper) {
|
||||||
|
failureDefault = mapper;
|
||||||
|
}
|
||||||
|
|
||||||
|
public void addUnknownMapper(String type, Function<String, V> mapper) {
|
||||||
|
unknownMappers.put(type, mapper);
|
||||||
|
}
|
||||||
|
|
||||||
|
public void withUnknownDefault(Function<String, V> mapper) {
|
||||||
|
unknownDefault = mapper;
|
||||||
|
}
|
||||||
|
|
||||||
|
public V execute() {
|
||||||
|
log.info("Executing {}", cfg.getCommand());
|
||||||
|
|
||||||
|
try {
|
||||||
|
ProcessExecutor psExec = executorSupplier.get();
|
||||||
|
|
||||||
|
List<String> args = new ArrayList<>();
|
||||||
|
args.add(tokenHandler.apply(cfg.getCommand()));
|
||||||
|
args.addAll(cfg.getArgs().stream().map(arg -> tokenHandler.apply(arg)).collect(Collectors.toList()));
|
||||||
|
psExec.command(args);
|
||||||
|
|
||||||
|
psExec.environment(new HashMap<>(cfg.getEnv()).entrySet().stream()
|
||||||
|
.peek(e -> e.setValue(tokenHandler.apply(e.getValue())))
|
||||||
|
.collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue)));
|
||||||
|
|
||||||
|
inputSupplier.get().ifPresent(input -> psExec.redirectInput(IOUtils.toInputStream(input, StandardCharsets.UTF_8)));
|
||||||
|
|
||||||
|
ProcessResult psResult = psExec.execute();
|
||||||
|
String output = psResult.outputUTF8();
|
||||||
|
onExitHandler.accept(psResult);
|
||||||
|
|
||||||
|
if (cfg.getExit().getSuccess().contains(psResult.getExitValue())) {
|
||||||
|
successHandler.accept(psResult);
|
||||||
|
|
||||||
|
return cfg.getOutput().getType()
|
||||||
|
.map(type -> successMappers.getOrDefault(type, successDefault).apply(output))
|
||||||
|
.orElseGet(() -> successDefault.apply(output));
|
||||||
|
} else if (cfg.getExit().getFailure().contains(psResult.getExitValue())) {
|
||||||
|
failureHandler.accept(psResult);
|
||||||
|
|
||||||
|
return cfg.getOutput().getType()
|
||||||
|
.map(type -> failureMappers.getOrDefault(type, failureDefault).apply(output))
|
||||||
|
.orElseGet(() -> failureDefault.apply(output));
|
||||||
|
} else {
|
||||||
|
unknownHandler.accept(psResult);
|
||||||
|
|
||||||
|
return cfg.getOutput().getType()
|
||||||
|
.map(type -> unknownMappers.getOrDefault(type, unknownDefault).apply(output))
|
||||||
|
.orElseGet(() -> unknownDefault.apply(output));
|
||||||
|
}
|
||||||
|
} catch (RuntimeException | IOException | InterruptedException | TimeoutException e) {
|
||||||
|
log.error("Failed to execute {}", cfg.getCommand());
|
||||||
|
log.debug("Internal exception:", e);
|
||||||
|
throw new InternalServerError(e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@@ -1,8 +1,8 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2017 Maxime Dor
|
* Copyright (C) 2017 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://max.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU Affero General Public License as
|
* it under the terms of the GNU Affero General Public License as
|
||||||
@@ -29,6 +29,7 @@ import io.kamax.matrix._MatrixID;
|
|||||||
import io.kamax.mxisd.UserIdType;
|
import io.kamax.mxisd.UserIdType;
|
||||||
import io.kamax.mxisd.auth.provider.AuthenticatorProvider;
|
import io.kamax.mxisd.auth.provider.AuthenticatorProvider;
|
||||||
import io.kamax.mxisd.auth.provider.BackendAuthResult;
|
import io.kamax.mxisd.auth.provider.BackendAuthResult;
|
||||||
|
import io.kamax.mxisd.config.FirebaseConfig;
|
||||||
import org.apache.commons.lang.StringUtils;
|
import org.apache.commons.lang.StringUtils;
|
||||||
import org.slf4j.Logger;
|
import org.slf4j.Logger;
|
||||||
import org.slf4j.LoggerFactory;
|
import org.slf4j.LoggerFactory;
|
||||||
@@ -38,10 +39,14 @@ import java.util.concurrent.TimeUnit;
|
|||||||
|
|
||||||
public class GoogleFirebaseAuthenticator extends GoogleFirebaseBackend implements AuthenticatorProvider {
|
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();
|
private PhoneNumberUtil phoneUtil = PhoneNumberUtil.getInstance();
|
||||||
|
|
||||||
|
public GoogleFirebaseAuthenticator(FirebaseConfig cfg) {
|
||||||
|
this(cfg.isEnabled(), cfg.getCredentials(), cfg.getDatabase());
|
||||||
|
}
|
||||||
|
|
||||||
public GoogleFirebaseAuthenticator(boolean isEnabled, String credsPath, String db) {
|
public GoogleFirebaseAuthenticator(boolean isEnabled, String credsPath, String db) {
|
||||||
super(isEnabled, "AuthenticationProvider", credsPath, db);
|
super(isEnabled, "AuthenticationProvider", credsPath, db);
|
||||||
}
|
}
|
||||||
|
@@ -1,8 +1,8 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2017 Maxime Dor
|
* Copyright (C) 2017 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://max.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU Affero General Public License as
|
* it under the terms of the GNU Affero General Public License as
|
||||||
@@ -35,7 +35,7 @@ import java.io.IOException;
|
|||||||
|
|
||||||
public class GoogleFirebaseBackend {
|
public class GoogleFirebaseBackend {
|
||||||
|
|
||||||
private Logger log = LoggerFactory.getLogger(GoogleFirebaseBackend.class);
|
private transient final Logger log = LoggerFactory.getLogger(GoogleFirebaseBackend.class);
|
||||||
|
|
||||||
private boolean isEnabled;
|
private boolean isEnabled;
|
||||||
private FirebaseAuth fbAuth;
|
private FirebaseAuth fbAuth;
|
||||||
|
@@ -1,8 +1,8 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2017 Maxime Dor
|
* Copyright (C) 2017 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://max.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU Affero General Public License as
|
* it under the terms of the GNU Affero General Public License as
|
||||||
@@ -25,6 +25,7 @@ import com.google.firebase.tasks.OnFailureListener;
|
|||||||
import com.google.firebase.tasks.OnSuccessListener;
|
import com.google.firebase.tasks.OnSuccessListener;
|
||||||
import io.kamax.matrix.MatrixID;
|
import io.kamax.matrix.MatrixID;
|
||||||
import io.kamax.matrix.ThreePidMedium;
|
import io.kamax.matrix.ThreePidMedium;
|
||||||
|
import io.kamax.mxisd.config.MxisdConfig;
|
||||||
import io.kamax.mxisd.lookup.SingleLookupReply;
|
import io.kamax.mxisd.lookup.SingleLookupReply;
|
||||||
import io.kamax.mxisd.lookup.SingleLookupRequest;
|
import io.kamax.mxisd.lookup.SingleLookupRequest;
|
||||||
import io.kamax.mxisd.lookup.ThreePidMapping;
|
import io.kamax.mxisd.lookup.ThreePidMapping;
|
||||||
@@ -40,16 +41,20 @@ import java.util.concurrent.TimeUnit;
|
|||||||
|
|
||||||
public class GoogleFirebaseProvider extends GoogleFirebaseBackend implements IThreePidProvider {
|
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;
|
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) {
|
public GoogleFirebaseProvider(boolean isEnabled, String credsPath, String db, String domain) {
|
||||||
super(isEnabled, "ThreePidProvider", credsPath, db);
|
super(isEnabled, "ThreePidProvider", credsPath, db);
|
||||||
this.domain = domain;
|
this.domain = domain;
|
||||||
}
|
}
|
||||||
|
|
||||||
private String getMxid(UserRecord record) {
|
private String getMxid(UserRecord record) {
|
||||||
return new MatrixID(record.getUid(), domain).getId();
|
return MatrixID.asAcceptable(record.getUid(), domain).getId();
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
|
@@ -1,8 +1,8 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2017 Maxime Dor
|
* Copyright (C) 2018 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://max.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU Affero General Public License as
|
* it under the terms of the GNU Affero General Public License as
|
||||||
@@ -18,21 +18,26 @@
|
|||||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
* 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 io.kamax.mxisd.Mxisd;
|
||||||
import org.springframework.boot.diagnostics.AbstractFailureAnalyzer;
|
import io.kamax.mxisd.auth.AuthProviders;
|
||||||
import org.springframework.boot.diagnostics.FailureAnalysis;
|
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
|
@Override
|
||||||
protected FailureAnalysis analyze(Throwable rootFailure, ConfigurationException cause) {
|
public void accept(Mxisd mxisd) {
|
||||||
String message = cause.getMessage();
|
accept(mxisd.getConfig());
|
||||||
if (cause.getDetailedMessage().isPresent()) {
|
}
|
||||||
message += " - " + cause.getDetailedMessage().get();
|
|
||||||
|
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);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
@@ -1,8 +1,8 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2017 Maxime Dor
|
* Copyright (C) 2017 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://max.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU Affero General Public License as
|
* it under the terms of the GNU Affero General Public License as
|
||||||
@@ -30,6 +30,7 @@ import io.kamax.mxisd.auth.provider.AuthenticatorProvider;
|
|||||||
import io.kamax.mxisd.auth.provider.BackendAuthResult;
|
import io.kamax.mxisd.auth.provider.BackendAuthResult;
|
||||||
import io.kamax.mxisd.config.MatrixConfig;
|
import io.kamax.mxisd.config.MatrixConfig;
|
||||||
import io.kamax.mxisd.config.ldap.LdapConfig;
|
import io.kamax.mxisd.config.ldap.LdapConfig;
|
||||||
|
import io.kamax.mxisd.exception.InternalServerError;
|
||||||
import io.kamax.mxisd.util.GsonUtil;
|
import io.kamax.mxisd.util.GsonUtil;
|
||||||
import org.apache.commons.lang.StringUtils;
|
import org.apache.commons.lang.StringUtils;
|
||||||
import org.apache.directory.api.ldap.model.cursor.CursorException;
|
import org.apache.directory.api.ldap.model.cursor.CursorException;
|
||||||
@@ -42,8 +43,6 @@ import org.apache.directory.api.ldap.model.message.SearchScope;
|
|||||||
import org.apache.directory.ldap.client.api.LdapConnection;
|
import org.apache.directory.ldap.client.api.LdapConnection;
|
||||||
import org.slf4j.Logger;
|
import org.slf4j.Logger;
|
||||||
import org.slf4j.LoggerFactory;
|
import org.slf4j.LoggerFactory;
|
||||||
import org.springframework.beans.factory.annotation.Autowired;
|
|
||||||
import org.springframework.stereotype.Component;
|
|
||||||
|
|
||||||
import java.io.IOException;
|
import java.io.IOException;
|
||||||
import java.util.HashSet;
|
import java.util.HashSet;
|
||||||
@@ -51,14 +50,12 @@ import java.util.List;
|
|||||||
import java.util.Optional;
|
import java.util.Optional;
|
||||||
import java.util.Set;
|
import java.util.Set;
|
||||||
|
|
||||||
@Component
|
|
||||||
public class LdapAuthProvider extends LdapBackend implements AuthenticatorProvider {
|
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();
|
private PhoneNumberUtil phoneUtil = PhoneNumberUtil.getInstance();
|
||||||
|
|
||||||
@Autowired
|
|
||||||
public LdapAuthProvider(LdapConfig cfg, MatrixConfig mxCfg) {
|
public LdapAuthProvider(LdapConfig cfg, MatrixConfig mxCfg) {
|
||||||
super(cfg, mxCfg);
|
super(cfg, mxCfg);
|
||||||
}
|
}
|
||||||
@@ -87,7 +84,6 @@ public class LdapAuthProvider extends LdapBackend implements AuthenticatorProvid
|
|||||||
public BackendAuthResult authenticate(_MatrixID mxid, String password) {
|
public BackendAuthResult authenticate(_MatrixID mxid, String password) {
|
||||||
log.info("Performing auth for {}", mxid);
|
log.info("Performing auth for {}", mxid);
|
||||||
|
|
||||||
|
|
||||||
try (LdapConnection conn = getConn()) {
|
try (LdapConnection conn = getConn()) {
|
||||||
bind(conn);
|
bind(conn);
|
||||||
|
|
||||||
@@ -108,11 +104,13 @@ public class LdapAuthProvider extends LdapBackend implements AuthenticatorProvid
|
|||||||
String[] attArray = new String[attributes.size()];
|
String[] attArray = new String[attributes.size()];
|
||||||
attributes.toArray(attArray);
|
attributes.toArray(attArray);
|
||||||
|
|
||||||
log.debug("Base DN: {}", getBaseDn());
|
|
||||||
log.debug("Query: {}", userFilter);
|
log.debug("Query: {}", userFilter);
|
||||||
log.debug("Attributes: {}", GsonUtil.build().toJson(attArray));
|
log.debug("Attributes: {}", GsonUtil.build().toJson(attArray));
|
||||||
|
|
||||||
try (EntryCursor cursor = conn.search(getBaseDn(), userFilter, SearchScope.SUBTREE, attArray)) {
|
for (String baseDN : getBaseDNs()) {
|
||||||
|
log.debug("Base DN: {}", baseDN);
|
||||||
|
|
||||||
|
try (EntryCursor cursor = conn.search(baseDN, userFilter, SearchScope.SUBTREE, attArray)) {
|
||||||
while (cursor.next()) {
|
while (cursor.next()) {
|
||||||
Entry entry = cursor.get();
|
Entry entry = cursor.get();
|
||||||
String dn = entry.getDn().getName();
|
String dn = entry.getDn().getName();
|
||||||
@@ -159,11 +157,12 @@ public class LdapAuthProvider extends LdapBackend implements AuthenticatorProvid
|
|||||||
} catch (CursorLdapReferralException e) {
|
} catch (CursorLdapReferralException e) {
|
||||||
log.warn("Entity for {} is only available via referral, skipping", mxid);
|
log.warn("Entity for {} is only available via referral, skipping", mxid);
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
log.info("No match were found for {}", mxid);
|
log.info("No match were found for {}", mxid);
|
||||||
return BackendAuthResult.failure();
|
return BackendAuthResult.failure();
|
||||||
} catch (LdapException | IOException | CursorException e) {
|
} catch (LdapException | IOException | CursorException e) {
|
||||||
throw new RuntimeException(e);
|
throw new InternalServerError(e);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@@ -1,8 +1,8 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2017 Maxime Dor
|
* Copyright (C) 2017 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://max.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU Affero General Public License as
|
* it under the terms of the GNU Affero General Public License as
|
||||||
@@ -20,6 +20,7 @@
|
|||||||
|
|
||||||
package io.kamax.mxisd.backend.ldap;
|
package io.kamax.mxisd.backend.ldap;
|
||||||
|
|
||||||
|
import io.kamax.matrix._MatrixID;
|
||||||
import io.kamax.mxisd.config.MatrixConfig;
|
import io.kamax.mxisd.config.MatrixConfig;
|
||||||
import io.kamax.mxisd.config.ldap.LdapConfig;
|
import io.kamax.mxisd.config.ldap.LdapConfig;
|
||||||
import org.apache.commons.lang.StringUtils;
|
import org.apache.commons.lang.StringUtils;
|
||||||
@@ -44,7 +45,7 @@ public abstract class LdapBackend {
|
|||||||
public static final String UID = "uid";
|
public static final String UID = "uid";
|
||||||
public static final String MATRIX_ID = "mxid";
|
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 LdapConfig cfg;
|
||||||
private MatrixConfig mxCfg;
|
private MatrixConfig mxCfg;
|
||||||
@@ -58,8 +59,8 @@ public abstract class LdapBackend {
|
|||||||
return cfg;
|
return cfg;
|
||||||
}
|
}
|
||||||
|
|
||||||
protected String getBaseDn() {
|
protected List<String> getBaseDNs() {
|
||||||
return cfg.getConnection().getBaseDn();
|
return cfg.getConnection().getBaseDNs();
|
||||||
}
|
}
|
||||||
|
|
||||||
protected LdapConfig.Attribute getAt() {
|
protected LdapConfig.Attribute getAt() {
|
||||||
@@ -70,7 +71,7 @@ public abstract class LdapBackend {
|
|||||||
return getAt().getUid().getValue();
|
return getAt().getUid().getValue();
|
||||||
}
|
}
|
||||||
|
|
||||||
protected synchronized LdapConnection getConn() throws LdapException {
|
protected synchronized LdapConnection getConn() {
|
||||||
return new LdapNetworkConnection(cfg.getConnection().getHost(), cfg.getConnection().getPort(), cfg.getConnection().isTls());
|
return new LdapNetworkConnection(cfg.getConnection().getHost(), cfg.getConnection().getPort(), cfg.getConnection().isTls());
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -124,6 +125,17 @@ public abstract class LdapBackend {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public String buildUidFromMatrixId(_MatrixID mxId) {
|
||||||
|
String uidType = getCfg().getAttribute().getUid().getType();
|
||||||
|
if (StringUtils.equals(UID, uidType)) {
|
||||||
|
return mxId.getLocalPart();
|
||||||
|
} else if (StringUtils.equals(MATRIX_ID, uidType)) {
|
||||||
|
return mxId.getId();
|
||||||
|
} else {
|
||||||
|
throw new IllegalArgumentException("Bind type " + uidType + " is not supported");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
public Optional<String> getAttribute(Entry entry, String attName) {
|
public Optional<String> getAttribute(Entry entry, String attName) {
|
||||||
Attribute attribute = entry.get(attName);
|
Attribute attribute = entry.get(attName);
|
||||||
if (attribute == null) {
|
if (attribute == null) {
|
||||||
|
@@ -1,8 +1,8 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2017 Maxime Dor
|
* Copyright (C) 2017 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://max.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU Affero General Public License as
|
* it under the terms of the GNU Affero General Public License as
|
||||||
@@ -22,9 +22,9 @@ package io.kamax.mxisd.backend.ldap;
|
|||||||
|
|
||||||
import io.kamax.mxisd.config.MatrixConfig;
|
import io.kamax.mxisd.config.MatrixConfig;
|
||||||
import io.kamax.mxisd.config.ldap.LdapConfig;
|
import io.kamax.mxisd.config.ldap.LdapConfig;
|
||||||
import io.kamax.mxisd.controller.directory.v1.io.UserDirectorySearchResult;
|
import io.kamax.mxisd.directory.DirectoryProvider;
|
||||||
import io.kamax.mxisd.directory.IDirectoryProvider;
|
|
||||||
import io.kamax.mxisd.exception.InternalServerError;
|
import io.kamax.mxisd.exception.InternalServerError;
|
||||||
|
import io.kamax.mxisd.http.io.UserDirectorySearchResult;
|
||||||
import io.kamax.mxisd.util.GsonUtil;
|
import io.kamax.mxisd.util.GsonUtil;
|
||||||
import org.apache.directory.api.ldap.model.cursor.CursorException;
|
import org.apache.directory.api.ldap.model.cursor.CursorException;
|
||||||
import org.apache.directory.api.ldap.model.cursor.CursorLdapReferralException;
|
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.apache.directory.ldap.client.api.LdapConnection;
|
||||||
import org.slf4j.Logger;
|
import org.slf4j.Logger;
|
||||||
import org.slf4j.LoggerFactory;
|
import org.slf4j.LoggerFactory;
|
||||||
import org.springframework.beans.factory.annotation.Autowired;
|
|
||||||
import org.springframework.stereotype.Component;
|
|
||||||
|
|
||||||
import java.io.IOException;
|
import java.io.IOException;
|
||||||
import java.util.ArrayList;
|
import java.util.ArrayList;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
|
|
||||||
@Component
|
public class LdapDirectoryProvider extends LdapBackend implements DirectoryProvider {
|
||||||
public class LdapDirectoryProvider extends LdapBackend implements IDirectoryProvider {
|
|
||||||
|
|
||||||
private Logger log = LoggerFactory.getLogger(LdapDirectoryProvider.class);
|
private transient final Logger log = LoggerFactory.getLogger(LdapDirectoryProvider.class);
|
||||||
|
|
||||||
@Autowired
|
|
||||||
public LdapDirectoryProvider(LdapConfig cfg, MatrixConfig mxCfg) {
|
public LdapDirectoryProvider(LdapConfig cfg, MatrixConfig mxCfg) {
|
||||||
super(cfg, mxCfg);
|
super(cfg, mxCfg);
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
|
||||||
public boolean isEnabled() {
|
|
||||||
return getCfg().isEnabled();
|
|
||||||
}
|
|
||||||
|
|
||||||
protected UserDirectorySearchResult search(String query, List<String> attributes) {
|
protected UserDirectorySearchResult search(String query, List<String> attributes) {
|
||||||
UserDirectorySearchResult result = new UserDirectorySearchResult();
|
UserDirectorySearchResult result = new UserDirectorySearchResult();
|
||||||
result.setLimited(false);
|
result.setLimited(false);
|
||||||
@@ -65,18 +56,19 @@ public class LdapDirectoryProvider extends LdapBackend implements IDirectoryProv
|
|||||||
bind(conn);
|
bind(conn);
|
||||||
|
|
||||||
LdapConfig.Attribute atCfg = getCfg().getAttribute();
|
LdapConfig.Attribute atCfg = getCfg().getAttribute();
|
||||||
|
|
||||||
attributes = new ArrayList<>(attributes);
|
attributes = new ArrayList<>(attributes);
|
||||||
attributes.add(getUidAtt());
|
attributes.add(getUidAtt());
|
||||||
String[] attArray = new String[attributes.size()];
|
String[] attArray = new String[attributes.size()];
|
||||||
attributes.toArray(attArray);
|
attributes.toArray(attArray);
|
||||||
String searchQuery = buildOrQueryWithFilter(getCfg().getDirectory().getFilter(), "*" + query + "*", attArray);
|
String searchQuery = buildOrQueryWithFilter(getCfg().getDirectory().getFilter(), "*" + query + "*", attArray);
|
||||||
|
|
||||||
log.debug("Base DN: {}", getBaseDn());
|
|
||||||
log.debug("Query: {}", searchQuery);
|
log.debug("Query: {}", searchQuery);
|
||||||
log.debug("Attributes: {}", GsonUtil.build().toJson(attArray));
|
log.debug("Attributes: {}", GsonUtil.build().toJson(attArray));
|
||||||
|
|
||||||
try (EntryCursor cursor = conn.search(getBaseDn(), searchQuery, SearchScope.SUBTREE, attArray)) {
|
for (String baseDN : getBaseDNs()) {
|
||||||
|
log.debug("Base DN: {}", baseDN);
|
||||||
|
|
||||||
|
try (EntryCursor cursor = conn.search(baseDN, searchQuery, SearchScope.SUBTREE, attArray)) {
|
||||||
while (cursor.next()) {
|
while (cursor.next()) {
|
||||||
Entry entry = cursor.get();
|
Entry entry = cursor.get();
|
||||||
log.info("Found possible match, DN: {}", entry.getDn().getName());
|
log.info("Found possible match, DN: {}", entry.getDn().getName());
|
||||||
@@ -93,6 +85,7 @@ public class LdapDirectoryProvider extends LdapBackend implements IDirectoryProv
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
}
|
||||||
} catch (CursorLdapReferralException e) {
|
} catch (CursorLdapReferralException e) {
|
||||||
log.warn("An entry is only available via referral, skipping");
|
log.warn("An entry is only available via referral, skipping");
|
||||||
} catch (IOException | LdapException | CursorException e) {
|
} catch (IOException | LdapException | CursorException e) {
|
||||||
|
@@ -0,0 +1,150 @@
|
|||||||
|
/*
|
||||||
|
* 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.matrix.ThreePid;
|
||||||
|
import io.kamax.matrix._MatrixID;
|
||||||
|
import io.kamax.matrix._ThreePid;
|
||||||
|
import io.kamax.mxisd.config.MatrixConfig;
|
||||||
|
import io.kamax.mxisd.config.ldap.LdapConfig;
|
||||||
|
import io.kamax.mxisd.exception.InternalServerError;
|
||||||
|
import io.kamax.mxisd.profile.ProfileProvider;
|
||||||
|
import org.apache.directory.api.ldap.model.cursor.CursorException;
|
||||||
|
import org.apache.directory.api.ldap.model.cursor.CursorLdapReferralException;
|
||||||
|
import org.apache.directory.api.ldap.model.cursor.EntryCursor;
|
||||||
|
import org.apache.directory.api.ldap.model.entry.Entry;
|
||||||
|
import org.apache.directory.api.ldap.model.exception.LdapException;
|
||||||
|
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 java.io.IOException;
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.Collections;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.Optional;
|
||||||
|
|
||||||
|
public class LdapProfileProvider extends LdapBackend implements ProfileProvider {
|
||||||
|
|
||||||
|
private transient final Logger log = LoggerFactory.getLogger(LdapProfileProvider.class);
|
||||||
|
|
||||||
|
public LdapProfileProvider(LdapConfig cfg, MatrixConfig mxCfg) {
|
||||||
|
super(cfg, mxCfg);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public Optional<String> getDisplayName(_MatrixID userId) {
|
||||||
|
String uid = buildUidFromMatrixId(userId);
|
||||||
|
log.info("Searching for display name of {}:", uid);
|
||||||
|
|
||||||
|
try (LdapConnection conn = getConn()) {
|
||||||
|
bind(conn);
|
||||||
|
|
||||||
|
String searchQuery = buildOrQueryWithFilter(getCfg().getProfile().getFilter(), uid, getUidAtt());
|
||||||
|
log.debug("Query: {}", searchQuery);
|
||||||
|
|
||||||
|
for (String baseDN : getBaseDNs()) {
|
||||||
|
log.debug("Base DN: {}", baseDN);
|
||||||
|
try (EntryCursor cursor = conn.search(baseDN, searchQuery, SearchScope.SUBTREE, getAt().getName())) {
|
||||||
|
while (cursor.next()) {
|
||||||
|
Entry entry = cursor.get();
|
||||||
|
log.info("Found possible match, DN: {}", entry.getDn().getName());
|
||||||
|
Optional<String> v = getAttribute(entry, getAt().getName()).flatMap(id -> {
|
||||||
|
log.info("DN {} is a valid match", entry.getDn().getName());
|
||||||
|
try {
|
||||||
|
return getAttribute(entry, getAt().getName());
|
||||||
|
} catch (IllegalArgumentException e) {
|
||||||
|
log.warn("Bind was found but type {} is not supported", getAt().getUid().getType());
|
||||||
|
return Optional.empty();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
if (v.isPresent()) {
|
||||||
|
log.info("DN {} is the final match", entry.getDn().getName());
|
||||||
|
return v;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch (CursorLdapReferralException e) {
|
||||||
|
log.warn("An entry is only available via referral, skipping");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch (IOException | LdapException | CursorException e) {
|
||||||
|
throw new InternalServerError(e);
|
||||||
|
}
|
||||||
|
|
||||||
|
return Optional.empty();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public List<_ThreePid> getThreepids(_MatrixID userId) {
|
||||||
|
String uid = buildUidFromMatrixId(userId);
|
||||||
|
log.info("Searching for 3PIDs of {}:", uid);
|
||||||
|
|
||||||
|
List<_ThreePid> threePids = new ArrayList<>();
|
||||||
|
try (LdapConnection conn = getConn()) {
|
||||||
|
bind(conn);
|
||||||
|
|
||||||
|
getCfg().getAttribute().getThreepid().forEach((medium, attributes) -> {
|
||||||
|
String[] attArray = new String[attributes.size()];
|
||||||
|
attributes.toArray(attArray);
|
||||||
|
|
||||||
|
String searchQuery = buildOrQueryWithFilter(getCfg().getProfile().getFilter(), uid, getUidAtt());
|
||||||
|
|
||||||
|
log.debug("Query for 3PID {}: {}", medium, searchQuery);
|
||||||
|
|
||||||
|
for (String baseDN : getBaseDNs()) {
|
||||||
|
log.debug("Base DN: {}", baseDN);
|
||||||
|
try (EntryCursor cursor = conn.search(baseDN, searchQuery, SearchScope.SUBTREE, attArray)) {
|
||||||
|
while (cursor.next()) {
|
||||||
|
Entry entry = cursor.get();
|
||||||
|
log.info("Found possible match, DN: {}", entry.getDn().getName());
|
||||||
|
try {
|
||||||
|
attributes.stream()
|
||||||
|
.flatMap(at -> getAttributes(entry, at).stream())
|
||||||
|
.forEach(address -> {
|
||||||
|
log.info("Found 3PID: {} - {}", medium, address);
|
||||||
|
threePids.add(new ThreePid(medium, address));
|
||||||
|
});
|
||||||
|
} catch (IllegalArgumentException e) {
|
||||||
|
log.warn("Bind was found but type {} is not supported", getAt().getUid().getType());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch (CursorLdapReferralException e) {
|
||||||
|
log.warn("An entry is only available via referral, skipping");
|
||||||
|
} catch (LdapException | IOException | CursorException e) {
|
||||||
|
throw new InternalServerError(e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
} catch (IOException | LdapException e) {
|
||||||
|
throw new InternalServerError(e);
|
||||||
|
}
|
||||||
|
|
||||||
|
return threePids;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public List<String> getRoles(_MatrixID userId) {
|
||||||
|
return Collections.emptyList();
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@@ -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()));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@@ -1,8 +1,8 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2017 Maxime Dor
|
* Copyright (C) 2017 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://max.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU Affero General Public License as
|
* it under the terms of the GNU Affero General Public License as
|
||||||
@@ -37,27 +37,20 @@ import org.apache.directory.api.ldap.model.message.SearchScope;
|
|||||||
import org.apache.directory.ldap.client.api.LdapConnection;
|
import org.apache.directory.ldap.client.api.LdapConnection;
|
||||||
import org.slf4j.Logger;
|
import org.slf4j.Logger;
|
||||||
import org.slf4j.LoggerFactory;
|
import org.slf4j.LoggerFactory;
|
||||||
import org.springframework.stereotype.Component;
|
|
||||||
|
|
||||||
import java.io.IOException;
|
import java.io.IOException;
|
||||||
import java.util.ArrayList;
|
import java.util.ArrayList;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
import java.util.Optional;
|
import java.util.Optional;
|
||||||
|
|
||||||
@Component
|
|
||||||
public class LdapThreePidProvider extends LdapBackend implements IThreePidProvider {
|
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) {
|
public LdapThreePidProvider(LdapConfig cfg, MatrixConfig mxCfg) {
|
||||||
super(cfg, mxCfg);
|
super(cfg, mxCfg);
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
|
||||||
public boolean isEnabled() {
|
|
||||||
return getCfg().isEnabled();
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public boolean isLocal() {
|
public boolean isLocal() {
|
||||||
return true;
|
return true;
|
||||||
@@ -78,12 +71,13 @@ public class LdapThreePidProvider extends LdapBackend implements IThreePidProvid
|
|||||||
// we merge 3PID specific query with global/specific filter, if one exists.
|
// we merge 3PID specific query with global/specific filter, if one exists.
|
||||||
String tPidQuery = tPidQueryOpt.get().replaceAll(getCfg().getIdentity().getToken(), value);
|
String tPidQuery = tPidQueryOpt.get().replaceAll(getCfg().getIdentity().getToken(), value);
|
||||||
String searchQuery = buildWithFilter(tPidQuery, getCfg().getIdentity().getFilter());
|
String searchQuery = buildWithFilter(tPidQuery, getCfg().getIdentity().getFilter());
|
||||||
|
|
||||||
log.debug("Base DN: {}", getBaseDn());
|
|
||||||
log.debug("Query: {}", searchQuery);
|
log.debug("Query: {}", searchQuery);
|
||||||
log.debug("Attributes: {}", GsonUtil.build().toJson(getUidAtt()));
|
log.debug("Attributes: {}", GsonUtil.build().toJson(getUidAtt()));
|
||||||
|
|
||||||
try (EntryCursor cursor = conn.search(getBaseDn(), searchQuery, SearchScope.SUBTREE, getUidAtt())) {
|
for (String baseDN : getBaseDNs()) {
|
||||||
|
log.debug("Base DN: {}", baseDN);
|
||||||
|
|
||||||
|
try (EntryCursor cursor = conn.search(baseDN, searchQuery, SearchScope.SUBTREE, getUidAtt())) {
|
||||||
while (cursor.next()) {
|
while (cursor.next()) {
|
||||||
Entry entry = cursor.get();
|
Entry entry = cursor.get();
|
||||||
log.info("Found possible match, DN: {}", entry.getDn().getName());
|
log.info("Found possible match, DN: {}", entry.getDn().getName());
|
||||||
@@ -101,6 +95,7 @@ public class LdapThreePidProvider extends LdapBackend implements IThreePidProvid
|
|||||||
} catch (IOException | LdapException | CursorException e) {
|
} catch (IOException | LdapException | CursorException e) {
|
||||||
throw new InternalServerError(e);
|
throw new InternalServerError(e);
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
return Optional.empty();
|
return Optional.empty();
|
||||||
}
|
}
|
||||||
|
@@ -23,9 +23,7 @@ package io.kamax.mxisd.backend.ldap.netiq;
|
|||||||
import io.kamax.mxisd.backend.ldap.LdapAuthProvider;
|
import io.kamax.mxisd.backend.ldap.LdapAuthProvider;
|
||||||
import io.kamax.mxisd.config.MatrixConfig;
|
import io.kamax.mxisd.config.MatrixConfig;
|
||||||
import io.kamax.mxisd.config.ldap.netiq.NetIqLdapConfig;
|
import io.kamax.mxisd.config.ldap.netiq.NetIqLdapConfig;
|
||||||
import org.springframework.stereotype.Component;
|
|
||||||
|
|
||||||
@Component
|
|
||||||
public class NetIqLdapAuthProvider extends LdapAuthProvider {
|
public class NetIqLdapAuthProvider extends LdapAuthProvider {
|
||||||
|
|
||||||
public NetIqLdapAuthProvider(NetIqLdapConfig cfg, MatrixConfig mxCfg) {
|
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.backend.ldap.LdapDirectoryProvider;
|
||||||
import io.kamax.mxisd.config.MatrixConfig;
|
import io.kamax.mxisd.config.MatrixConfig;
|
||||||
import io.kamax.mxisd.config.ldap.netiq.NetIqLdapConfig;
|
import io.kamax.mxisd.config.ldap.netiq.NetIqLdapConfig;
|
||||||
import org.springframework.stereotype.Component;
|
|
||||||
|
|
||||||
@Component
|
|
||||||
public class NetIqLdapDirectoryProvider extends LdapDirectoryProvider {
|
public class NetIqLdapDirectoryProvider extends LdapDirectoryProvider {
|
||||||
|
|
||||||
public NetIqLdapDirectoryProvider(NetIqLdapConfig cfg, MatrixConfig mxCfg) {
|
public NetIqLdapDirectoryProvider(NetIqLdapConfig cfg, MatrixConfig mxCfg) {
|
||||||
|
@@ -0,0 +1,46 @@
|
|||||||
|
/*
|
||||||
|
* 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.matrix._MatrixID;
|
||||||
|
import io.kamax.mxisd.backend.ldap.LdapProfileProvider;
|
||||||
|
import io.kamax.mxisd.config.MatrixConfig;
|
||||||
|
import io.kamax.mxisd.config.ldap.netiq.NetIqLdapConfig;
|
||||||
|
|
||||||
|
public class NetIqLdapProfileProvider extends LdapProfileProvider {
|
||||||
|
|
||||||
|
public NetIqLdapProfileProvider(NetIqLdapConfig cfg, MatrixConfig mxCfg) {
|
||||||
|
super(cfg, mxCfg);
|
||||||
|
}
|
||||||
|
|
||||||
|
// FIXME this is duplicated in the other NetIQ classes, due to the Matrix ID generation code that was not abstracted
|
||||||
|
@Override
|
||||||
|
public String buildMatrixIdFromUid(String uid) {
|
||||||
|
return super.buildMatrixIdFromUid(uid).toLowerCase();
|
||||||
|
}
|
||||||
|
|
||||||
|
// FIXME this is duplicated in the other NetIQ classes, due to the Matrix ID generation code that was not abstracted
|
||||||
|
@Override
|
||||||
|
public String buildUidFromMatrixId(_MatrixID mxid) {
|
||||||
|
return super.buildUidFromMatrixId(mxid).toLowerCase();
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@@ -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.backend.ldap.LdapThreePidProvider;
|
||||||
import io.kamax.mxisd.config.MatrixConfig;
|
import io.kamax.mxisd.config.MatrixConfig;
|
||||||
import io.kamax.mxisd.config.ldap.netiq.NetIqLdapConfig;
|
import io.kamax.mxisd.config.ldap.netiq.NetIqLdapConfig;
|
||||||
import org.springframework.stereotype.Component;
|
|
||||||
|
|
||||||
@Component
|
|
||||||
public class NetIqLdapThreePidProvider extends LdapThreePidProvider {
|
public class NetIqLdapThreePidProvider extends LdapThreePidProvider {
|
||||||
|
|
||||||
public NetIqLdapThreePidProvider(NetIqLdapConfig cfg, MatrixConfig mxCfg) {
|
public NetIqLdapThreePidProvider(NetIqLdapConfig cfg, MatrixConfig mxCfg) {
|
||||||
|
@@ -1,6 +1,6 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2018 Maxime Dor
|
* Copyright (C) 2018 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://www.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
@@ -31,8 +31,8 @@ import io.kamax.mxisd.config.MatrixConfig;
|
|||||||
import io.kamax.mxisd.config.memory.MemoryIdentityConfig;
|
import io.kamax.mxisd.config.memory.MemoryIdentityConfig;
|
||||||
import io.kamax.mxisd.config.memory.MemoryStoreConfig;
|
import io.kamax.mxisd.config.memory.MemoryStoreConfig;
|
||||||
import io.kamax.mxisd.config.memory.MemoryThreePid;
|
import io.kamax.mxisd.config.memory.MemoryThreePid;
|
||||||
import io.kamax.mxisd.controller.directory.v1.io.UserDirectorySearchResult;
|
import io.kamax.mxisd.directory.DirectoryProvider;
|
||||||
import io.kamax.mxisd.directory.IDirectoryProvider;
|
import io.kamax.mxisd.http.io.UserDirectorySearchResult;
|
||||||
import io.kamax.mxisd.lookup.SingleLookupReply;
|
import io.kamax.mxisd.lookup.SingleLookupReply;
|
||||||
import io.kamax.mxisd.lookup.SingleLookupRequest;
|
import io.kamax.mxisd.lookup.SingleLookupRequest;
|
||||||
import io.kamax.mxisd.lookup.ThreePidMapping;
|
import io.kamax.mxisd.lookup.ThreePidMapping;
|
||||||
@@ -41,8 +41,6 @@ import io.kamax.mxisd.profile.ProfileProvider;
|
|||||||
import org.apache.commons.lang.StringUtils;
|
import org.apache.commons.lang.StringUtils;
|
||||||
import org.slf4j.Logger;
|
import org.slf4j.Logger;
|
||||||
import org.slf4j.LoggerFactory;
|
import org.slf4j.LoggerFactory;
|
||||||
import org.springframework.beans.factory.annotation.Autowired;
|
|
||||||
import org.springframework.stereotype.Component;
|
|
||||||
|
|
||||||
import java.util.ArrayList;
|
import java.util.ArrayList;
|
||||||
import java.util.Collections;
|
import java.util.Collections;
|
||||||
@@ -51,15 +49,13 @@ import java.util.Optional;
|
|||||||
import java.util.function.Function;
|
import java.util.function.Function;
|
||||||
import java.util.function.Predicate;
|
import java.util.function.Predicate;
|
||||||
|
|
||||||
@Component
|
public class MemoryIdentityStore implements AuthenticatorProvider, DirectoryProvider, IThreePidProvider, ProfileProvider {
|
||||||
public class MemoryIdentityStore implements AuthenticatorProvider, IDirectoryProvider, 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 MatrixConfig mxCfg;
|
||||||
private final MemoryStoreConfig cfg;
|
private final MemoryStoreConfig cfg;
|
||||||
|
|
||||||
@Autowired
|
|
||||||
public MemoryIdentityStore(MatrixConfig mxCfg, MemoryStoreConfig cfg) {
|
public MemoryIdentityStore(MatrixConfig mxCfg, MemoryStoreConfig cfg) {
|
||||||
this.mxCfg = mxCfg;
|
this.mxCfg = mxCfg;
|
||||||
this.cfg = cfg;
|
this.cfg = cfg;
|
||||||
@@ -76,6 +72,11 @@ public class MemoryIdentityStore implements AuthenticatorProvider, IDirectoryPro
|
|||||||
return cfg.isEnabled();
|
return cfg.isEnabled();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public Optional<String> getDisplayName(_MatrixID mxid) {
|
||||||
|
return findByUsername(mxid.getLocalPart()).map(MemoryIdentityConfig::getDisplayName);
|
||||||
|
}
|
||||||
|
|
||||||
private UserDirectorySearchResult search(
|
private UserDirectorySearchResult search(
|
||||||
Predicate<MemoryIdentityConfig> predicate,
|
Predicate<MemoryIdentityConfig> predicate,
|
||||||
Function<MemoryIdentityConfig, UserDirectorySearchResult.Result> mapper
|
Function<MemoryIdentityConfig, UserDirectorySearchResult.Result> mapper
|
||||||
@@ -143,7 +144,7 @@ public class MemoryIdentityStore implements AuthenticatorProvider, IDirectoryPro
|
|||||||
for (MemoryIdentityConfig id : cfg.getIdentities()) {
|
for (MemoryIdentityConfig id : cfg.getIdentities()) {
|
||||||
for (MemoryThreePid threepid : id.getThreepids()) {
|
for (MemoryThreePid threepid : id.getThreepids()) {
|
||||||
if (req.equals(new ThreePid(threepid.getMedium(), threepid.getAddress()))) {
|
if (req.equals(new ThreePid(threepid.getMedium(), threepid.getAddress()))) {
|
||||||
return Optional.of(new SingleLookupReply(request, new MatrixID(id.getUsername(), mxCfg.getDomain())));
|
return Optional.of(new SingleLookupReply(request, MatrixID.asAcceptable(id.getUsername(), mxCfg.getDomain())));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@@ -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);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@@ -1,8 +1,8 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2017 Maxime Dor
|
* Copyright (C) 2017 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://max.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU Affero General Public License as
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
@@ -1,8 +1,8 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2017 Maxime Dor
|
* Copyright (C) 2017 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://max.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU Affero General Public License as
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
@@ -1,8 +1,8 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2017 Maxime Dor
|
* Copyright (C) 2017 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://max.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU Affero General Public License as
|
* it under the terms of the GNU Affero General Public License as
|
||||||
@@ -20,6 +20,7 @@
|
|||||||
|
|
||||||
package io.kamax.mxisd.backend.rest;
|
package io.kamax.mxisd.backend.rest;
|
||||||
|
|
||||||
|
import io.kamax.matrix.ThreePidMedium;
|
||||||
import io.kamax.mxisd.UserID;
|
import io.kamax.mxisd.UserID;
|
||||||
|
|
||||||
public class LookupSingleResponseJson {
|
public class LookupSingleResponseJson {
|
||||||
@@ -32,12 +33,28 @@ public class LookupSingleResponseJson {
|
|||||||
return medium;
|
return medium;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public void setMedium(String medium) {
|
||||||
|
this.medium = medium;
|
||||||
|
}
|
||||||
|
|
||||||
|
public void setMedium(ThreePidMedium medium) {
|
||||||
|
setMedium(medium.getId());
|
||||||
|
}
|
||||||
|
|
||||||
public String getAddress() {
|
public String getAddress() {
|
||||||
return address;
|
return address;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public void setAddress(String address) {
|
||||||
|
this.address = address;
|
||||||
|
}
|
||||||
|
|
||||||
public UserID getId() {
|
public UserID getId() {
|
||||||
return id;
|
return id;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public void setId(UserID id) {
|
||||||
|
this.id = id;
|
||||||
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
@@ -1,8 +1,8 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2017 Maxime Dor
|
* Copyright (C) 2017 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://max.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU Affero General Public License as
|
* it under the terms of the GNU Affero General Public License as
|
||||||
@@ -27,15 +27,11 @@ import io.kamax.mxisd.config.rest.RestBackendConfig;
|
|||||||
import io.kamax.mxisd.util.RestClientUtils;
|
import io.kamax.mxisd.util.RestClientUtils;
|
||||||
import org.apache.http.client.methods.CloseableHttpResponse;
|
import org.apache.http.client.methods.CloseableHttpResponse;
|
||||||
import org.apache.http.client.methods.HttpUriRequest;
|
import org.apache.http.client.methods.HttpUriRequest;
|
||||||
import org.springframework.beans.factory.annotation.Autowired;
|
|
||||||
import org.springframework.stereotype.Component;
|
|
||||||
|
|
||||||
import java.io.IOException;
|
import java.io.IOException;
|
||||||
|
|
||||||
@Component
|
|
||||||
public class RestAuthProvider extends RestProvider implements AuthenticatorProvider {
|
public class RestAuthProvider extends RestProvider implements AuthenticatorProvider {
|
||||||
|
|
||||||
@Autowired
|
|
||||||
public RestAuthProvider(RestBackendConfig cfg) {
|
public RestAuthProvider(RestBackendConfig cfg) {
|
||||||
super(cfg);
|
super(cfg);
|
||||||
}
|
}
|
||||||
|
@@ -1,8 +1,8 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2017 Maxime Dor
|
* Copyright (C) 2017 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://max.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU Affero General Public License as
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
@@ -1,8 +1,8 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2017 Maxime Dor
|
* Copyright (C) 2017 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://max.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU Affero General Public License as
|
* it under the terms of the GNU Affero General Public License as
|
||||||
@@ -23,21 +23,18 @@ package io.kamax.mxisd.backend.rest;
|
|||||||
import io.kamax.matrix.MatrixID;
|
import io.kamax.matrix.MatrixID;
|
||||||
import io.kamax.mxisd.config.MatrixConfig;
|
import io.kamax.mxisd.config.MatrixConfig;
|
||||||
import io.kamax.mxisd.config.rest.RestBackendConfig;
|
import io.kamax.mxisd.config.rest.RestBackendConfig;
|
||||||
import io.kamax.mxisd.controller.directory.v1.io.UserDirectorySearchRequest;
|
import io.kamax.mxisd.directory.DirectoryProvider;
|
||||||
import io.kamax.mxisd.controller.directory.v1.io.UserDirectorySearchResult;
|
|
||||||
import io.kamax.mxisd.directory.IDirectoryProvider;
|
|
||||||
import io.kamax.mxisd.exception.InternalServerError;
|
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 io.kamax.mxisd.util.RestClientUtils;
|
||||||
import org.apache.commons.io.IOUtils;
|
import org.apache.commons.io.IOUtils;
|
||||||
import org.apache.commons.lang.StringUtils;
|
|
||||||
import org.apache.http.client.methods.CloseableHttpResponse;
|
import org.apache.http.client.methods.CloseableHttpResponse;
|
||||||
import org.springframework.stereotype.Component;
|
|
||||||
|
|
||||||
import java.io.IOException;
|
import java.io.IOException;
|
||||||
import java.nio.charset.StandardCharsets;
|
import java.nio.charset.StandardCharsets;
|
||||||
|
|
||||||
@Component
|
public class RestDirectoryProvider extends RestProvider implements DirectoryProvider {
|
||||||
public class RestDirectoryProvider extends RestProvider implements IDirectoryProvider {
|
|
||||||
|
|
||||||
private MatrixConfig mxCfg;
|
private MatrixConfig mxCfg;
|
||||||
|
|
||||||
@@ -46,11 +43,6 @@ public class RestDirectoryProvider extends RestProvider implements IDirectoryPro
|
|||||||
this.mxCfg = mxCfg;
|
this.mxCfg = mxCfg;
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
|
||||||
public boolean isEnabled() {
|
|
||||||
return cfg.isEnabled() && StringUtils.isNotBlank(cfg.getEndpoints().getDirectory());
|
|
||||||
}
|
|
||||||
|
|
||||||
private UserDirectorySearchResult search(String by, String query) {
|
private UserDirectorySearchResult search(String by, String query) {
|
||||||
UserDirectorySearchRequest request = new UserDirectorySearchRequest(query);
|
UserDirectorySearchRequest request = new UserDirectorySearchRequest(query);
|
||||||
request.setBy(by);
|
request.setBy(by);
|
||||||
@@ -62,7 +54,7 @@ public class RestDirectoryProvider extends RestProvider implements IDirectoryPro
|
|||||||
|
|
||||||
UserDirectorySearchResult response = parser.parse(httpResponse, UserDirectorySearchResult.class);
|
UserDirectorySearchResult response = parser.parse(httpResponse, UserDirectorySearchResult.class);
|
||||||
for (UserDirectorySearchResult.Result result : response.getResults()) {
|
for (UserDirectorySearchResult.Result result : response.getResults()) {
|
||||||
result.setUserId(new MatrixID(result.getUserId(), mxCfg.getDomain()).getId());
|
result.setUserId(MatrixID.asAcceptable(result.getUserId(), mxCfg.getDomain()).getId());
|
||||||
}
|
}
|
||||||
|
|
||||||
return response;
|
return response;
|
||||||
|
@@ -0,0 +1,140 @@
|
|||||||
|
/*
|
||||||
|
* 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 com.google.gson.JsonObject;
|
||||||
|
import com.google.gson.JsonSyntaxException;
|
||||||
|
import io.kamax.matrix._MatrixID;
|
||||||
|
import io.kamax.matrix._ThreePid;
|
||||||
|
import io.kamax.matrix.json.GsonUtil;
|
||||||
|
import io.kamax.matrix.json.InvalidJsonException;
|
||||||
|
import io.kamax.mxisd.config.rest.RestBackendConfig;
|
||||||
|
import io.kamax.mxisd.exception.InternalServerError;
|
||||||
|
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.http.client.methods.CloseableHttpResponse;
|
||||||
|
import org.apache.http.client.methods.HttpPost;
|
||||||
|
import org.apache.http.client.utils.URIBuilder;
|
||||||
|
import org.apache.http.entity.ContentType;
|
||||||
|
import org.apache.http.entity.StringEntity;
|
||||||
|
import org.slf4j.Logger;
|
||||||
|
import org.slf4j.LoggerFactory;
|
||||||
|
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.net.URISyntaxException;
|
||||||
|
import java.nio.charset.StandardCharsets;
|
||||||
|
import java.util.*;
|
||||||
|
import java.util.function.Function;
|
||||||
|
|
||||||
|
public class RestProfileProvider extends RestProvider implements ProfileProvider {
|
||||||
|
|
||||||
|
private transient final Logger log = LoggerFactory.getLogger(RestProfileProvider.class);
|
||||||
|
|
||||||
|
public RestProfileProvider(RestBackendConfig cfg) {
|
||||||
|
super(cfg);
|
||||||
|
}
|
||||||
|
|
||||||
|
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();
|
||||||
|
}
|
||||||
|
|
||||||
|
if (sc != 200) {
|
||||||
|
throw new InternalServerError("Unexpected backed status code: " + sc);
|
||||||
|
}
|
||||||
|
|
||||||
|
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();
|
||||||
|
}
|
||||||
|
|
||||||
|
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()));
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public List<_ThreePid> getThreepids(_MatrixID userId) {
|
||||||
|
return doRequest(userId, p -> Optional.ofNullable(p.getThreepids()), profile -> {
|
||||||
|
List<_ThreePid> t = new ArrayList<>();
|
||||||
|
if (Objects.nonNull(profile.getThreepids())) {
|
||||||
|
t.addAll(profile.getThreepids());
|
||||||
|
}
|
||||||
|
return Optional.of(t);
|
||||||
|
}).orElseGet(Collections::emptyList);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public List<String> getRoles(_MatrixID userId) {
|
||||||
|
return doRequest(userId, p -> Optional.ofNullable(p.getRoles()), profile -> {
|
||||||
|
List<String> t = new ArrayList<>();
|
||||||
|
if (Objects.nonNull(profile.getRoles())) {
|
||||||
|
t.addAll(profile.getRoles());
|
||||||
|
}
|
||||||
|
return Optional.of(t);
|
||||||
|
}).orElseGet(Collections::emptyList);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@@ -1,8 +1,8 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2017 Maxime Dor
|
* Copyright (C) 2017 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://max.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU Affero General Public License as
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
@@ -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()));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@@ -1,8 +1,8 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2017 Maxime Dor
|
* Copyright (C) 2017 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://max.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU Affero General Public License as
|
* it under the terms of the GNU Affero General Public License as
|
||||||
@@ -35,8 +35,6 @@ import org.apache.http.client.methods.CloseableHttpResponse;
|
|||||||
import org.apache.http.client.methods.HttpUriRequest;
|
import org.apache.http.client.methods.HttpUriRequest;
|
||||||
import org.slf4j.Logger;
|
import org.slf4j.Logger;
|
||||||
import org.slf4j.LoggerFactory;
|
import org.slf4j.LoggerFactory;
|
||||||
import org.springframework.beans.factory.annotation.Autowired;
|
|
||||||
import org.springframework.stereotype.Component;
|
|
||||||
|
|
||||||
import java.io.IOException;
|
import java.io.IOException;
|
||||||
import java.util.ArrayList;
|
import java.util.ArrayList;
|
||||||
@@ -44,14 +42,12 @@ import java.util.List;
|
|||||||
import java.util.Optional;
|
import java.util.Optional;
|
||||||
import java.util.stream.Collectors;
|
import java.util.stream.Collectors;
|
||||||
|
|
||||||
@Component
|
|
||||||
public class RestThreePidProvider extends RestProvider implements IThreePidProvider {
|
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
|
private MatrixConfig mxCfg; // FIXME should be done in the lookup manager
|
||||||
|
|
||||||
@Autowired
|
|
||||||
public RestThreePidProvider(RestBackendConfig cfg, MatrixConfig mxCfg) {
|
public RestThreePidProvider(RestBackendConfig cfg, MatrixConfig mxCfg) {
|
||||||
super(cfg);
|
super(cfg);
|
||||||
this.mxCfg = mxCfg;
|
this.mxCfg = mxCfg;
|
||||||
@@ -60,17 +56,12 @@ public class RestThreePidProvider extends RestProvider implements IThreePidProvi
|
|||||||
// TODO refactor in lookup manager with above FIXME
|
// TODO refactor in lookup manager with above FIXME
|
||||||
private _MatrixID getMxId(UserID id) {
|
private _MatrixID getMxId(UserID id) {
|
||||||
if (UserIdType.Localpart.is(id.getType())) {
|
if (UserIdType.Localpart.is(id.getType())) {
|
||||||
return new MatrixID(id.getValue(), mxCfg.getDomain());
|
return MatrixID.asAcceptable(id.getValue(), mxCfg.getDomain());
|
||||||
} else {
|
} else {
|
||||||
return new MatrixID(id.getValue());
|
return MatrixID.asAcceptable(id.getValue());
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
|
||||||
public boolean isEnabled() {
|
|
||||||
return cfg.isEnabled();
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public boolean isLocal() {
|
public boolean isLocal() {
|
||||||
return true;
|
return true;
|
||||||
|
@@ -1,8 +1,8 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2017 Maxime Dor
|
* Copyright (C) 2017 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://max.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU Affero General Public License as
|
* it under the terms of the GNU Affero General Public License as
|
||||||
@@ -28,6 +28,12 @@ import java.sql.SQLException;
|
|||||||
|
|
||||||
public class SqlConnectionPool {
|
public class SqlConnectionPool {
|
||||||
|
|
||||||
|
public interface SqlFunction<T, R> {
|
||||||
|
|
||||||
|
R run(T connection) throws SQLException;
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
private ComboPooledDataSource ds;
|
private ComboPooledDataSource ds;
|
||||||
|
|
||||||
public SqlConnectionPool(SqlConfig cfg) {
|
public SqlConnectionPool(SqlConfig cfg) {
|
||||||
@@ -42,4 +48,12 @@ public class SqlConnectionPool {
|
|||||||
return ds.getConnection();
|
return ds.getConnection();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public <T> T withConnFunction(SqlFunction<Connection, T> function) {
|
||||||
|
try (Connection conn = get()) {
|
||||||
|
return function.run(conn);
|
||||||
|
} catch (SQLException e) {
|
||||||
|
throw new RuntimeException(e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
100
src/main/java/io/kamax/mxisd/backend/sql/SqlProfileProvider.java
Normal file
100
src/main/java/io/kamax/mxisd/backend/sql/SqlProfileProvider.java
Normal file
@@ -0,0 +1,100 @@
|
|||||||
|
/*
|
||||||
|
* 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;
|
||||||
|
|
||||||
|
import io.kamax.matrix.ThreePid;
|
||||||
|
import io.kamax.matrix._MatrixID;
|
||||||
|
import io.kamax.matrix._ThreePid;
|
||||||
|
import io.kamax.mxisd.config.sql.SqlConfig;
|
||||||
|
import io.kamax.mxisd.profile.ProfileProvider;
|
||||||
|
import org.slf4j.Logger;
|
||||||
|
import org.slf4j.LoggerFactory;
|
||||||
|
|
||||||
|
import java.sql.Connection;
|
||||||
|
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 transient final Logger log = LoggerFactory.getLogger(SqlProfileProvider.class);
|
||||||
|
|
||||||
|
private SqlConfig.Profile cfg;
|
||||||
|
|
||||||
|
private SqlConnectionPool pool;
|
||||||
|
|
||||||
|
public SqlProfileProvider(SqlConfig cfg) {
|
||||||
|
this.cfg = cfg.getProfile();
|
||||||
|
this.pool = new SqlConnectionPool(cfg);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public Optional<String> getDisplayName(_MatrixID user) {
|
||||||
|
String stmtSql = cfg.getDisplayName().getQuery();
|
||||||
|
try (Connection conn = pool.get()) {
|
||||||
|
try (PreparedStatement stmt = conn.prepareStatement(stmtSql)) {
|
||||||
|
stmt.setString(1, user.getId());
|
||||||
|
|
||||||
|
try (ResultSet rSet = stmt.executeQuery()) {
|
||||||
|
if (!rSet.next()) {
|
||||||
|
return Optional.empty();
|
||||||
|
}
|
||||||
|
|
||||||
|
return Optional.ofNullable(rSet.getString(1));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch (SQLException e) {
|
||||||
|
throw new RuntimeException(e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public List<_ThreePid> getThreepids(_MatrixID user) {
|
||||||
|
List<_ThreePid> threepids = new ArrayList<>();
|
||||||
|
|
||||||
|
String stmtSql = cfg.getThreepid().getQuery();
|
||||||
|
try (Connection conn = pool.get()) {
|
||||||
|
PreparedStatement stmt = conn.prepareStatement(stmtSql);
|
||||||
|
stmt.setString(1, user.getId());
|
||||||
|
|
||||||
|
ResultSet rSet = stmt.executeQuery();
|
||||||
|
while (rSet.next()) {
|
||||||
|
String medium = rSet.getString(1);
|
||||||
|
String address = rSet.getString(2);
|
||||||
|
threepids.add(new ThreePid(medium, address));
|
||||||
|
}
|
||||||
|
|
||||||
|
return threepids;
|
||||||
|
} catch (SQLException e) {
|
||||||
|
throw new RuntimeException(e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public List<String> getRoles(_MatrixID user) {
|
||||||
|
return Collections.emptyList();
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@@ -1,8 +1,8 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2017 Maxime Dor
|
* Copyright (C) 2017 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://max.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU Affero General Public License as
|
* it under the terms of the GNU Affero General Public License as
|
||||||
@@ -21,16 +21,12 @@
|
|||||||
package io.kamax.mxisd.backend.sql;
|
package io.kamax.mxisd.backend.sql;
|
||||||
|
|
||||||
import io.kamax.matrix.MatrixID;
|
import io.kamax.matrix.MatrixID;
|
||||||
import io.kamax.matrix.ThreePid;
|
|
||||||
import io.kamax.matrix._MatrixID;
|
|
||||||
import io.kamax.matrix._ThreePid;
|
|
||||||
import io.kamax.mxisd.config.MatrixConfig;
|
import io.kamax.mxisd.config.MatrixConfig;
|
||||||
import io.kamax.mxisd.config.sql.SqlConfig;
|
import io.kamax.mxisd.config.sql.SqlConfig;
|
||||||
import io.kamax.mxisd.lookup.SingleLookupReply;
|
import io.kamax.mxisd.lookup.SingleLookupReply;
|
||||||
import io.kamax.mxisd.lookup.SingleLookupRequest;
|
import io.kamax.mxisd.lookup.SingleLookupRequest;
|
||||||
import io.kamax.mxisd.lookup.ThreePidMapping;
|
import io.kamax.mxisd.lookup.ThreePidMapping;
|
||||||
import io.kamax.mxisd.lookup.provider.IThreePidProvider;
|
import io.kamax.mxisd.lookup.provider.IThreePidProvider;
|
||||||
import io.kamax.mxisd.profile.ProfileProvider;
|
|
||||||
import org.apache.commons.lang.StringUtils;
|
import org.apache.commons.lang.StringUtils;
|
||||||
import org.slf4j.Logger;
|
import org.slf4j.Logger;
|
||||||
import org.slf4j.LoggerFactory;
|
import org.slf4j.LoggerFactory;
|
||||||
@@ -40,13 +36,12 @@ import java.sql.PreparedStatement;
|
|||||||
import java.sql.ResultSet;
|
import java.sql.ResultSet;
|
||||||
import java.sql.SQLException;
|
import java.sql.SQLException;
|
||||||
import java.util.ArrayList;
|
import java.util.ArrayList;
|
||||||
import java.util.Collections;
|
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
import java.util.Optional;
|
import java.util.Optional;
|
||||||
|
|
||||||
public abstract class SqlThreePidProvider implements IThreePidProvider, ProfileProvider {
|
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 SqlConfig cfg;
|
||||||
private MatrixConfig mxCfg;
|
private MatrixConfig mxCfg;
|
||||||
@@ -59,11 +54,6 @@ public abstract class SqlThreePidProvider implements IThreePidProvider, ProfileP
|
|||||||
this.mxCfg = mxCfg;
|
this.mxCfg = mxCfg;
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
|
||||||
public boolean isEnabled() {
|
|
||||||
return cfg.isEnabled();
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public boolean isLocal() {
|
public boolean isLocal() {
|
||||||
return true;
|
return true;
|
||||||
@@ -90,11 +80,11 @@ public abstract class SqlThreePidProvider implements IThreePidProvider, ProfileP
|
|||||||
log.info("Found match: {}", uid);
|
log.info("Found match: {}", uid);
|
||||||
if (StringUtils.equals("uid", cfg.getIdentity().getType())) {
|
if (StringUtils.equals("uid", cfg.getIdentity().getType())) {
|
||||||
log.info("Resolving as localpart");
|
log.info("Resolving as localpart");
|
||||||
return Optional.of(new SingleLookupReply(request, new MatrixID(uid, mxCfg.getDomain())));
|
return Optional.of(new SingleLookupReply(request, MatrixID.asAcceptable(uid, mxCfg.getDomain())));
|
||||||
}
|
}
|
||||||
if (StringUtils.equals("mxid", cfg.getIdentity().getType())) {
|
if (StringUtils.equals("mxid", cfg.getIdentity().getType())) {
|
||||||
log.info("Resolving as MXID");
|
log.info("Resolving as MXID");
|
||||||
return Optional.of(new SingleLookupReply(request, new MatrixID(uid)));
|
return Optional.of(new SingleLookupReply(request, MatrixID.asAcceptable(uid)));
|
||||||
}
|
}
|
||||||
|
|
||||||
log.info("Identity type is unknown, skipping");
|
log.info("Identity type is unknown, skipping");
|
||||||
@@ -114,31 +104,4 @@ public abstract class SqlThreePidProvider implements IThreePidProvider, ProfileP
|
|||||||
return new ArrayList<>();
|
return new ArrayList<>();
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
|
||||||
public List<_ThreePid> getThreepids(_MatrixID mxid) {
|
|
||||||
List<_ThreePid> threepids = new ArrayList<>();
|
|
||||||
|
|
||||||
String stmtSql = cfg.getProfile().getThreepid().getQuery();
|
|
||||||
try (Connection conn = pool.get()) {
|
|
||||||
PreparedStatement stmt = conn.prepareStatement(stmtSql);
|
|
||||||
stmt.setString(1, mxid.getId());
|
|
||||||
|
|
||||||
ResultSet rSet = stmt.executeQuery();
|
|
||||||
while (rSet.next()) {
|
|
||||||
String medium = rSet.getString("medium");
|
|
||||||
String address = rSet.getString("address");
|
|
||||||
threepids.add(new ThreePid(medium, address));
|
|
||||||
}
|
|
||||||
|
|
||||||
return threepids;
|
|
||||||
} catch (SQLException e) {
|
|
||||||
throw new RuntimeException(e);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override
|
|
||||||
public List<String> getRoles(_MatrixID mxid) {
|
|
||||||
return Collections.emptyList();
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
}
|
||||||
|
@@ -1,69 +0,0 @@
|
|||||||
/*
|
|
||||||
* mxisd - Matrix Identity Server Daemon
|
|
||||||
* Copyright (C) 2017 Maxime Dor
|
|
||||||
*
|
|
||||||
* https://max.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 io.kamax.mxisd.config.MatrixConfig;
|
|
||||||
import io.kamax.mxisd.config.sql.GenericSqlProviderConfig;
|
|
||||||
import io.kamax.mxisd.config.sql.synapse.SynapseSqlProviderConfig;
|
|
||||||
import io.kamax.mxisd.exception.ConfigurationException;
|
|
||||||
import org.apache.commons.lang.StringUtils;
|
|
||||||
import org.springframework.beans.factory.annotation.Autowired;
|
|
||||||
import org.springframework.stereotype.Component;
|
|
||||||
|
|
||||||
import java.sql.PreparedStatement;
|
|
||||||
import java.sql.SQLException;
|
|
||||||
|
|
||||||
@Component
|
|
||||||
public class SynapseSqlDirectoryProvider extends GenericSqlDirectoryProvider {
|
|
||||||
|
|
||||||
@Autowired
|
|
||||||
public SynapseSqlDirectoryProvider(SynapseSqlProviderConfig cfg, MatrixConfig mxCfg) {
|
|
||||||
super(cfg, mxCfg);
|
|
||||||
|
|
||||||
if (StringUtils.equals("sqlite", cfg.getType())) {
|
|
||||||
String userId = "'@' || p.user_id || ':" + mxCfg.getDomain() + "'";
|
|
||||||
GenericSqlProviderConfig.Type queries = cfg.getDirectory().getQuery();
|
|
||||||
queries.getName().setValue(
|
|
||||||
"select " + userId + ", displayname from profiles p where displayname like ?");
|
|
||||||
queries.getThreepid().setValue(
|
|
||||||
"select t.user_id, p.displayname " +
|
|
||||||
"from user_threepids t JOIN profiles p on t.user_id = " + userId + " " +
|
|
||||||
"where t.address like ?");
|
|
||||||
} else if (StringUtils.equals("postgresql", cfg.getType())) {
|
|
||||||
String userId = "concat('@',p.user_id,':" + mxCfg.getDomain() + "')";
|
|
||||||
GenericSqlProviderConfig.Type queries = cfg.getDirectory().getQuery();
|
|
||||||
queries.getName().setValue(
|
|
||||||
"select " + userId + ", displayname from profiles p where displayname ilike ?");
|
|
||||||
queries.getThreepid().setValue(
|
|
||||||
"select t.user_id, p.displayname " +
|
|
||||||
"from user_threepids t JOIN profiles p on t.user_id = " + userId + " " +
|
|
||||||
"where t.address ilike ?");
|
|
||||||
} else {
|
|
||||||
throw new ConfigurationException("Invalid SQL type");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override
|
|
||||||
protected void setParameters(PreparedStatement stmt, String searchTerm) throws SQLException {
|
|
||||||
stmt.setString(1, "%" + searchTerm + "%");
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
@@ -1,8 +1,8 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2017 Maxime Dor
|
* Copyright (C) 2017 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://max.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU Affero General Public License as
|
* it under the terms of the GNU Affero General Public License as
|
||||||
@@ -18,36 +18,31 @@
|
|||||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package io.kamax.mxisd.backend.sql;
|
package io.kamax.mxisd.backend.sql.generic;
|
||||||
|
|
||||||
import io.kamax.matrix._MatrixID;
|
import io.kamax.matrix._MatrixID;
|
||||||
import io.kamax.mxisd.auth.provider.AuthenticatorProvider;
|
import io.kamax.mxisd.auth.provider.AuthenticatorProvider;
|
||||||
import io.kamax.mxisd.auth.provider.BackendAuthResult;
|
import io.kamax.mxisd.auth.provider.BackendAuthResult;
|
||||||
import io.kamax.mxisd.config.ServerConfig;
|
import io.kamax.mxisd.config.sql.generic.GenericSqlProviderConfig;
|
||||||
import io.kamax.mxisd.config.sql.GenericSqlProviderConfig;
|
|
||||||
import io.kamax.mxisd.invitation.InvitationManager;
|
import io.kamax.mxisd.invitation.InvitationManager;
|
||||||
import org.slf4j.Logger;
|
import org.slf4j.Logger;
|
||||||
import org.slf4j.LoggerFactory;
|
import org.slf4j.LoggerFactory;
|
||||||
import org.springframework.beans.factory.annotation.Autowired;
|
|
||||||
import org.springframework.stereotype.Component;
|
|
||||||
|
|
||||||
@Component
|
|
||||||
public class GenericSqlAuthProvider implements AuthenticatorProvider {
|
public class GenericSqlAuthProvider implements AuthenticatorProvider {
|
||||||
|
|
||||||
private Logger log = LoggerFactory.getLogger(GenericSqlAuthProvider.class);
|
private transient final Logger log = LoggerFactory.getLogger(GenericSqlAuthProvider.class);
|
||||||
|
|
||||||
@Autowired
|
|
||||||
private ServerConfig srvCfg;
|
|
||||||
|
|
||||||
@Autowired
|
|
||||||
private GenericSqlProviderConfig cfg;
|
private GenericSqlProviderConfig cfg;
|
||||||
|
|
||||||
@Autowired
|
|
||||||
private InvitationManager invMgr;
|
private InvitationManager invMgr;
|
||||||
|
|
||||||
|
public GenericSqlAuthProvider(GenericSqlProviderConfig cfg, InvitationManager invMgr) {
|
||||||
|
this.cfg = cfg;
|
||||||
|
this.invMgr = invMgr;
|
||||||
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public boolean isEnabled() {
|
public boolean isEnabled() {
|
||||||
return cfg.isEnabled();
|
return cfg.getAuth().isEnabled();
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
@@ -1,8 +1,8 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2017 Maxime Dor
|
* Copyright (C) 2017 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://max.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU Affero General Public License as
|
* it under the terms of the GNU Affero General Public License as
|
||||||
@@ -18,15 +18,16 @@
|
|||||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package io.kamax.mxisd.backend.sql;
|
package io.kamax.mxisd.backend.sql.generic;
|
||||||
|
|
||||||
import io.kamax.matrix.MatrixID;
|
import io.kamax.matrix.MatrixID;
|
||||||
|
import io.kamax.mxisd.backend.sql.SqlConnectionPool;
|
||||||
import io.kamax.mxisd.config.MatrixConfig;
|
import io.kamax.mxisd.config.MatrixConfig;
|
||||||
import io.kamax.mxisd.config.sql.GenericSqlProviderConfig;
|
|
||||||
import io.kamax.mxisd.config.sql.SqlConfig;
|
import io.kamax.mxisd.config.sql.SqlConfig;
|
||||||
import io.kamax.mxisd.controller.directory.v1.io.UserDirectorySearchResult;
|
import io.kamax.mxisd.config.sql.generic.GenericSqlProviderConfig;
|
||||||
import io.kamax.mxisd.directory.IDirectoryProvider;
|
import io.kamax.mxisd.directory.DirectoryProvider;
|
||||||
import io.kamax.mxisd.exception.InternalServerError;
|
import io.kamax.mxisd.exception.InternalServerError;
|
||||||
|
import io.kamax.mxisd.http.io.UserDirectorySearchResult;
|
||||||
import org.apache.commons.lang.StringUtils;
|
import org.apache.commons.lang.StringUtils;
|
||||||
import org.slf4j.Logger;
|
import org.slf4j.Logger;
|
||||||
import org.slf4j.LoggerFactory;
|
import org.slf4j.LoggerFactory;
|
||||||
@@ -37,14 +38,14 @@ import java.sql.ResultSet;
|
|||||||
import java.sql.SQLException;
|
import java.sql.SQLException;
|
||||||
import java.util.Optional;
|
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 SqlConfig cfg;
|
||||||
private MatrixConfig mxCfg;
|
protected MatrixConfig mxCfg;
|
||||||
|
|
||||||
private SqlConnectionPool pool;
|
private SqlConnectionPool pool;
|
||||||
|
|
||||||
@@ -54,11 +55,6 @@ public abstract class GenericSqlDirectoryProvider implements IDirectoryProvider
|
|||||||
this.mxCfg = mxCfg;
|
this.mxCfg = mxCfg;
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
|
||||||
public boolean isEnabled() {
|
|
||||||
return cfg.isEnabled();
|
|
||||||
}
|
|
||||||
|
|
||||||
protected void setParameters(PreparedStatement stmt, String searchTerm) throws SQLException {
|
protected void setParameters(PreparedStatement stmt, String searchTerm) throws SQLException {
|
||||||
for (int i = 1; i <= stmt.getParameterMetaData().getParameterCount(); i++) {
|
for (int i = 1; i <= stmt.getParameterMetaData().getParameterCount(); i++) {
|
||||||
stmt.setString(i, searchTerm);
|
stmt.setString(i, searchTerm);
|
||||||
@@ -85,7 +81,7 @@ public abstract class GenericSqlDirectoryProvider implements IDirectoryProvider
|
|||||||
while (rSet.next()) {
|
while (rSet.next()) {
|
||||||
processRow(rSet).ifPresent(e -> {
|
processRow(rSet).ifPresent(e -> {
|
||||||
if (StringUtils.equalsIgnoreCase("localpart", query.getType())) {
|
if (StringUtils.equalsIgnoreCase("localpart", query.getType())) {
|
||||||
e.setUserId(new MatrixID(e.getUserId(), mxCfg.getDomain()).getId());
|
e.setUserId(MatrixID.asAcceptable(e.getUserId(), mxCfg.getDomain()).getId());
|
||||||
}
|
}
|
||||||
result.addResult(e);
|
result.addResult(e);
|
||||||
});
|
});
|
@@ -0,0 +1,32 @@
|
|||||||
|
/*
|
||||||
|
* 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.backend.sql.SqlProfileProvider;
|
||||||
|
import io.kamax.mxisd.config.sql.generic.GenericSqlProviderConfig;
|
||||||
|
|
||||||
|
public class GenericSqlProfileProvider extends SqlProfileProvider {
|
||||||
|
|
||||||
|
public GenericSqlProfileProvider(GenericSqlProviderConfig cfg) {
|
||||||
|
super(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.getInvitationManager()));
|
||||||
|
}
|
||||||
|
|
||||||
|
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()));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@@ -1,8 +1,8 @@
|
|||||||
/*
|
/*
|
||||||
* mxisd - Matrix Identity Server Daemon
|
* mxisd - Matrix Identity Server Daemon
|
||||||
* Copyright (C) 2017 Maxime Dor
|
* Copyright (C) 2017 Kamax Sarl
|
||||||
*
|
*
|
||||||
* https://max.kamax.io/
|
* https://www.kamax.io/
|
||||||
*
|
*
|
||||||
* This program is free software: you can redistribute it and/or modify
|
* This program is free software: you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU Affero General Public License as
|
* it under the terms of the GNU Affero General Public License as
|
||||||
@@ -18,17 +18,14 @@
|
|||||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package io.kamax.mxisd.backend.sql;
|
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.MatrixConfig;
|
||||||
import io.kamax.mxisd.config.sql.GenericSqlProviderConfig;
|
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 {
|
public class GenericSqlThreePidProvider extends SqlThreePidProvider {
|
||||||
|
|
||||||
@Autowired
|
|
||||||
public GenericSqlThreePidProvider(GenericSqlProviderConfig cfg, MatrixConfig mxCfg) {
|
public GenericSqlThreePidProvider(GenericSqlProviderConfig cfg, MatrixConfig mxCfg) {
|
||||||
super(cfg, mxCfg);
|
super(cfg, mxCfg);
|
||||||
}
|
}
|
@@ -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.synapse;
|
||||||
|
|
||||||
|
import io.kamax.mxisd.backend.sql.SqlConnectionPool;
|
||||||
|
import io.kamax.mxisd.config.sql.synapse.SynapseSqlProviderConfig;
|
||||||
|
|
||||||
|
import java.sql.PreparedStatement;
|
||||||
|
import java.sql.ResultSet;
|
||||||
|
import java.util.Optional;
|
||||||
|
|
||||||
|
public class Synapse {
|
||||||
|
|
||||||
|
private SqlConnectionPool pool;
|
||||||
|
|
||||||
|
public Synapse(SynapseSqlProviderConfig sqlCfg) {
|
||||||
|
this.pool = new SqlConnectionPool(sqlCfg);
|
||||||
|
}
|
||||||
|
|
||||||
|
public Optional<String> getRoomName(String id) {
|
||||||
|
return pool.withConnFunction(conn -> {
|
||||||
|
PreparedStatement stmt = conn.prepareStatement(SynapseQueries.getRoomName());
|
||||||
|
stmt.setString(1, id);
|
||||||
|
ResultSet rSet = stmt.executeQuery();
|
||||||
|
if (!rSet.next()) {
|
||||||
|
return Optional.empty();
|
||||||
|
}
|
||||||
|
|
||||||
|
return Optional.ofNullable(rSet.getString(1));
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user