google-auth-library-php/src/SignBlobInterface.php at main · nidcode/google-auth-library-php · GitHub

44 lines (41 loc) · 1.5 KB

<?php

* Licensed under the Apache License, Version 2.0 (the "License");

* you may not use this file except in compliance with the License.

* You may obtain a copy of the License at

* http://www.apache.org/licenses/LICENSE-2.0

* Unless required by applicable law or agreed to in writing, software

* distributed under the License is distributed on an "AS IS" BASIS,

* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

* See the License for the specific language governing permissions and

* limitations under the License.

namespace Google\Auth;

/**

* Describes a class which supports signing arbitrary strings.

interface SignBlobInterface extends FetchAuthTokenInterface

{

/**

* Sign a string using the method which is best for a given credentials type.

* @param string $stringToSign The string to sign.

* @param bool $forceOpenssl Require use of OpenSSL for local signing. Does

* not apply to signing done using external services. **Defaults to**

* `false`.

* @return string The resulting signature. Value should be base64-encoded.

public function signBlob($stringToSign, $forceOpenssl = false);

/**

* Returns the current Client Name.

* @param callable|null $httpHandler callback which delivers psr7 request, if

* one is required to obtain a client name.

* @return string

public function getClientName(?callable $httpHandler = null);

}

Expand file tree