1
0

ITrustedDomainHelper.php 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2021 Joas Schilling <coding@schilljs.com>
  5. *
  6. * @license GNU AGPL version 3 or any later version
  7. *
  8. * This program is free software: you can redistribute it and/or modify
  9. * it under the terms of the GNU Affero General Public License as
  10. * published by the Free Software Foundation, either version 3 of the
  11. * License, or (at your option) any later version.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU Affero General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU Affero General Public License
  19. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  20. *
  21. */
  22. namespace OCP\Security;
  23. /**
  24. * Allows checking domains and full URLs against the list of trusted domains for
  25. * this server in the config file.
  26. *
  27. * @package OCP\Security
  28. * @since 23.0.0
  29. */
  30. interface ITrustedDomainHelper {
  31. /**
  32. * Checks whether a given URL is considered as trusted from the list
  33. * of trusted domains in the server's config file. If no trusted domains
  34. * have been configured and the url is valid, returns true.
  35. *
  36. * @param string $url
  37. * @return bool
  38. * @since 23.0.0
  39. */
  40. public function isTrustedUrl(string $url): bool;
  41. /**
  42. * Checks whether a given domain is considered as trusted from the list
  43. * of trusted domains in the server's config file. If no trusted domains
  44. * have been configured, returns true.
  45. * This is used to prevent Host Header Poisoning.
  46. *
  47. * @param string $domainWithPort
  48. * @return bool
  49. * @since 23.0.0
  50. */
  51. public function isTrustedDomain(string $domainWithPort): bool;
  52. }