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.hc.client5.http.impl.win;
28
29 import java.util.Locale;
30
31 import org.apache.hc.client5.http.auth.AuthSchemeFactory;
32 import org.apache.hc.client5.http.auth.StandardAuthScheme;
33 import org.apache.hc.client5.http.impl.auth.BasicSchemeFactory;
34 import org.apache.hc.client5.http.impl.auth.DigestSchemeFactory;
35 import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
36 import org.apache.hc.client5.http.impl.classic.HttpClientBuilder;
37 import org.apache.hc.core5.http.config.Registry;
38 import org.apache.hc.core5.http.config.RegistryBuilder;
39
40 import com.sun.jna.platform.win32.Sspi;
41
42 /**
43 * Factory methods for {@link org.apache.hc.client5.http.impl.classic.CloseableHttpClient} instances configured to use integrated
44 * Windows authentication by default.
45 *
46 * @since 4.4
47 */
48 public class WinHttpClients {
49
50 private WinHttpClients() {
51 super();
52 }
53
54 public static boolean isWinAuthAvailable() {
55 String os = System.getProperty("os.name");
56 os = os != null ? os.toLowerCase(Locale.ROOT) : null;
57 if (os != null && os.contains("windows")) {
58 try {
59 return Sspi.MAX_TOKEN_SIZE > 0;
60 } catch (final Exception ignore) {
61 // Likely ClassNotFound
62 }
63 }
64 return false;
65 }
66
67 private static HttpClientBuilder createBuilder() {
68 if (isWinAuthAvailable()) {
69 final Registry<AuthSchemeFactory> authSchemeRegistry = RegistryBuilder.<AuthSchemeFactory>create()
70 .register(StandardAuthScheme.BASIC, BasicSchemeFactory.INSTANCE)
71 .register(StandardAuthScheme.DIGEST, DigestSchemeFactory.INSTANCE)
72 .register(StandardAuthScheme.NTLM, WindowsNTLMSchemeFactory.DEFAULT)
73 .register(StandardAuthScheme.SPNEGO, WindowsNegotiateSchemeFactory.DEFAULT)
74 .build();
75 return HttpClientBuilder.create()
76 .setDefaultAuthSchemeRegistry(authSchemeRegistry);
77 }
78 return HttpClientBuilder.create();
79 }
80
81 /**
82 * Creates builder object for construction of custom
83 * {@link CloseableHttpClient} instances.
84 */
85 public static HttpClientBuilder custom() {
86 return createBuilder();
87 }
88
89 /**
90 * Creates {@link CloseableHttpClient} instance with default
91 * configuration.
92 */
93 public static CloseableHttpClient createDefault() {
94 return createBuilder().build();
95 }
96
97 /**
98 * Creates {@link CloseableHttpClient} instance with default
99 * configuration based on system properties.
100 */
101 public static CloseableHttpClient createSystem() {
102 return createBuilder().useSystemProperties().build();
103 }
104
105
106 }