mirror of
https://github.com/nextcloud/server.git
synced 2026-02-03 20:41:22 -05:00
71 lines
1.7 KiB
PHP
71 lines
1.7 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
/**
|
|
* SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
|
|
* SPDX-License-Identifier: AGPL-3.0-or-later
|
|
*/
|
|
namespace NCU\Security\Signature;
|
|
|
|
use NCU\Security\Signature\Model\IIncomingSignedRequest;
|
|
use NCU\Security\Signature\Model\ISignatory;
|
|
|
|
/**
|
|
* ISignatoryManager contains a group of method that will help
|
|
* - signing outgoing request
|
|
* - confirm the authenticity of incoming signed request.
|
|
*
|
|
* @experimental 31.0.0
|
|
* @since 31.0.0
|
|
*/
|
|
interface ISignatoryManager {
|
|
/**
|
|
* id of the signatory manager.
|
|
* This is used to store, confirm uniqueness and avoid conflict of the remote key pairs.
|
|
*
|
|
* Must be unique.
|
|
*
|
|
* @return string
|
|
* @since 31.0.0
|
|
*/
|
|
public function getProviderId(): string;
|
|
|
|
/**
|
|
* options that might affect the way the whole process is handled:
|
|
* [
|
|
* 'ttl' => 300,
|
|
* 'ttlSignatory' => 86400*3,
|
|
* 'extraSignatureHeaders' => [],
|
|
* 'algorithm' => 'sha256',
|
|
* 'dateHeader' => "D, d M Y H:i:s T",
|
|
* ]
|
|
*
|
|
* @return array
|
|
* @since 31.0.0
|
|
*/
|
|
public function getOptions(): array;
|
|
|
|
/**
|
|
* generate and returns local signatory including private and public key pair.
|
|
*
|
|
* Used to sign outgoing request
|
|
*
|
|
* @return ISignatory
|
|
* @since 31.0.0
|
|
*/
|
|
public function getLocalSignatory(): ISignatory;
|
|
|
|
/**
|
|
* retrieve details and generate signatory from remote instance.
|
|
* If signatory cannot be found, returns NULL.
|
|
*
|
|
* Used to confirm authenticity of incoming request.
|
|
*
|
|
* @param IIncomingSignedRequest $signedRequest
|
|
*
|
|
* @return ISignatory|null must be NULL if no signatory is found
|
|
* @since 31.0.0
|
|
*/
|
|
public function getRemoteSignatory(IIncomingSignedRequest $signedRequest): ?ISignatory;
|
|
}
|