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      @Override
58      public String getSchemeName() {
59          return "Kerberos";
60      }
61  
62      /**
63       * Produces KERBEROS authorization Header based on token created by
64       * processChallenge.
65       *
66       * @param credentials not used by the KERBEROS scheme.
67       * @param request The request being authenticated
68       *
69       * @throws AuthenticationException if authentication string cannot
70       *   be generated due to an authentication failure
71       *
72       * @return KERBEROS authentication Header
73       */
74      @Override
75      public Header authenticate(
76              final Credentials credentials,
77              final HttpRequest request,
78              final HttpContext context) throws AuthenticationException {
79          return super.authenticate(credentials, request, context);
80      }
81  
82      @Override
83      protected byte[] generateToken(final byte[] input, final String authServer) throws GSSException {
84          return generateGSSToken(input, new Oid(KERBEROS_OID), authServer);
85      }
86  
87      /**
88       * There are no valid parameters for KERBEROS authentication so this
89       * method always returns <code>null</code>.
90       *
91       * @return <code>null</code>
92       */
93      @Override
94      public String getParameter(final String name) {
95          Args.notNull(name, "Parameter name");
96          return null;
97      }
98  
99      /**
100      * The concept of an authentication realm is not supported by the Negotiate
101      * authentication scheme. Always returns <code>null</code>.
102      *
103      * @return <code>null</code>
104      */
105     @Override
106     public String getRealm() {
107         return null;
108     }
109 
110     /**
111      * Returns {@code true}. KERBEROS authentication scheme is connection based.
112      *
113      * @return {@code true}.
114      */
115     @Override
116     public boolean isConnectionBased() {
117         return true;
118     }
119 
120 }