Add "internal" keys - these do not show up on the API but are valid f…

…or authenticating the request. #35
mydnshost · Nov 11, 2018 · 5f45229 · 5f45229
1 parent c456696
commit 5f45229
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 0 deletions.
diff --git a/admin/init_functions.php b/admin/init_functions.php
@@ -375,6 +375,16 @@ public function run($pdo) {
 			$dataChanges[22] = new DBChange(<<<MYSQLQUERY
 ALTER TABLE `twofactorkeys` ADD COLUMN `expires` int(11) NOT NULL DEFAULT '0' AFTER `lastused`;
 MYSQLQUERY
+);
+
+			// ------------------------------------------------------------------------
+			// 2FA Key "internal" keys.
+			// ------------------------------------------------------------------------
+			$dataChanges[23] = new DBChange(<<<MYSQLQUERY
+ALTER TABLE `twofactorkeys`
+  ADD COLUMN `internal` ENUM('false', 'true') NOT NULL DEFAULT 'false' AFTER `onetime`,
+  ADD COLUMN `internaldata` TEXT AFTER `internal`;
+MYSQLQUERY
 );
 
 			return $dataChanges;

diff --git a/classes/twofactorkey.php b/classes/twofactorkey.php
@@ -14,6 +14,8 @@ class TwoFactorKey extends DBObject {
 	                             'active' => false,
 	                             'type' => 'rfc6238',
 	                             'onetime' => false,
+	                             'internal' => false,
+	                             'internaldata' => NULL,
 	                            ];
 	protected static $_key = 'id';
 	protected static $_table = 'twofactorkeys';
@@ -74,6 +76,14 @@ public function setOneTime($value) {
 		return $this->setData('onetime', parseBool($value) ? 'true' : 'false');
 	}
 
+	public function setInternal($value) {
+		return $this->setData('internal', parseBool($value) ? 'true' : 'false');
+	}
+
+	public function setInternalData($value) {
+		return $this->setData('internaldata', $value);
+	}
+
 	public function getID() {
 		return $this->getData('id');
 	}
@@ -114,6 +124,14 @@ public function isOneTime() {
 		return parseBool($this->getData('onetime'));
 	}
 
+	public function isInternal() {
+		return parseBool($this->getData('internal'));
+	}
+
+	public function getInternalData() {
+		return parseBool($this->getData('internaldata'));
+	}
+
 	/**
 	 * Keys are usable if:
 	 *   - They are active

diff --git a/web/1.0/methods/useradmin.php b/web/1.0/methods/useradmin.php
@@ -435,9 +435,13 @@ protected function get2FAKeys($user) {
 
 			$result = [];
 			foreach ($keys as $k => $v) {
+				if ($v->isInternal()) { continue; }
+
 				$result[$k] = $v->toArray();
 				unset($result[$k]['id']);
 				unset($result[$k]['user_id']);
+				unset($result[$k]['internal']);
+				unset($result[$k]['internalmeta']);
 				if ($v->isActive()) {
 					unset($result[$k]['key']);
 				}
@@ -473,9 +477,12 @@ protected function get2FADevices($user) {
 		protected function get2FAKey($user, $key) {
 			$k = $key->toArray();
 			unset($k['user_id']);
+			unset($k['internal']);
+			unset($k['internaldata']);
 			if ($key->isActive()) {
 				unset($k['key']);
 			}
+			$k['usable'] = $key->isUsableKey();
 
 			$this->getContextKey('response')->data($k);