View Javadoc
1   /*
2    * Copyright (C) 2014, Alexey Kuznetsov <axet@me.com>
3    *
4    * This program and the accompanying materials are made available
5    * under the terms of the Eclipse Distribution License v1.0 which
6    * accompanies this distribution, is reproduced below, and is
7    * available at http://www.eclipse.org/org/documents/edl-v10.php
8    *
9    * All rights reserved.
10   *
11   * Redistribution and use in source and binary forms, with or
12   * without modification, are permitted provided that the following
13   * conditions are met:
14   *
15   * - Redistributions of source code must retain the above copyright
16   *   notice, this list of conditions and the following disclaimer.
17   *
18   * - Redistributions in binary form must reproduce the above
19   *   copyright notice, this list of conditions and the following
20   *   disclaimer in the documentation and/or other materials provided
21   *   with the distribution.
22   *
23   * - Neither the name of the Eclipse Foundation, Inc. nor the
24   *   names of its contributors may be used to endorse or promote
25   *   products derived from this software without specific prior
26   *   written permission.
27   *
28   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
29   * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
30   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
31   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
32   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
33   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
34   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
35   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
36   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
37   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
38   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
39   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
40   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
41   */
42  package org.eclipse.jgit.transport;
43  
44  import org.eclipse.jgit.errors.UnsupportedCredentialItem;
45  import org.eclipse.jgit.transport.NetRC.NetRCEntry;
46  
47  /**
48   * Simple .netrc credentials provider. It can lookup the first machine entry
49   * from your .netrc file.
50   *
51   * @since 3.5
52   */
53  public class NetRCCredentialsProvider extends CredentialsProvider {
54  
55  	NetRC netrc = new NetRC();
56  
57  	/**
58  	 * <p>Constructor for NetRCCredentialsProvider.</p>
59  	 */
60  	public NetRCCredentialsProvider() {
61  	}
62  
63  	/**
64  	 * Install default provider for the .netrc parser.
65  	 */
66  	public static void install() {
67  		CredentialsProvider.setDefault(new NetRCCredentialsProvider());
68  	}
69  
70  	/** {@inheritDoc} */
71  	@Override
72  	public boolean supports(CredentialItem... items) {
73  		for (CredentialItem i : items) {
74  			if (i instanceof CredentialItem.Username)
75  				continue;
76  			else if (i instanceof CredentialItem.Password)
77  				continue;
78  			else
79  				return false;
80  		}
81  		return true;
82  	}
83  
84  	/** {@inheritDoc} */
85  	@Override
86  	public boolean get(URIish uri, CredentialItem... items)
87  			throws UnsupportedCredentialItem {
88  		NetRCEntry cc = netrc.getEntry(uri.getHost());
89  
90  		if (cc == null)
91  			return false;
92  
93  		for (CredentialItem i : items) {
94  			if (i instanceof CredentialItem.Username) {
95  				((CredentialItem.Username) i).setValue(cc.login);
96  				continue;
97  			}
98  			if (i instanceof CredentialItem.Password) {
99  				((CredentialItem.Password) i).setValue(cc.password);
100 				continue;
101 			}
102 			if (i instanceof CredentialItem.StringType) {
103 				if (i.getPromptText().equals("Password: ")) { //$NON-NLS-1$
104 					((CredentialItem.StringType) i).setValue(new String(
105 							cc.password));
106 					continue;
107 				}
108 			}
109 			throw new UnsupportedCredentialItem(uri, i.getClass().getName()
110 					+ ":" + i.getPromptText()); //$NON-NLS-1$
111 		}
112 		return !isAnyNull(items);
113 	}
114 
115 	/** {@inheritDoc} */
116 	@Override
117 	public boolean isInteractive() {
118 		return false;
119 	}
120 }