1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
<?php
class SetupApi extends Migration
{
public function description()
{
return 'Creates api tables in database and according config entries';
}
public function up()
{
$this->createTables();
// Add config entries
$query = "INSERT IGNORE INTO `config`
(`config_id`, `field`, `value`, `is_default`, `type`, `range`, `section`,
`mkdate`, `chdate`, `description`)
VALUES (MD5(:field), :field, :value, 1, :type, 'global', 'global',
UNIX_TIMESTAMP(), UNIX_TIMESTAMP(), :description)";
$statement = DBManager::get()->prepare($query);
$statement->execute([
':field' => 'API_ENABLED',
':value' => (int)false,
':type' => 'boolean',
':description' => 'Schaltet die REST-API an',
]);
$statement->execute([
':field' => 'API_OAUTH_AUTH_PLUGIN',
':value' => 'Standard',
':type' => 'string',
':description' => 'Definiert das für OAuth verwendete Authentifizierungsverfahren',
]);
}
public function down()
{
DBManager::get()->exec("DELETE FROM config WHERE field IN ('API_ENABLED', 'API_OAUTH_AUTH_PLUGIN')");
$this->dropTables();
}
public function createTables(): void
{
// Add vendor tables
$query = "CREATE TABLE IF NOT EXISTS `oauth_consumer_registry` (
`ocr_id` int(11) NOT NULL AUTO_INCREMENT,
`ocr_usa_id_ref` int(11) DEFAULT NULL,
`ocr_consumer_key` varchar(128) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL,
`ocr_consumer_secret` varchar(128) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL,
`ocr_signature_methods` varchar(128) NOT NULL DEFAULT 'HMAC-SHA1,PLAINTEXT',
`ocr_server_uri` varchar(128) NOT NULL,
`ocr_server_uri_host` varchar(128) NOT NULL,
`ocr_server_uri_path` varchar(128) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL,
`ocr_request_token_uri` varchar(255) NOT NULL,
`ocr_authorize_uri` varchar(255) NOT NULL,
`ocr_access_token_uri` varchar(255) NOT NULL,
`ocr_timestamp` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
PRIMARY KEY (`ocr_id`),
UNIQUE KEY `ocr_consumer_key` (`ocr_consumer_key`,`ocr_usa_id_ref`,`ocr_server_uri`),
KEY `ocr_server_uri` (`ocr_server_uri`),
KEY `ocr_server_uri_host` (`ocr_server_uri_host`,`ocr_server_uri_path`),
KEY `ocr_usa_id_ref` (`ocr_usa_id_ref`)
) ENGINE=MyISAM DEFAULT CHARSET=utf8";
DBManager::get()->exec($query);
$query = "CREATE TABLE IF NOT EXISTS `oauth_consumer_token` (
`oct_id` int(11) NOT NULL AUTO_INCREMENT,
`oct_ocr_id_ref` int(11) NOT NULL,
`oct_usa_id_ref` int(11) NOT NULL,
`oct_name` varchar(64) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL DEFAULT '',
`oct_token` varchar(128) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL,
`oct_token_secret` varchar(128) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL,
`oct_token_type` enum('request','authorized','access') DEFAULT NULL,
`oct_token_ttl` datetime NOT NULL DEFAULT '9999-12-31 00:00:00',
`oct_timestamp` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
PRIMARY KEY (`oct_id`),
UNIQUE KEY `oct_ocr_id_ref` (`oct_ocr_id_ref`,`oct_token`),
UNIQUE KEY `oct_usa_id_ref` (`oct_usa_id_ref`,`oct_ocr_id_ref`,`oct_token_type`,`oct_name`),
KEY `oct_token_ttl` (`oct_token_ttl`),
CONSTRAINT `oauth_consumer_token_ibfk_1` FOREIGN KEY (`oct_ocr_id_ref`) REFERENCES `oauth_consumer_registry` (`ocr_id`) ON DELETE CASCADE ON UPDATE CASCADE
) ENGINE=MyISAM DEFAULT CHARSET=utf8";
DBManager::get()->exec($query);
$query = "CREATE TABLE IF NOT EXISTS `oauth_log` (
`olg_id` int(11) NOT NULL AUTO_INCREMENT,
`olg_osr_consumer_key` varchar(64) CHARACTER SET utf8 COLLATE utf8_bin DEFAULT NULL,
`olg_ost_token` varchar(64) CHARACTER SET utf8 COLLATE utf8_bin DEFAULT NULL,
`olg_ocr_consumer_key` varchar(64) CHARACTER SET utf8 COLLATE utf8_bin DEFAULT NULL,
`olg_oct_token` varchar(64) CHARACTER SET utf8 COLLATE utf8_bin DEFAULT NULL,
`olg_usa_id_ref` int(11) DEFAULT NULL,
`olg_received` text NOT NULL,
`olg_sent` text NOT NULL,
`olg_base_string` text NOT NULL,
`olg_notes` text NOT NULL,
`olg_timestamp` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
`olg_remote_ip` bigint(20) NOT NULL,
PRIMARY KEY (`olg_id`),
KEY `olg_osr_consumer_key` (`olg_osr_consumer_key`,`olg_id`),
KEY `olg_ost_token` (`olg_ost_token`,`olg_id`),
KEY `olg_ocr_consumer_key` (`olg_ocr_consumer_key`,`olg_id`),
KEY `olg_oct_token` (`olg_oct_token`,`olg_id`),
KEY `olg_usa_id_ref` (`olg_usa_id_ref`,`olg_id`)
) ENGINE=MyISAM DEFAULT CHARSET=utf8";
DBManager::get()->exec($query);
$query = "CREATE TABLE IF NOT EXISTS `oauth_server_nonce` (
`osn_id` int(11) NOT NULL AUTO_INCREMENT,
`osn_consumer_key` varchar(64) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL,
`osn_token` varchar(64) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL,
`osn_timestamp` bigint(20) NOT NULL,
`osn_nonce` varchar(80) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL,
PRIMARY KEY (`osn_id`),
UNIQUE KEY `osn_consumer_key` (`osn_consumer_key`,`osn_token`,`osn_timestamp`,`osn_nonce`)
) ENGINE=MyISAM DEFAULT CHARSET=utf8";
DBManager::get()->exec($query);
$query = "CREATE TABLE IF NOT EXISTS `oauth_server_registry` (
`osr_id` int(11) NOT NULL AUTO_INCREMENT,
`osr_usa_id_ref` int(11) DEFAULT NULL,
`osr_consumer_key` varchar(64) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL,
`osr_consumer_secret` varchar(64) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL,
`osr_enabled` tinyint(1) NOT NULL DEFAULT '1',
`osr_status` varchar(16) NOT NULL,
`osr_requester_name` varchar(64) NOT NULL,
`osr_requester_email` varchar(64) NOT NULL,
`osr_callback_uri` varchar(255) NOT NULL,
`osr_application_uri` varchar(255) NOT NULL,
`osr_application_title` varchar(80) NOT NULL,
`osr_application_descr` text NOT NULL,
`osr_application_notes` text NOT NULL,
`osr_application_type` varchar(20) NOT NULL,
`osr_application_commercial` tinyint(1) NOT NULL DEFAULT '0',
`osr_issue_date` datetime NOT NULL,
`osr_timestamp` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
PRIMARY KEY (`osr_id`),
UNIQUE KEY `osr_consumer_key` (`osr_consumer_key`),
KEY `osr_usa_id_ref` (`osr_usa_id_ref`)
) ENGINE=MyISAM DEFAULT CHARSET=utf8";
DBManager::get()->exec($query);
$query = "CREATE TABLE IF NOT EXISTS `oauth_server_token` (
`ost_id` int(11) NOT NULL AUTO_INCREMENT,
`ost_osr_id_ref` int(11) NOT NULL,
`ost_usa_id_ref` int(11) NOT NULL,
`ost_token` varchar(64) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL,
`ost_token_secret` varchar(64) CHARACTER SET utf8 COLLATE utf8_bin NOT NULL,
`ost_token_type` enum('request','access') DEFAULT NULL,
`ost_authorized` tinyint(1) NOT NULL DEFAULT '0',
`ost_referrer_host` varchar(128) NOT NULL DEFAULT '',
`ost_token_ttl` datetime NOT NULL DEFAULT '9999-12-31 00:00:00',
`ost_timestamp` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
`ost_verifier` char(10) DEFAULT NULL,
`ost_callback_url` varchar(512) DEFAULT NULL,
PRIMARY KEY (`ost_id`),
UNIQUE KEY `ost_token` (`ost_token`),
KEY `ost_osr_id_ref` (`ost_osr_id_ref`),
KEY `ost_token_ttl` (`ost_token_ttl`),
CONSTRAINT `oauth_server_token_ibfk_1` FOREIGN KEY (`ost_osr_id_ref`) REFERENCES `oauth_server_registry` (`osr_id`) ON DELETE CASCADE ON UPDATE CASCADE
) ENGINE=MyISAM DEFAULT CHARSET=utf8";
DBManager::get()->exec($query);
// Add api tables
$query = "CREATE TABLE IF NOT EXISTS `api_consumer_permissions` (
`route_id` char(32) NOT NULL,
`consumer_id` char(32) NOT NULL DEFAULT '',
`method` char(6) NOT NULL,
`granted` tinyint(1) unsigned NOT NULL DEFAULT '0',
UNIQUE KEY `route_id` (`route_id`,`consumer_id`,`method`)
) ENGINE=MyISAM";
DBManager::get()->exec($query);
$query = "CREATE TABLE IF NOT EXISTS `api_consumers` (
`consumer_id` char(32) NOT NULL DEFAULT '',
`consumer_type` enum('http','studip','oauth') NOT NULL DEFAULT 'studip',
`auth_key` varchar(64) DEFAULT NULL,
`auth_secret` varchar(64) DEFAULT NULL,
`active` tinyint(1) unsigned NOT NULL DEFAULT '0',
`system` tinyint(1) unsigned NOT NULL DEFAULT '0',
`type` enum('website','mobile','desktop') DEFAULT 'website',
`title` varchar(128) DEFAULT NULL,
`contact` varchar(255) DEFAULT NULL,
`email` varchar(255) DEFAULT NULL,
`url` varchar(255) DEFAULT NULL,
`callback` varchar(255) DEFAULT NULL,
`commercial` tinyint(1) DEFAULT NULL,
`description` text,
`priority` int(11) unsigned NOT NULL DEFAULT '0',
`notes` text,
`mkdate` int(11) unsigned NOT NULL,
`chdate` int(11) unsigned NOT NULL,
PRIMARY KEY (`consumer_id`)
) ENGINE=MyISAM";
DBManager::get()->exec($query);
$query = "CREATE TABLE IF NOT EXISTS `api_oauth_user_mapping` (
`oauth_id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`user_id` char(32) NOT NULL DEFAULT '',
`mkdate` int(11) unsigned NOT NULL,
PRIMARY KEY (`oauth_id`)
) ENGINE=MyISAM";
DBManager::get()->exec($query);
$query = "CREATE TABLE IF NOT EXISTS `api_user_permissions` (
`user_id` char(32) NOT NULL DEFAULT '',
`consumer_id` char(32) NOT NULL DEFAULT '',
`granted` tinyint(1) unsigned NOT NULL DEFAULT '0',
`mkdate` int(11) unsigned NOT NULL,
`chdate` int(11) unsigned NOT NULL,
PRIMARY KEY (`user_id`,`consumer_id`)
) ENGINE=MyISAM";
DBManager::get()->exec($query);
}
public function dropTables(): void
{
DBManager::get()->exec("DROP TABLE IF EXISTS `oauth_consumer_token`,
`oauth_log`,
`oauth_server_nonce`,
`oauth_server_registry`,
`oauth_server_token`,
`oauth_consumer_registry`,
`api_consumer_permissions`,
`api_consumers`,
`api_oauth_user_mapping`,
`api_user_permissions`");
}
}
|
