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   * SPNEGO (Simple and Protected GSSAPI Negotiation Mechanism) authentication
41   * scheme.
42   *
43   * @since 4.2
44   */
45  @NotThreadSafe
46  public class SPNegoScheme extends GGSSchemeBase {
47  
48      private static final String SPNEGO_OID = "1.3.6.1.5.5.2";
49  
50      public SPNegoScheme(final boolean stripPort) {
51          super(stripPort);
52      }
53  
54      public SPNegoScheme() {
55          super(false);
56      }
57  
58      @Override
59      public String getSchemeName() {
60          return "Negotiate";
61      }
62  
63      /**
64       * Produces SPNEGO authorization Header based on token created by
65       * processChallenge.
66       *
67       * @param credentials not used by the SPNEGO scheme.
68       * @param request The request being authenticated
69       *
70       * @throws AuthenticationException if authentication string cannot
71       *   be generated due to an authentication failure
72       *
73       * @return SPNEGO authentication Header
74       */
75      @Override
76      public Header authenticate(
77              final Credentials credentials,
78              final HttpRequest request,
79              final HttpContext context) throws AuthenticationException {
80          return super.authenticate(credentials, request, context);
81      }
82  
83      @Override
84      protected byte[] generateToken(final byte[] input, final String authServer) throws GSSException {
85          return generateGSSToken(input, new Oid(SPNEGO_OID), authServer);
86      }
87  
88      /**
89       * There are no valid parameters for SPNEGO authentication so this
90       * method always returns <code>null</code>.
91       *
92       * @return <code>null</code>
93       */
94      @Override
95      public String getParameter(final String name) {
96          Args.notNull(name, "Parameter name");
97          return null;
98      }
99  
100     /**
101      * The concept of an authentication realm is not supported by the Negotiate
102      * authentication scheme. Always returns <code>null</code>.
103      *
104      * @return <code>null</code>
105      */
106     @Override
107     public String getRealm() {
108         return null;
109     }
110 
111     /**
112      * Returns {@code true}. SPNEGO authentication scheme is connection based.
113      *
114      * @return {@code true}.
115      */
116     @Override
117     public boolean isConnectionBased() {
118         return true;
119     }
120 
121 }