SignBlobInterface.php 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. <?php
  2. /*
  3. * Copyright 2019 Google LLC
  4. *
  5. * Licensed under the Apache License, Version 2.0 (the "License");
  6. * you may not use this file except in compliance with the License.
  7. * You may obtain a copy of the License at
  8. *
  9. * http://www.apache.org/licenses/LICENSE-2.0
  10. *
  11. * Unless required by applicable law or agreed to in writing, software
  12. * distributed under the License is distributed on an "AS IS" BASIS,
  13. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. * See the License for the specific language governing permissions and
  15. * limitations under the License.
  16. */
  17. namespace Google\Auth;
  18. /**
  19. * Describes a class which supports signing arbitrary strings.
  20. */
  21. interface SignBlobInterface extends FetchAuthTokenInterface
  22. {
  23. /**
  24. * Sign a string using the method which is best for a given credentials type.
  25. *
  26. * @param string $stringToSign The string to sign.
  27. * @param bool $forceOpenssl Require use of OpenSSL for local signing. Does
  28. * not apply to signing done using external services. **Defaults to**
  29. * `false`.
  30. * @return string The resulting signature. Value should be base64-encoded.
  31. */
  32. public function signBlob($stringToSign, $forceOpenssl = false);
  33. /**
  34. * Returns the current Client Name.
  35. *
  36. * @param callable $httpHandler callback which delivers psr7 request, if
  37. * one is required to obtain a client name.
  38. * @return string
  39. */
  40. public function getClientName(callable $httpHandler = null);
  41. }