View Javadoc
1   /**
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements. See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership. The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License. You may obtain a copy of the License at
9    *
10   * http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied. See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  
20  package org.apache.wss4j.dom.str;
21  
22  import org.apache.wss4j.common.ext.WSSecurityException;
23  
24  /**
25   * This interface describes a pluggable way of extracting credentials from SecurityTokenReference
26   * elements. The implementations are used by various processors.
27   */
28  public interface STRParser {
29  
30      /**
31       * ISSUER_SERIAL - A certificate (chain) is located by the issuer name and serial number of the
32       * (root) cert
33       * THUMBPRINT_SHA1 - A certificate (chain) is located by the SHA1 thumbprint of the (root) cert
34       * KEY_IDENTIFIER - A certificate (chain) is located via a Key Identifier Element
35       * DIRECT_REF - A certificate (chain) is located directly via an Id to another security token
36       * Note that a Thumbprint reference is also a KeyIdentifier, but takes precedence over it.
37       */
38      enum REFERENCE_TYPE {
39          ISSUER_SERIAL, THUMBPRINT_SHA1, KEY_IDENTIFIER, DIRECT_REF
40      }
41  
42      /**
43       * Parse a SecurityTokenReference element and extract credentials.
44       *
45       * @param parameters The parameters to parse
46       * @return the STRParserResult Object containing the parsing results
47       * @throws WSSecurityException
48       */
49      STRParserResult parseSecurityTokenReference(STRParserParameters parameters) throws WSSecurityException;
50  
51  }