View Javadoc

1   /*
2    * ====================================================================
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *   http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
25   *
26   */
27  package org.apache.http.impl.auth;
28  
29  import org.apache.http.Header;
30  import org.apache.http.HttpRequest;
31  import org.apache.http.annotation.NotThreadSafe;
32  import org.apache.http.auth.AuthenticationException;
33  import org.apache.http.auth.Credentials;
34  import org.apache.http.protocol.HttpContext;
35  import org.apache.http.util.Args;
36  import org.ietf.jgss.GSSException;
37  import org.ietf.jgss.Oid;
38  
39  /**
40   * KERBEROS authentication scheme.
41   *
42   * @since 4.2
43   */
44  @NotThreadSafe
45  public class KerberosScheme extends GGSSchemeBase {
46  
47      private static final String KERBEROS_OID = "1.2.840.113554.1.2.2";
48  
49      public KerberosScheme(final boolean stripPort) {
50          super(stripPort);
51      }
52  
53      public KerberosScheme() {
54          super(false);
55      }
56  
57      public String getSchemeName() {
58          return "Kerberos";
59      }
60  
61      /**
62       * Produces KERBEROS authorization Header based on token created by
63       * processChallenge.
64       *
65       * @param credentials not used by the KERBEROS scheme.
66       * @param request The request being authenticated
67       *
68       * @throws AuthenticationException if authentication string cannot
69       *   be generated due to an authentication failure
70       *
71       * @return KERBEROS authentication Header
72       */
73      @Override
74      public Header authenticate(
75              final Credentials credentials,
76              final HttpRequest request,
77              final HttpContext context) throws AuthenticationException {
78          return super.authenticate(credentials, request, context);
79      }
80  
81      @Override
82      protected byte[] generateToken(final byte[] input, final String authServer) throws GSSException {
83          return generateGSSToken(input, new Oid(KERBEROS_OID), authServer);
84      }
85  
86      /**
87       * There are no valid parameters for KERBEROS authentication so this
88       * method always returns <code>null</code>.
89       *
90       * @return <code>null</code>
91       */
92      public String getParameter(final String name) {
93          Args.notNull(name, "Parameter name");
94          return null;
95      }
96  
97      /**
98       * The concept of an authentication realm is not supported by the Negotiate
99       * authentication scheme. Always returns <code>null</code>.
100      *
101      * @return <code>null</code>
102      */
103     public String getRealm() {
104         return null;
105     }
106 
107     /**
108      * Returns <tt>true</tt>. KERBEROS authentication scheme is connection based.
109      *
110      * @return <tt>true</tt>.
111      */
112     public boolean isConnectionBased() {
113         return true;
114     }
115 
116 }