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.transport.sshd;
44
45 import java.net.InetSocketAddress;
46 import java.net.Proxy;
47 import java.util.Arrays;
48
49 import org.eclipse.jgit.annotations.NonNull;
50
51 /**
52 * A DTO encapsulating the data needed to connect through a proxy server.
53 *
54 * @since 5.2
55 */
56 public class ProxyData {
57
58 private final @NonNull Proxy proxy;
59
60 private final String proxyUser;
61
62 private final char[] proxyPassword;
63
64 /**
65 * Creates a new {@link ProxyData} instance without user name or password.
66 *
67 * @param proxy
68 * to connect to; must not be {@link java.net.Proxy.Type#DIRECT}
69 * and must have an {@link InetSocketAddress}.
70 */
71 public ProxyData(@NonNull Proxy proxy) {
72 this(proxy, null, null);
73 }
74
75 /**
76 * Creates a new {@link ProxyData} instance.
77 *
78 * @param proxy
79 * to connect to; must not be {@link java.net.Proxy.Type#DIRECT}
80 * and must have an {@link InetSocketAddress}.
81 * @param proxyUser
82 * to use for log-in to the proxy, may be {@code null}
83 * @param proxyPassword
84 * to use for log-in to the proxy, may be {@code null}
85 */
86 public ProxyData(@NonNull Proxy proxy, String proxyUser,
87 char[] proxyPassword) {
88 this.proxy = proxy;
89 if (!(proxy.address() instanceof InetSocketAddress)) {
90 // Internal error not translated
91 throw new IllegalArgumentException(
92 "Proxy does not have an InetSocketAddress"); //$NON-NLS-1$
93 }
94 this.proxyUser = proxyUser;
95 this.proxyPassword = proxyPassword == null ? null
96 : proxyPassword.clone();
97 }
98
99 /**
100 * Obtains the remote {@link InetSocketAddress} of the proxy to connect to.
101 *
102 * @return the remote address of the proxy
103 */
104 @NonNull
105 public Proxy getProxy() {
106 return proxy;
107 }
108
109 /**
110 * Obtains the user to log in at the proxy with.
111 *
112 * @return the user name, or {@code null} if none
113 */
114 public String getUser() {
115 return proxyUser;
116 }
117
118 /**
119 * Obtains a copy of the internally stored password.
120 *
121 * @return the password or {@code null} if none
122 */
123 public char[] getPassword() {
124 return proxyPassword == null ? null : proxyPassword.clone();
125 }
126
127 /**
128 * Clears the stored password, if any.
129 */
130 public void clearPassword() {
131 if (proxyPassword != null) {
132 Arrays.fill(proxyPassword, '\000');
133 }
134 }
135
136 }