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
28 package org.apache.hc.client5.testing.auth;
29
30 import java.nio.charset.Charset;
31 import java.nio.charset.StandardCharsets;
32
33 import org.apache.hc.client5.http.auth.StandardAuthScheme;
34 import org.apache.hc.client5.http.utils.Base64;
35
36 public class BasicAuthenticationHandler extends AbstractAuthenticationHandler {
37
38 private final Charset charset;
39
40 /**
41 * @param charset the {@link Charset} set to be used for encoding credentials. This parameter is ignored as UTF-8 is always used.
42 * @since 5.3
43 * @deprecated This constructor is deprecated to enforce the use of {@link StandardCharsets#UTF_8} encoding
44 * in compliance with RFC 7617 for HTTP Basic Authentication. Use the default constructor {@link #BasicAuthenticationHandler()} instead.
45 */
46 @Deprecated
47 public BasicAuthenticationHandler(final Charset charset) {
48 this.charset = StandardCharsets.UTF_8; // Always use UTF-8
49 }
50
51 /**
52 * Constructs a new BasicAuthenticationHandler with UTF-8 as the charset.
53 * This default setting aligns with standard practices for encoding credentials in Basic Authentication.
54 *
55 */
56 public BasicAuthenticationHandler() {
57 this.charset = StandardCharsets.UTF_8;
58 }
59
60 @Override
61 String getSchemeName() {
62 return StandardAuthScheme.BASIC;
63 }
64
65 @Override
66 String decodeChallenge(final String challenge) throws IllegalArgumentException {
67 final byte[] bytes = challenge.getBytes(StandardCharsets.US_ASCII);
68 final Base64 codec = new Base64();
69 return new String(codec.decode(bytes), charset);
70 }
71
72 }