Skip to content

Add support for turn:/turns: schemes on turn server settings #4715

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
plinss wants to merge 1 commit into from
Closed

Add support for turn:/turns: schemes on turn server settings #4715

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 30 additions & 38 deletions lib/Config.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,11 +145,23 @@ public function getAllServerUrlsForCSP(): array {
$urls = [];

foreach ($this->getStunServers() as $server) {
$urls[] = $server;
if (substr(strtolower($server), 0, 5) === 'stun:') {
$urls[] = substr($server, 5);
} elseif (substr(strtolower($server), 0, 6) === 'stuns:') {
$urls[] = substr($server, 6);
} else {
$urls[] = $server;
}
}

foreach ($this->getTurnServers() as $server) {
$urls[] = $server['server'];
if (substr(strtolower($server['server']), 0, 5) === 'turn:') {
$urls[] = substr($server['server'], 5);
} elseif (substr(strtolower($server['server']), 0, 6) === 'turns:') {
$urls[] = substr($server['server'], 6);
} else {
$urls[] = $server['server'];
}
}

foreach ($this->getSignalingServers() as $server) {
Expand Down Expand Up @@ -205,24 +217,6 @@ public function getStunServers(): array {
return $servers;
}

/**
* @return string
*/
public function getStunServer(): string {
$servers = $this->getStunServers();

if (empty($servers)) {
return '';
}

// For now we use a random server from the list
try {
return $servers[random_int(0, count($servers) - 1)];
} catch (\Exception $e) {
return $servers[0];
}
}

/**
* Generates a username and password for the TURN server
*
Expand All @@ -249,33 +243,31 @@ public function getTurnSettings(): array {

if (empty($servers)) {
return [
'server' => '',
'username' => '',
'password' => '',
'protocols' => '',
[
'server' => '',
'username' => '',
'password' => '',
'protocols' => '',
],
];
}

// For now we use a random server from the list
try {
$server = $servers[random_int(0, count($servers) - 1)];
} catch (\Exception $e) {
$server = $servers[0];
}

// Credentials are valid for 24h
// FIXME add the TTL to the response and properly reconnect then
$timestamp = $this->timeFactory->getTime() + 86400;
$rnd = $this->secureRandom->generate(16);
$username = $timestamp . ':' . $rnd;
$password = base64_encode(hash_hmac('sha1', $username, $server['secret'], true));

return [
'server' => $server['server'],
'username' => $username,
'password' => $password,
'protocols' => $server['protocols'],
];
$settings = [];
foreach ($servers as $server) {
$settings[] = [
'server' => $server['server'],
'username' => $username,
'password' => base64_encode(hash_hmac('sha1', $username, $server['secret'], true)),
'protocols' => $server['protocols'],
];
}
return $settings;
}

public function getSignalingMode(bool $cleanExternalSignaling = true): string {
Expand Down
19 changes: 12 additions & 7 deletions lib/Controller/SignalingController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,21 +137,26 @@ public function getSettings(string $apiVersion, string $token = ''): DataRespons
}

$stun = [];
$stunServer = $this->talkConfig->getStunServer();
if ($stunServer) {
foreach ($this->talkConfig->getStunServers() as $stunServer) {
if (strtolower(substr($stunServer, 0, 5)) !== 'stun:' && strtolower(substr($stunServer, 0, 6)) !== 'stuns:') {
$stunServer = 'stun:' . $stunServer;
}
$stun[] = [
'url' => 'stun:' . $stunServer,
'url' => $stunServer,
];
}

$turn = [];
$turnSettings = $this->talkConfig->getTurnSettings();
if (!empty($turnSettings['server'])) {
foreach ($this->talkConfig->getTurnSettings() as $turnSettings) {
$protocols = explode(',', $turnSettings['protocols']);
foreach ($protocols as $proto) {
$server = $turnSettings['server'];
if (strtolower(substr($server, 0, 5)) !== 'turn:' && strtolower(substr($server, 0, 6)) !== 'turns:') {
$server = 'turn:' . $server;
}
$turn[] = [
'url' => ['turn:' . $turnSettings['server'] . '?transport=' . $proto],
'urls' => ['turn:' . $turnSettings['server'] . '?transport=' . $proto],
'url' => [$server . '?transport=' . $proto],
'urls' => [$server . '?transport=' . $proto],
'username' => $turnSettings['username'],
'credential' => $turnSettings['password'],
];
Expand Down
6 changes: 5 additions & 1 deletion src/components/AdminSettings/TurnServer.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,11 @@ export default {
const urls = []
let i
for (i = 0; i < protocols.length; i++) {
urls.push('turn:' + this.server + '?transport=' + protocols[i])
let server = this.server
if (!(server.toLowerCase().startsWith('turn:') || server.toLowerCase().startsWith('turns:'))) {
server = 'turn:' + server
}
urls.push(server + '?transport=' + protocols[i])
}

const expires = Math.round((new Date()).getTime() / 1000) + (5 * 60)
Expand Down
43 changes: 22 additions & 21 deletions tests/php/ConfigTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
use Test\TestCase;

class ConfigTest extends TestCase {
public function testGetStunServer() {
public function testGetStunServers() {
$servers = [
'stun1.example.com:443',
'stun2.example.com:129',
Expand All @@ -55,10 +55,10 @@ public function testGetStunServer() {
->willReturn(true);

$helper = new Config($config, $secureRandom, $groupManager, $timeFactory);
$this->assertTrue(in_array($helper->getStunServer(), $servers, true));
$this->assertSame($servers, $helper->getStunServers());
}

public function testGetDefaultStunServer() {
public function testGetDefaultStunServers() {
/** @var MockObject|ITimeFactory $timeFactory */
$timeFactory = $this->createMock(ITimeFactory::class);
/** @var MockObject|ISecureRandom $secureRandom */
Expand All @@ -79,10 +79,10 @@ public function testGetDefaultStunServer() {
->willReturn(true);

$helper = new Config($config, $secureRandom, $groupManager, $timeFactory);
$this->assertSame('stun.nextcloud.com:443', $helper->getStunServer());
$this->assertSame(['stun.nextcloud.com:443'], $helper->getStunServers());
}

public function testGetDefaultStunServerNoInternet() {
public function testGetDefaultStunServersNoInternet() {
/** @var MockObject|ITimeFactory $timeFactory */
$timeFactory = $this->createMock(ITimeFactory::class);
/** @var MockObject|ISecureRandom $secureRandom */
Expand All @@ -103,7 +103,7 @@ public function testGetDefaultStunServerNoInternet() {
->willReturn(false);

$helper = new Config($config, $secureRandom, $groupManager, $timeFactory);
$this->assertSame('', $helper->getStunServer());
$this->assertSame([], $helper->getStunServers());
}

public function testGenerateTurnSettings() {
Expand Down Expand Up @@ -147,21 +147,22 @@ public function testGenerateTurnSettings() {
$helper = new Config($config, $secureRandom, $groupManager, $timeFactory);

//
$server = $helper->getTurnSettings();
if ($server['server'] === 'turn.example.org') {
$this->assertSame([
'server' => 'turn.example.org',
'username' => '1479829425:abcdefghijklmnop',
'password' => '4VJLVbihLzuxgMfDrm5C3zy8kLQ=',
'protocols' => 'udp,tcp',
], $server);
} else {
$this->assertSame([
'server' => 'turn2.example.com',
'username' => '1479829425:abcdefghijklmnop',
'password' => 'Ol9DEqnvyN4g+IAM+vFnqhfWUTE=',
'protocols' => 'tcp',
], $server);
foreach ($helper->getTurnSettings() as $server) {
if ($server['server'] === 'turn.example.org') {
$this->assertSame([
'server' => 'turn.example.org',
'username' => '1479829425:abcdefghijklmnop',
'password' => '4VJLVbihLzuxgMfDrm5C3zy8kLQ=',
'protocols' => 'udp,tcp',
], $server);
} else {
$this->assertSame([
'server' => 'turn2.example.com',
'username' => '1479829425:abcdefghijklmnop',
'password' => 'Ol9DEqnvyN4g+IAM+vFnqhfWUTE=',
'protocols' => 'tcp',
], $server);
}
}
}

Expand Down