apply Apache License

MatrixConnection.php

@@ -1,5 +1,4 @@
 <?php
-
 /**
  * Copyright 2018 Matthias Kesler
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,8 +13,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-class MatrixConnection {
+class MatrixConnection
-
+{
 	private $hs;
 	private $at;
 
@@ -108,6 +107,7 @@ class MatrixConnection {
 
 	function exec_curl_request($handle) {
 		$response = curl_exec($handle);
+
 		if ($response === false) {
 			$errno = curl_errno($handle);
 			$error = curl_error($handle);
@@ -115,6 +115,7 @@ class MatrixConnection {
 			curl_close($handle);
 			return false;
 		}
+
 		$http_code = intval(curl_getinfo($handle, CURLINFO_HTTP_CODE));
 		curl_close($handle);
 
@@ -131,13 +132,13 @@ class MatrixConnection {
 		} else {
 			$response = json_decode($response, true);
 		}
+
 		return $response;
 	}
-
 }
 
-class MatrixMessage {
+class MatrixMessage
-
+{
 	private $message;
 
 	function __construct() {
@@ -164,7 +165,5 @@ class MatrixMessage {
 	function get_object() {
 		return $this->message;
 	}
-
 }
-
 ?>

README.md

@@ -14,34 +14,17 @@ This is done in several steps:
 
 2nd step: Implement the other apis to integrade [mxisd](https://github.com/kamax-io/mxisd/blob/master/docs/backends/rest.md)
 
-This bot takes care for user accounts. So it stores the credentials itself and provides ways to access them via matrix-synapse-rest-auth or mxisd.
 ## How to install
 
 - Copy `config.sample.php` to `config.php` and configure the bot as you can find there
-- Configure your webserver to publish the folder `public`.
+- Configure your webserver to publish the folder `public` and configure.
-  The folder `internal` contains files that can be accessed by mxisd or matrix-synapse-rest-auth or else via a reverse proxy
+  The folder `internal` contains files that can be accessed by mxisd or matrix-synapse-rest-auth
-- To integrate with [matrix-synapse-rest-auth](https://github.com/kamax-io/matrix-synapse-rest-auth):
+- To integrate with matrix-synapse-rest-auth:
   - `/_matrix-internal/identity/v1/check_credentials` should map to `internal/login.php`
-- To integrate with [mxisd](https://github.com/kamax-io/mxisd): Have a look at [the docs](https://github.com/kamax-io/mxisd/blob/master/docs/backends/rest.md) and apply as follows:
+- To integrate with mxisd: Have a look at [the docs](https://github.com/kamax-io/mxisd/blob/master/docs/backends/rest.md) and apply as follows:
-
-
 | Key                            | file which handles that       | Description                                          |
 |--------------------------------|-------------------------------|------------------------------------------------------|
 | rest.endpoints.auth            | internal/login.php            | Validate credentials and get user profile            |
 | rest.endpoints.directory       | internal/directory_search.php | Search for users by arbitrary input                  |
 | rest.endpoints.identity.single | internal/identity_single.php  | Endpoint to query a single 3PID                      |
 | rest.endpoints.identity.bulk   | internal/identity_bulk.php    | Endpoint to query a list of 3PID                     |
-
-
-## Implement usage of additional features:
-### Use the ChangePasswortInterceptor:
-
-You need a reverse proxy which maps `/_matrix/client/r0/account/password` to `internal/intercept_change_password.php`.
-Here is an example for nginx:
-
-```
-        location /_matrix/client/r0/account/password {
-                proxy_pass http://localhost/mxbot/internal/intercept_change_password.php;
-                proxy_set_header X-Forwarded-For $remote_addr;
-        }
-```

config.sample.php

@@ -1,18 +1,22 @@
 <?php
-
 $config = [
 	"homeserver" => "example.com",
 	"access_token" => "To be used for sending the registration notification",
+
 	// Which e-mail-adresse shall the bot use to send e-mails?
 	"register_email" => 'register_bot@example.com',
 	// Where should the bot post registration requests to?
 	"register_room" => '$registerRoomID:example.com',
+
 	// Where is the public part of the bot located? make sure you have a / at the end
 	"webroot" => "https://myregisterdomain.net/",
+
 	// optional: Do you have a place where howTo's are located? If not leave this value out
 	"howToURL" => "https://my-url-for-storing-howTos.net",
+
 	// When you want to collect the password on registration set this to true
 	"getPasswordOnRegistration" => false,
+
 	// to define where the data should be stored:
 	"databaseURI" => "sqlite:" . dirname(__FILE__) . "/db_file.sqlite",
 	// credentials for sqlite not used

cron.php

@@ -1,5 +1,4 @@
 <?php
-
 /**
  * Copyright 2018 Matthias Kesler
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -37,7 +36,10 @@ foreach ($mx_db->query($sql) as $row) {
 			case RegisterState::PendingEmailSend:
 				$verify_url = $config["webroot"] . "/verify.php?t=" . $row["verify_token"];
 				$success = send_mail_pending_verification(
-                        $config["homeserver"], $row["first_name"] . " " . $row["last_name"], $row["email"], $verify_url);
+						$config["homeserver"],
+						$row["first_name"] . " " . $row["last_name"],
+						$row["email"],
+						$verify_url);
 
 				if ($success) {
 					$mx_db->setRegistrationStateById(RegisterState::PendingEmailVerify, $row["id"]);

database.php

@@ -1,5 +1,4 @@
 <?php
-
 /**
  * Copyright 2018 Matthias Kesler
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -19,8 +18,8 @@ if (!isset($config["databaseURI"])) {
 	throw new Exception ("malformed configuration: databaseURI not defined");
 }
 
-abstract class RegisterState {
+abstract class RegisterState
-
+{
 	// Sending an E-Mail failed in the first attempt. Will retry later
 	const PendingEmailSend = 0;
 	// User got a mail. We wait for it to verfiy
@@ -31,19 +30,21 @@ abstract class RegisterState {
 	const PendingAdminVerify = 6;
 	// Registration failed on first attempt. Will retry
 	const PendingRegistration = 7;
+
 	// in this case we have to reset the password of the user (or should we store it for this case?)
 	const PendingSendRegistrationMail = 8;
+
 	// State to allow persisting in the database although an admin declined it.
 	// Will be removed regularly
 	const RegistrationAccepted = 7;
 	const RegistrationDeclined = 13;
+
 	// User got successfully registered. Will be cleaned up later
 	const AllDone = 100;
-
 }
 
-class mxDatabase {
+class mxDatabase
-
+{
 	private $db = NULL;
 
 	/**
@@ -163,7 +164,6 @@ class mxDatabase {
 		}
 		return false;
 	}
-
 	function userRegistered($username) {
 		$sql = "SELECT COUNT(*) FROM logins WHERE localpart = '" . $username . "' LIMIT 1;";
 		$res = $this->db->query($sql);
@@ -215,6 +215,7 @@ class mxDatabase {
 		$sql = "SELECT COUNT(*) FROM registrations WHERE admin_token = '" . $admin_token . "'"
 			. " AND state = " . RegisterState::PendingAdminVerify . " LIMIT 1;";
 		$res = $this->db->query($sql);
+		$first_name = NULL; $last_name = NULL; $username = NULL; $note = NULL; $email = NULL;
 
 		if ($res->fetchColumn() > 0) {
 			$sql = "SELECT first_name, last_name, username, note, email FROM registrations"
@@ -239,6 +240,7 @@ class mxDatabase {
 		$sql = "SELECT COUNT(*) FROM registrations WHERE verify_token = '" . $verify_token . "'"
 			. " AND state = " . RegisterState::PendingEmailVerify . " LIMIT 1;";
 		$res = $this->db->query($sql);
+		$first_name = NULL; $last_name = NULL; $username = NULL; $note = NULL; $email = NULL;
 
 		if ($res->fetchColumn() > 0) {
 			$sql = "SELECT first_name, last_name, note, email, admin_token FROM registrations "
@@ -302,24 +304,6 @@ class mxDatabase {
 		return NULL;
 	}
 
-    function updatePassword($localpart, $old_password, $new_password) {
-        $user = $this->getUserForLogin($localpart, $old_password);
-        if ($user == NULL) {
-            throw new Exception("user with that credentials not found");
-        }
-
-        // The credentials were fine. So now set the new password
-        $password_hash = password_hash($new_password, PASSWORD_BCRYPT, ["cost" => 12]);
-
-        $sql = "UPDATE logins SET password_hash = '" . $password_hash . "'"
-                . "WHERE localpart = '" . $localpart . "'";
-
-        if ($this->db->exec($sql)) {
-            return true;
-        }
-        return false;
-    }
-
 	function searchUserByName($search_term) {
 		$term = filter_var($search_term, FILTER_SANITIZE_STRING);
 		$result = array();
@@ -359,7 +343,6 @@ class mxDatabase {
 		}
 		return $result;
 	}
-
 }
 
 if (!isset($mx_db)) {

helpers.php

@@ -1,33 +0,0 @@
-<?php
-
-/**
- * Copyright 2018 Matthias Kesler
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- * http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-function stripLocalpart($mxid) {
-    $localpart = NULL;
-    if (!empty($mxid)) {
-        // A mxid would start with an @ so we start at the 2. position
-        $sepPos = strpos($mxid, ':', 1);
-        if ($sepPos === false) {
-            // : not found. Assume mxid is localpart
-            // TODO: further checks
-            $localpart = $mxid;
-        } else {
-            $localpart = substr($mxid, 1, strpos($mxid, ':') - 1);
-        }
-    }
-    return $localpart;
-}
-
-?>

internal/directory_search.php

@@ -1,5 +1,4 @@
 <?php
-
 /**
  * Copyright 2018 Matthias Kesler
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -40,8 +39,9 @@ try {
             $response["result"] = $mx_db->searchUserByEmail($input["search_term"]);
             break;
         default:
-            throw new Exception('unknown type for "by" param');
+            throw new Exception("unknown type for \"by\" param");
     }
+    
 } catch (Exception $e) {
     error_log("failed with error: " . $e->getMessage());
     $response["error"] = $e->getMessage();

internal/identity_bulk.php

@@ -1,5 +1,4 @@
 <?php
-
 /**
  * Copyright 2018 Matthias Kesler
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -38,7 +37,7 @@ try {
         if (!isset($lookup["address"])) {
             throw new Exception('"lookup.address" is not defined');
         }
-        $res2 = NULL;
+        $res2 = array();
         switch ($lookup["medium"]) {
             case "email":
                 $res2 = $mx_db->searchUserByEmail($lookup["address"]);
@@ -55,11 +54,9 @@ try {
                 }
 		break;
             case "msisdn":
-                // This is reserved for number lookups
-                throw new Exception("unimplemented lookup medium");
                 break;
             default:
-                throw new Exception("unknown lookup medium");
+                throw new Exception("unknown type for \"by\" param");
         }
     }
 } catch (Exception $e) {

internal/identity_single.php

@@ -1,5 +1,4 @@
 <?php
-
 /**
  * Copyright 2018 Matthias Kesler
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -31,7 +30,7 @@ try {
     if (!isset($input["lookup"]["address"])) {
         throw new Exception('"lookup.address" is not defined');
     }
-    $res2 = NULL;
+    $res2 = array();
     switch ($input["lookup"]["medium"]) {
         case "email":
             $res2 = $mx_db->searchUserByEmail($input["lookup"]["address"]);
@@ -47,19 +46,15 @@ try {
                     ]
                 ];
             }
-            break;
+            
-        case "msisdn":
+
-            // This is reserved for number lookups
-            throw new Exception("unimplemented lookup medium");
             break;
         default:
-            throw new Exception("unknown lookup medium");
+            throw new Exception("unknown type for \"by\" param");
     }
 } catch (Exception $e) {
-    error_log("ídentity_single failed with error: " . $e->getMessage());
+    error_log("ídentity_bulk failed with error: " . $e->getMessage());
-    $response = [
+    $response["error"] = $e->getMessage();
-        "error" => $e->getMessage()
-    ];
 }
 print (json_encode($response, JSON_PRETTY_PRINT) . "\n");
 ?>

internal/intercept_change_password.php

@@ -1,69 +0,0 @@
-<?php
-
-/**
- * Copyright 2018 Matthias Kesler
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-// URL for this: /_matrix/client/r0/account/password?access_token=$ACCESS_TOKEN
-
-header('Access-Control-Allow-Origin: *');
-header('Access-Control-Allow-Methods: POST, OPTIONS');
-header('Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization');
-if ($_SERVER['REQUEST_METHOD'] === 'OPTIONS') {
-    print ("{}");
-    // return with success
-    exit();
-}
-$response = new stdClass;
-try {
-    $inputJSON = file_get_contents('php://input');
-    $input = json_decode($inputJSON, TRUE);
-    if (empty($input)) {
-        throw new Exception('no valid json as input present');
-    }
-    if (!isset($input["auth"])) {
-        throw new Exception('"auth" is not defined');
-    }
-    if (!isset($input["auth"]["user"]) || !isset($input["auth"]["password"])) {
-        throw new Exception('"auth.user" or "auth.password" is not defined');
-    }
-    if (!isset($input["auth"]["type"]) || $input["auth"]["type"] !== "m.login.password") {
-        throw new Exception('no or unknown auth.type');
-    }
-    if (!isset($input["new_password"])) {
-        throw new Exception('"new_password" is not defined');
-    }
-
-    require_once("../helpers.php");
-    $localpart = stripLocalpart($input["auth"]["user"]);
-
-    if (empty($localpart)) {
-        throw new Exception("localpart cannot be identified");
-    }
-
-    require_once("../database.php");
-    if (!$mx_db->updatePassword(
-                    $localpart, $input["auth"]["password"], $input["new_password"]
-            )) {
-        throw new Exception("invalid credentials or another error while updating");
-    }
-} catch (Exception $e) {
-    header("HTTP/1.0 500 Internal Error");
-    error_log("failed with error: " . $e->getMessage());
-    $response = [
-        "errorcode" => "M_UNKNOWN",
-        "error" => $e->getMessage(),
-    ];
-}
-print (json_encode($response, JSON_PRETTY_PRINT));
-?>

internal/login.php

@@ -1,5 +1,4 @@
 <?php
-
 /**
  * Copyright 2018 Matthias Kesler
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,21 +20,18 @@ $response = [
 ];
 
 require_once("../database.php");
-
 abstract class LoginRequester {
-
     const UNDEFINED = 0;
     const MXISD = 1;
     const RestAuth = 2;
-
 }
-
 $loginRequester = LoginRequester::UNDEFINED;
 
 try {
     $inputJSON = file_get_contents('php://input');
     $input = json_decode($inputJSON, TRUE);
-    $mxid = $localpart = NULL;
+    $mxid = NULL;
+    $localpart = NULL;
     if (isset($input["user"])) {
         if (isset($input["user"]["localpart"])) {
             $localpart = $input["user"]["localpart"];
@@ -49,15 +45,20 @@ try {
             $mxid = $input["user"]["mxid"];
             $loginRequester = LoginRequester::MXISD;
         }
-    } else {
-        throw new Exception('"user" not in request body');
     }
 
     // prefer the localpart attribute of mxisd. But in case of matrix-synapse-rest-auth
     // we have to parse it on our own
-    if (empty($localpart)) {
+    if (empty($localpart) && !empty($mxid)) {
-        require_once("../helpers.php");
+        // A mxid would start with an @ so we start at the 2. position
-        $localpart = stripLocalpart($mxid);
+        $sepPos = strpos($mxid,':', 1);
+        if ($sepPos === false) {
+            // : not found. Assume mxid is localpart
+            // TODO: further checks
+            $localpart = $mxid;
+        } else {
+            $localpart = substr($mxid, 1, strpos($mxid,':') - 1 );
+        }
     }
     
     if (empty($localpart)) {
@@ -65,7 +66,7 @@ try {
     }
     
     $password = NULL;
-    if (isset($input["user"]["password"])) {
+    if (isset($input["user"]) && isset($input["user"]["password"])) {
         $password = $input["user"]["password"];
     }
     if (empty($password)) {
@@ -101,7 +102,6 @@ try {
             // only return that it was successful.
             // we do not know how the data shall be transmitted so we do nothing with it
             $response["auth"]["success"] = false;
-            $response["auth"]["error"] = "unidentified requester";
             break;
     }    
 } catch (Exception $e) {

lang/lang.de-de.php

@@ -1,5 +1,4 @@
 <?php
-
 /**
  * Copyright 2018 Matthias Kesler
  * Licensed under the Apache License, Version 2.0 (the "License");

language.php

@@ -1,5 +1,4 @@
 <?php
-
 /**
  * Copyright 2018 Matthias Kesler
  * Licensed under the Apache License, Version 2.0 (the "License");

mail_templates.php

@@ -1,5 +1,4 @@
 <?php
-
 /**
  * Copyright 2018 Matthias Kesler
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -69,6 +68,7 @@ Wir melden uns, wenn die Registrierung erfolgreich war.
 
 Das Administratoren-Team von " . $homeserver;
 	return send_mail($receiver, $subject, $body);
+
 }
 
 function send_mail_registration_success($homeserver, $user, $receiver, $username, $password, $howToURL) {
@@ -81,8 +81,8 @@ Zum Anmelden kannst du folgende Zugangsdaten verwenden:
 Nutzername: $username
 Passwort: $password
 
-Hinweis: Das Passwort kannst du aktuell über die App selbst ändern. Auch wenn das Passwort nirgends
+Hinweis: Aktuell ist es nicht möglich, das Passwort selbst zu ändern. Sobald die Funktionalität zur
-im Klartext gespeichert wird, kann jemand Zugriff auf diese Mail erlangen und so den Zugriff bekommen.
+Verfügung steht, gibt es aber einen Hinweis.
 ";
 /*
 Wichtig: Bitte ändere das Passwort direkt nach der Anmeldung.
@@ -101,8 +101,8 @@ Bei Fragen findest du nach der Anmeldung ein paar Räume in denen du sie stellen
 
 Das Administratoren-Team von " . $homeserver;
 	return send_mail($receiver, $subject, $body);
-}
 
+}
 function send_mail_registration_decline($homeserver, $user, $receiver, $reason) {
 	$subject = "Registrierung auf $homeserver abgelehnt.";
 	$body = "Guten Tag " . $user . ",
@@ -118,5 +118,4 @@ Deine Registrierungsanfrage wurde durch die Administratoren abgelehnt.\n";
 	$body .= "\nDas Administratoren-Team von " . $homeserver;
 	return send_mail($receiver, $subject, $body );
 }
-
 ?>