mirror of
https://github.com/nextcloud/server.git
synced 2026-11-18 09:54:41 +01:00
Robin Appleman's SMB library is designed so that 'null' is to be used
when no explicit workgroup is set:
final class BasicAuth implements IAuth {
/** @var string */
private $username;
/** @var string|null */
private $workgroup;
/** @var string */
private $password;
//...
However, it previously was loose with its checks and would still treat
any falsy value (e.g. an empty string) as "not specified" when forming
arguments for the various underlying utilities, such as `smbclient`.
icewind/SMB@4a93467905 updated it's handling to be more strict and as
such will now treat empty strings as distinct from null values for
workgroups. An empty value for workgroup often doesn't make sense,
unless the backend tool happens to convert it to "WORKGROUP". In the
case of the `smbclient` utility, passing an empty string for the
$workgroup paramters results in `-W ''` being used which is invalid
syntax and so the invocation fails resulting in the user seeing an
`[Icewind\SMB\Exception\ConnectionRefusedException]` error. Therefore,
it is important to always pass 'null' to this constructor for $workgroup
when there isn't one.
Most paths in the 'files_external' app already handle this correctly,
but this now altered path originally just took the raw value from the
app backend and passed it as-is. Assuming the user left the "Domain"
box empty in the frontend, this would be an empty string. Now the
the SMB library's interface is correctly honored in that case.
It's arguable that the SMB library should simply be updated to
formally accept '' as a valid input meaning "no workgroup", restoring
the old behavior in a canonical fashion, as there is almost no
situation where one would want to pass an empty string and have it
mean anything else; but regardless, there is no harm in being more
explicit on the nextcloud/server side as well.
Fixes #58445.
Signed-off-by: Christian Heimlich <chris@pcserenity.com>
143 lines
5.4 KiB
PHP
143 lines
5.4 KiB
PHP
<?php
|
|
|
|
/**
|
|
* SPDX-FileCopyrightText: 2018-2024 Nextcloud GmbH and Nextcloud contributors
|
|
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
|
|
* SPDX-License-Identifier: AGPL-3.0-only
|
|
*/
|
|
|
|
namespace OCA\Files_External\Lib\Backend;
|
|
|
|
use Icewind\SMB\BasicAuth;
|
|
use Icewind\SMB\KerberosAuth;
|
|
use Icewind\SMB\KerberosTicket;
|
|
use Icewind\SMB\Native\NativeServer;
|
|
use Icewind\SMB\Wrapped\Server;
|
|
use OCA\Files_External\Lib\Auth\AuthMechanism;
|
|
use OCA\Files_External\Lib\Auth\Password\Password;
|
|
use OCA\Files_External\Lib\Auth\SMB\KerberosApacheAuth as KerberosApacheAuthMechanism;
|
|
use OCA\Files_External\Lib\DefinitionParameter;
|
|
use OCA\Files_External\Lib\InsufficientDataForMeaningfulAnswerException;
|
|
use OCA\Files_External\Lib\MissingDependency;
|
|
use OCA\Files_External\Lib\Storage\SystemBridge;
|
|
use OCA\Files_External\Lib\StorageConfig;
|
|
use OCP\IL10N;
|
|
use OCP\IUser;
|
|
|
|
class SMB extends Backend {
|
|
public function __construct(IL10N $l, Password $legacyAuth) {
|
|
$this
|
|
->setIdentifier('smb')
|
|
->addIdentifierAlias('\OC\Files\Storage\SMB')// legacy compat
|
|
->setStorageClass('\OCA\Files_External\Lib\Storage\SMB')
|
|
->setText($l->t('SMB/CIFS (Windows network share)'))
|
|
->addParameters([
|
|
new DefinitionParameter('host', $l->t('Host')),
|
|
new DefinitionParameter('share', $l->t('Share')),
|
|
(new DefinitionParameter('root', $l->t('Remote subfolder')))
|
|
->setFlag(DefinitionParameter::FLAG_OPTIONAL),
|
|
(new DefinitionParameter('domain', $l->t('Domain')))
|
|
->setFlag(DefinitionParameter::FLAG_OPTIONAL),
|
|
(new DefinitionParameter('show_hidden', $l->t('Show hidden files')))
|
|
->setType(DefinitionParameter::VALUE_BOOLEAN)
|
|
->setFlag(DefinitionParameter::FLAG_OPTIONAL),
|
|
(new DefinitionParameter('case_sensitive', $l->t('Case sensitive file system')))
|
|
->setType(DefinitionParameter::VALUE_BOOLEAN)
|
|
->setFlag(DefinitionParameter::FLAG_OPTIONAL)
|
|
->setDefaultValue(true)
|
|
->setTooltip($l->t('Disabling it will allow to use a case insensitive file system, but comes with a performance penalty')),
|
|
(new DefinitionParameter('check_acl', $l->t('Verify ACL access when listing files')))
|
|
->setType(DefinitionParameter::VALUE_BOOLEAN)
|
|
->setFlag(DefinitionParameter::FLAG_OPTIONAL)
|
|
->setTooltip($l->t("Check the ACL's of each file or folder inside a directory to filter out items where the account has no read permissions, comes with a performance penalty")),
|
|
(new DefinitionParameter('timeout', $l->t('Timeout')))
|
|
->setType(DefinitionParameter::VALUE_TEXT)
|
|
->setFlag(DefinitionParameter::FLAG_OPTIONAL)
|
|
->setFlag(DefinitionParameter::FLAG_HIDDEN),
|
|
])
|
|
->addAuthScheme(AuthMechanism::SCHEME_PASSWORD)
|
|
->addAuthScheme(AuthMechanism::SCHEME_SMB)
|
|
->setLegacyAuthMechanism($legacyAuth);
|
|
}
|
|
|
|
#[\Override]
|
|
public function manipulateStorageConfig(StorageConfig &$storage, ?IUser $user = null): void {
|
|
$auth = $storage->getAuthMechanism();
|
|
if ($auth->getScheme() === AuthMechanism::SCHEME_PASSWORD) {
|
|
if (!is_string($storage->getBackendOption('user')) || !is_string($storage->getBackendOption('password'))) {
|
|
throw new \InvalidArgumentException('user or password is not set');
|
|
}
|
|
|
|
$smbAuth = new BasicAuth(
|
|
$storage->getBackendOption('user'),
|
|
$storage->getBackendOption('domain') ?: null,
|
|
$storage->getBackendOption('password')
|
|
);
|
|
} else {
|
|
switch ($auth->getIdentifier()) {
|
|
case 'smb::kerberos':
|
|
$smbAuth = new KerberosAuth();
|
|
break;
|
|
case 'smb::kerberosapache':
|
|
if (!$auth instanceof KerberosApacheAuthMechanism) {
|
|
throw new \InvalidArgumentException('invalid authentication backend');
|
|
}
|
|
$credentialsStore = $auth->getCredentialsStore();
|
|
$kerbAuth = new KerberosAuth();
|
|
$kerbAuth->setTicket(KerberosTicket::fromEnv());
|
|
// check if a kerberos ticket is available, else fallback to session credentials
|
|
if ($kerbAuth->getTicket()?->isValid()) {
|
|
$smbAuth = $kerbAuth;
|
|
} else {
|
|
try {
|
|
$credentials = $credentialsStore->getLoginCredentials();
|
|
$loginName = $credentials->getLoginName();
|
|
$pass = $credentials->getPassword();
|
|
preg_match('/(.*)@(.*)/', $loginName, $matches);
|
|
$realm = $storage->getBackendOption('default_realm');
|
|
if (empty($realm)) {
|
|
$realm = 'WORKGROUP';
|
|
}
|
|
if (count($matches) === 0) {
|
|
$username = $loginName;
|
|
$workgroup = $realm;
|
|
} else {
|
|
[, $username, $workgroup] = $matches;
|
|
}
|
|
$smbAuth = new BasicAuth(
|
|
$username,
|
|
$workgroup,
|
|
$pass
|
|
);
|
|
} catch (\Exception) {
|
|
throw new InsufficientDataForMeaningfulAnswerException('No session credentials saved');
|
|
}
|
|
}
|
|
|
|
break;
|
|
default:
|
|
throw new \InvalidArgumentException('unknown authentication backend');
|
|
}
|
|
}
|
|
|
|
$storage->setBackendOption('auth', $smbAuth);
|
|
}
|
|
|
|
#[\Override]
|
|
public function checkDependencies(): array {
|
|
$system = \OCP\Server::get(SystemBridge::class);
|
|
if (NativeServer::available($system)) {
|
|
return [];
|
|
} elseif (Server::available($system)) {
|
|
$missing = new MissingDependency('php-smbclient');
|
|
$missing->setOptional(true);
|
|
$missing->setMessage('The php-smbclient library provides improved compatibility and performance for SMB storages.');
|
|
return [$missing];
|
|
} else {
|
|
$missing = new MissingDependency('php-smbclient');
|
|
$missing->setMessage('Either the php-smbclient library (preferred) or the smbclient binary is required for SMB storages.');
|
|
return [$missing, new MissingDependency('smbclient')];
|
|
}
|
|
}
|
|
}
|