1 /*
2 * Copyright (C) 2009, Google Inc.
3 * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
4 * and other copyright owners as documented in the project's IP log.
5 *
6 * This program and the accompanying materials are made available
7 * under the terms of the Eclipse Distribution License v1.0 which
8 * accompanies this distribution, is reproduced below, and is
9 * available at http://www.eclipse.org/org/documents/edl-v10.php
10 *
11 * All rights reserved.
12 *
13 * Redistribution and use in source and binary forms, with or
14 * without modification, are permitted provided that the following
15 * conditions are met:
16 *
17 * - Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 *
20 * - Redistributions in binary form must reproduce the above
21 * copyright notice, this list of conditions and the following
22 * disclaimer in the documentation and/or other materials provided
23 * with the distribution.
24 *
25 * - Neither the name of the Eclipse Foundation, Inc. nor the
26 * names of its contributors may be used to endorse or promote
27 * products derived from this software without specific prior
28 * written permission.
29 *
30 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
31 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
32 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
33 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
34 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
35 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
37 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
38 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
39 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
41 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
42 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
43 */
44
45 package org.eclipse.jgit.util;
46
47 import java.net.Authenticator;
48 import java.net.PasswordAuthentication;
49 import java.util.Collection;
50 import java.util.concurrent.CopyOnWriteArrayList;
51
52 /**
53 * Abstract authenticator which remembers prior authentications.
54 */
55 public abstract class CachedAuthenticator extends Authenticator {
56 private static final Collection<CachedAuthentication> cached = new CopyOnWriteArrayList<>();
57
58 /**
59 * Add a cached authentication for future use.
60 *
61 * @param ca
62 * the information we should remember.
63 */
64 public static void add(CachedAuthentication ca) {
65 cached.add(ca);
66 }
67
68 /** {@inheritDoc} */
69 @Override
70 protected final PasswordAuthentication getPasswordAuthentication() {
71 final String host = getRequestingHost();
72 final int port = getRequestingPort();
73 for (CachedAuthentication ca : cached) {
74 if (ca.host.equals(host) && ca.port == port)
75 return ca.toPasswordAuthentication();
76 }
77 PasswordAuthentication pa = promptPasswordAuthentication();
78 if (pa != null) {
79 CachedAuthentication ca = new CachedAuthentication(host, port, pa
80 .getUserName(), new String(pa.getPassword()));
81 add(ca);
82 return ca.toPasswordAuthentication();
83 }
84 return null;
85 }
86
87 /**
88 * Prompt for and request authentication from the end-user.
89 *
90 * @return the authentication data; null if the user canceled the request
91 * and does not want to continue.
92 */
93 protected abstract PasswordAuthentication promptPasswordAuthentication();
94
95 /** Authentication data to remember and reuse. */
96 public static class CachedAuthentication {
97 final String host;
98
99 final int port;
100
101 final String user;
102
103 final String pass;
104
105 /**
106 * Create a new cached authentication.
107 *
108 * @param aHost
109 * system this is for.
110 * @param aPort
111 * port number of the service.
112 * @param aUser
113 * username at the service.
114 * @param aPass
115 * password at the service.
116 */
117 public CachedAuthentication(final String aHost, final int aPort,
118 final String aUser, final String aPass) {
119 host = aHost;
120 port = aPort;
121 user = aUser;
122 pass = aPass;
123 }
124
125 PasswordAuthentication toPasswordAuthentication() {
126 return new PasswordAuthentication(user, pass.toCharArray());
127 }
128 }
129 }