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;
44
45 import java.io.IOException;
46 import java.security.GeneralSecurityException;
47
48 import org.apache.sshd.common.config.keys.FilePasswordProvider;
49
50 /**
51 * A {@link FilePasswordProvider} augmented to support repeatedly asking for
52 * passwords.
53 *
54 */
55 public interface RepeatingFilePasswordProvider extends FilePasswordProvider {
56
57 /**
58 * Define the maximum number of attempts to get a password that should be
59 * attempted for one identity resource through this provider.
60 *
61 * @param numberOfPasswordPrompts
62 * number of times to ask for a password;
63 * {@link IllegalArgumentException} may be thrown if <= 0
64 */
65 void setAttempts(int numberOfPasswordPrompts);
66
67 /**
68 * Gets the maximum number of attempts to get a password that should be
69 * attempted for one identity resource through this provider.
70 *
71 * @return the maximum number of attempts to try, always >= 1.
72 */
73 default int getAttempts() {
74 return 1;
75 }
76
77 // The following part of this interface is from the upstream resolution of
78 // SSHD-850. See https://github.com/apache/mina-sshd/commit/f19bd2e34 .
79 // TODO: remove this once we move to sshd > 2.1.0
80
81 /**
82 * Result value of
83 * {@link RepeatingFilePasswordProvider#handleDecodeAttemptResult(String, String, Exception)}.
84 */
85 public enum ResourceDecodeResult {
86 /** Re-throw the decoding exception. */
87 TERMINATE,
88 /** Retry the decoding process - including password prompt. */
89 RETRY,
90 /** Skip attempt and see if we can proceed without the key. */
91 IGNORE;
92 }
93
94 /**
95 * Invoked to inform the password provider about the decoding result.
96 * <b>Note:</b> any exception thrown from this method (including if called
97 * to inform about success) will be propagated instead of the original (if
98 * any was reported)
99 *
100 * @param resourceKey
101 * The resource key representing the <U>private</U> file
102 * @param password
103 * The password that was attempted
104 * @param err
105 * The attempt result - {@code null} for success
106 * @return How to proceed in case of error - <u>ignored</u> if invoked in
107 * order to report success. <b>Note:</b> {@code null} is same as
108 * {@link ResourceDecodeResult#TERMINATE}.
109 * @throws IOException
110 * @throws GeneralSecurityException
111 */
112 ResourceDecodeResult handleDecodeAttemptResult(String resourceKey,
113 String password, Exception err)
114 throws IOException, GeneralSecurityException;
115 }