1 /*
2 * Copyright 2008 Web Cohesion
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * https://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package org.springframework.security.oauth.common.signature;
18
19 /**
20 * @author Ryan Heaton
21 */
22 public interface OAuthSignatureMethod {
23
24 /**
25 * The name of the OAuth signature method.
26 *
27 * @return The name of the OAuth signature method.
28 */
29 String getName();
30
31 /**
32 * Sign the signature base string.
33 *
34 * @param signatureBaseString The signature base string to sign.
35 * @return The signature.
36 */
37 String sign(String signatureBaseString);
38
39 /**
40 * Verify the specified signature on the given signature base string.
41 *
42 * @param signatureBaseString The signature base string.
43 * @param signature The signature.
44 */
45 void verify(String signatureBaseString, String signature) throws InvalidSignatureException;
46
47 }