org.keycloak.vault.VaultCharSecret Maven / Gradle / Ivy
/*
* Copyright 2019 Red Hat, Inc. and/or its affiliates
* and other contributors as indicated by the @author tags.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.keycloak.vault;
import java.nio.CharBuffer;
import java.util.Optional;
/**
* A {@link CharBuffer} based representation of the secret obtained from the vault that supports automated cleanup of memory.
*
* @author Stefan Guilhen
*/
public interface VaultCharSecret extends AutoCloseable {
/**
* Returns the secret enclosed in a {@link CharBuffer}.
*
* @return If the secret was successfully resolved by vault, returns an {@link Optional} containing the value returned
* by the vault as a {@link CharBuffer} (a valid value can be {@code null}), or an empty {@link Optional}
*/
Optional get();
/**
* Returns the secret in its {@code char[]} form.
*
* @return If the secret was successfully resolved by vault, returns an {@link Optional} containing the value returned
* by the vault as a {@code char[]} (a valid value can be {@code null}), or an empty {@link Optional}.
*/
Optional getAsArray();
/**
* Destroys the secret in memory by e.g. overwriting it with random garbage.
*/
@Override
void close();
}