Skip to content

feat(auth): Add IAlternativeLoginProvider #59627

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

Open
CarlSchwan wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat(auth): Add IAlternativeLoginProvider #59627

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
1 change: 1 addition & 0 deletions lib/composer/composer/autoload_classmap.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,7 @@
'OCP\\Authentication\\Exceptions\\PasswordUnavailableException' => $baseDir . '/lib/public/Authentication/Exceptions/PasswordUnavailableException.php',
'OCP\\Authentication\\Exceptions\\WipeTokenException' => $baseDir . '/lib/public/Authentication/Exceptions/WipeTokenException.php',
'OCP\\Authentication\\IAlternativeLogin' => $baseDir . '/lib/public/Authentication/IAlternativeLogin.php',
'OCP\\Authentication\\IAlternativeLoginProvider' => $baseDir . '/lib/public/Authentication/IAlternativeLoginProvider.php',
'OCP\\Authentication\\IApacheBackend' => $baseDir . '/lib/public/Authentication/IApacheBackend.php',
'OCP\\Authentication\\IProvideUserSecretBackend' => $baseDir . '/lib/public/Authentication/IProvideUserSecretBackend.php',
'OCP\\Authentication\\LoginCredentials\\ICredentials' => $baseDir . '/lib/public/Authentication/LoginCredentials/ICredentials.php',
Expand Down
1 change: 1 addition & 0 deletions lib/composer/composer/autoload_static.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
'OCP\\Authentication\\Exceptions\\PasswordUnavailableException' => __DIR__ . '/../../..' . '/lib/public/Authentication/Exceptions/PasswordUnavailableException.php',
'OCP\\Authentication\\Exceptions\\WipeTokenException' => __DIR__ . '/../../..' . '/lib/public/Authentication/Exceptions/WipeTokenException.php',
'OCP\\Authentication\\IAlternativeLogin' => __DIR__ . '/../../..' . '/lib/public/Authentication/IAlternativeLogin.php',
'OCP\\Authentication\\IAlternativeLoginProvider' => __DIR__ . '/../../..' . '/lib/public/Authentication/IAlternativeLoginProvider.php',
'OCP\\Authentication\\IApacheBackend' => __DIR__ . '/../../..' . '/lib/public/Authentication/IApacheBackend.php',
'OCP\\Authentication\\IProvideUserSecretBackend' => __DIR__ . '/../../..' . '/lib/public/Authentication/IProvideUserSecretBackend.php',
'OCP\\Authentication\\LoginCredentials\\ICredentials' => __DIR__ . '/../../..' . '/lib/public/Authentication/LoginCredentials/ICredentials.php',
Expand Down
24 changes: 24 additions & 0 deletions lib/private/AppFramework/Bootstrap/RegistrationContext.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
use OCP\AppFramework\Middleware;
use OCP\AppFramework\Services\InitialStateProvider;
use OCP\Authentication\IAlternativeLogin;
use OCP\Authentication\IAlternativeLoginProvider;
use OCP\Calendar\ICalendarProvider;
use OCP\Calendar\Resource\IBackend as IResourceBackend;
use OCP\Calendar\Room\IBackend as IRoomBackend;
Expand Down Expand Up @@ -44,6 +45,7 @@
use OCP\TextProcessing\IProvider as ITextProcessingProvider;
use OCP\Translation\ITranslationProvider;
use OCP\UserMigration\IMigrator as IUserMigrator;
use Override;
use Psr\Log\LoggerInterface;
use RuntimeException;
use Throwable;
Expand Down Expand Up @@ -95,6 +97,9 @@ class RegistrationContext {
/** @var ServiceRegistration<IAlternativeLogin>[] */
private $alternativeLogins = [];

/** @var ServiceRegistration<IAlternativeLoginProvider>[] */
private array $alternativeLoginProviders = [];

/** @var ServiceRegistration<InitialStateProvider>[] */
private $initialStates = [];

Expand Down Expand Up @@ -251,6 +256,14 @@ public function registerAlternativeLogin(string $class): void {
);
}

#[Override]
public function registerAlternativeLoginProvider(string $class): void {
$this->context->registerAlternativeLoginProvider(
$this->appId,
$class
);
}

public function registerInitialStateProvider(string $class): void {
$this->context->registerInitialState(
$this->appId,
Expand Down Expand Up @@ -495,6 +508,10 @@ public function registerAlternativeLogin(string $appId, string $class): void {
$this->alternativeLogins[] = new ServiceRegistration($appId, $class);
}

public function registerAlternativeLoginProvider(string $appId, string $class): void {
$this->alternativeLoginProviders[] = new ServiceRegistration($appId, $class);
}

public function registerInitialState(string $appId, string $class): void {
$this->initialStates[] = new ServiceRegistration($appId, $class);
}
Expand Down Expand Up @@ -828,6 +845,13 @@ public function getAlternativeLogins(): array {
return $this->alternativeLogins;
}

/**
* @return ServiceRegistration<IAlternativeLoginProvider>[]
*/
public function getAlternativeLoginProviders(): array {
return $this->alternativeLoginProviders;
}

/**
* @return ServiceRegistration<InitialStateProvider>[]
*/
Expand Down
48 changes: 47 additions & 1 deletion lib/private/legacy/OC_App.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
use OCP\App\AppPathNotFoundException;
use OCP\App\IAppManager;
use OCP\Authentication\IAlternativeLogin;
use OCP\Authentication\IAlternativeLoginProvider;
use OCP\BackgroundJob\IJobList;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\IAppConfig;
Expand All @@ -41,6 +42,8 @@
* upgrading and removing apps.
*/
class OC_App {

/** @var list<array{name: string, href: string, class: string}> */
private static array $altLogin = [];
private static array $alreadyRegistered = [];
public const supportedApp = 300;
Expand Down Expand Up @@ -300,12 +303,55 @@ public static function registerLogIn(array $entry): void {
}

/**
* @return array
* @return list<array{name: string, href: string, class: string}>
*/
public static function getAlternativeLogIns(): array {
/** @var Coordinator $bootstrapCoordinator */
$bootstrapCoordinator = Server::get(Coordinator::class);

foreach ($bootstrapCoordinator->getRegistrationContext()->getAlternativeLoginProviders() as $registration) {
if (!in_array(IAlternativeLoginProvider::class, class_implements($registration->getService()), true)) {
Server::get(LoggerInterface::class)->error('Alternative login option {option} does not implement {interface} and is therefore ignored.', [
'option' => $registration->getService(),
'interface' => IAlternativeLoginProvider::class,
'app' => $registration->getAppId(),
]);
continue;
}

try {
/** @var IAlternativeLoginProvider $provider */
$provider = Server::get($registration->getService());
} catch (ContainerExceptionInterface $e) {
Server::get(LoggerInterface::class)->error('Alternative login option {option} can not be initialized.',
[
'exception' => $e,
'option' => $registration->getService(),
'app' => $registration->getAppId(),
]);
continue;
}

foreach ($provider->getAlternativeLogins() as $alternativeLogin) {
try {
$alternativeLogin->load();

self::$altLogin[] = [
'name' => $alternativeLogin->getLabel(),
'href' => $alternativeLogin->getLink(),
'class' => $alternativeLogin->getClass(),
];
} catch (Throwable $e) {
Server::get(LoggerInterface::class)->error('Alternative login option {option} had an error while loading.',
[
'exception' => $e,
'option' => $registration->getService(),
'app' => $registration->getAppId(),
]);
}
}
}

foreach ($bootstrapCoordinator->getRegistrationContext()->getAlternativeLogins() as $registration) {
if (!in_array(IAlternativeLogin::class, class_implements($registration->getService()), true)) {
Server::get(LoggerInterface::class)->error('Alternative login option {option} does not implement {interface} and is therefore ignored.', [
Expand Down
12 changes: 12 additions & 0 deletions lib/public/AppFramework/Bootstrap/IRegistrationContext.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,9 +161,21 @@ public function registerSearchProvider(string $class): void;
* @return void
*
* @since 20.0.0
* @deprecated 34.0.0 Use registerAlternativeLoginProvider instead.
*/
public function registerAlternativeLogin(string $class): void;

/**
* Register an alternative login options provider
*
* It is allowed to register more than one option per app.
*
* @param class-string<\OCP\Authentication\IAlternativeLoginProvider> $class
*
* @since 34.0.0
*/
public function registerAlternativeLoginProvider(string $class): void;

/**
* Register an initialstate provider
*
Expand Down
22 changes: 22 additions & 0 deletions lib/public/Authentication/IAlternativeLoginProvider.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<?php

declare(strict_types=1);

/**
* SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\Authentication;

/**
* Provider exposing one or multiple IAlternativeLogin.
*
* @since 34.0.0
*/
interface IAlternativeLoginProvider {
/**
* @return list<IAlternativeLogin>
* @since 34.0.0
*/
public function getAlternativeLogins(): array;
}
Loading