1 /*
2 * Copyright (C) 2018, Thomas Wolf <thomas.wolf@paranor.ch>
3 * and other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available
6 * under the terms of the Eclipse Distribution License v1.0 which
7 * accompanies this distribution, is reproduced below, and is
8 * available at http://www.eclipse.org/org/documents/edl-v10.php
9 *
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * - Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials provided
22 * with the distribution.
23 *
24 * - Neither the name of the Eclipse Foundation, Inc. nor the
25 * names of its contributors may be used to endorse or promote
26 * products derived from this software without specific prior
27 * written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43 package org.eclipse.jgit.internal.transport.sshd.proxy;
44
45 import java.util.Collections;
46 import java.util.LinkedHashMap;
47 import java.util.Map;
48
49 import org.eclipse.jgit.annotations.NonNull;
50
51 /**
52 * A simple representation of an authentication challenge as sent in a
53 * "WWW-Authenticate" or "Proxy-Authenticate" header. Such challenges start with
54 * a mechanism name, followed either by one single token, or by a list of
55 * key=value pairs.
56 *
57 * @see <a href="https://tools.ietf.org/html/rfc7235#section-2.1">RFC 7235, sec.
58 * 2.1</a>
59 */
60 public class AuthenticationChallenge {
61
62 private final String mechanism;
63
64 private String token;
65
66 private Map<String, String> arguments;
67
68 /**
69 * Create a new {@link AuthenticationChallenge} with the given mechanism.
70 *
71 * @param mechanism
72 * for the challenge
73 */
74 public AuthenticationChallenge(String mechanism) {
75 this.mechanism = mechanism;
76 }
77
78 /**
79 * Retrieves the authentication mechanism specified by this challenge, for
80 * instance "Basic".
81 *
82 * @return the mechanism name
83 */
84 public String getMechanism() {
85 return mechanism;
86 }
87
88 /**
89 * Retrieves the token of the challenge, if any.
90 *
91 * @return the token, or {@code null} if there is none.
92 */
93 public String getToken() {
94 return token;
95 }
96
97 /**
98 * Retrieves the arguments of the challenge.
99 *
100 * @return a possibly empty map of the key=value arguments of the challenge
101 */
102 @NonNull
103 public Map<String, String> getArguments() {
104 return arguments == null ? Collections.emptyMap() : arguments;
105 }
106
107 void addArgument(String key, String value) {
108 if (arguments == null) {
109 arguments = new LinkedHashMap<>();
110 }
111 arguments.put(key, value);
112 }
113
114 void setToken(String token) {
115 this.token = token;
116 }
117
118 @Override
119 public String toString() {
120 return "AuthenticationChallenge[" + mechanism + ',' + token + ',' //$NON-NLS-1$
121 + (arguments == null ? "<none>" : arguments.toString()) + ']'; //$NON-NLS-1$
122 }
123 }