1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache license, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the license for the specific language governing permissions and
15 * limitations under the license.
16 */
17 package org.apache.logging.log4j.core.net.ssl;
18
19 /**
20 * PasswordProvider implementations are able to produce a password from somewhere. The source of the password data
21 * is implementation-specific.
22 * <p>The {@link #getPassword()} method may be called multiple times as needed, so the
23 * caller does not need to (and <b>should not</b>) keep the password data in memory for longer than absolutely
24 * necessary. Users of this class should erase the password array by calling
25 * {@link java.util.Arrays#fill(char[], char)} immediately when authentication is complete and the password data
26 * is no longer needed.
27 * </p>
28 */
29 public interface PasswordProvider {
30
31 /**
32 * Returns a new char[] array with the password characters.
33 * <p>
34 * It is the responsibility of the caller to erase this data by calling
35 * {@link java.util.Arrays#fill(char[], char)} immediately when authentication is complete and the password data
36 * is no longer needed.
37 * </p>
38 * @return a copy of the password
39 */
40 char[] getPassword();
41 }