diff options
Diffstat (limited to 'lib/public/ICertificateManager.php')
-rw-r--r-- | lib/public/ICertificateManager.php | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/lib/public/ICertificateManager.php b/lib/public/ICertificateManager.php new file mode 100644 index 00000000000..27eebcf0491 --- /dev/null +++ b/lib/public/ICertificateManager.php @@ -0,0 +1,71 @@ +<?php +/** + * @author Lukas Reschke <lukas@owncloud.com> + * @author Morris Jobke <hey@morrisjobke.de> + * @author Robin Appelman <icewind@owncloud.com> + * + * @copyright Copyright (c) 2016, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License, version 3, + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License, version 3, + * along with this program. If not, see <http://www.gnu.org/licenses/> + * + */ + +namespace OCP; + +/** + * Manage trusted certificates for users + * @since 8.0.0 + */ +interface ICertificateManager { + /** + * Returns all certificates trusted by the user + * + * @return \OCP\ICertificate[] + * @since 8.0.0 + */ + public function listCertificates(); + + /** + * @param string $certificate the certificate data + * @param string $name the filename for the certificate + * @return \OCP\ICertificate + * @throws \Exception If the certificate could not get added + * @since 8.0.0 - since 8.1.0 throws exception instead of returning false + */ + public function addCertificate($certificate, $name); + + /** + * @param string $name + * @since 8.0.0 + */ + public function removeCertificate($name); + + /** + * Get the path to the certificate bundle for this user + * + * @param string $uid (optional) user to get the certificate bundle for, use `null` to get the system bundle (since 9.0.0) + * @return string + * @since 8.0.0 + */ + public function getCertificateBundle($uid = ''); + + /** + * Get the full local path to the certificate bundle for this user + * + * @param string $uid (optional) user to get the certificate bundle for, use `null` to get the system bundle + * @return string + * @since 9.0.0 + */ + public function getAbsoluteBundlePath($uid = ''); +} |