org.netbeans.modules.keyring.spi.EncryptionProvider Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.netbeans.modules.keyring.spi;
import java.util.concurrent.Callable;
import org.netbeans.spi.keyring.KeyringProvider;
/**
* A weaker version of {@link KeyringProvider} which can only encrypt passwords securely.
* Rather than managing the complete storage of the keyring, a NetBeans-specific keyring
* is used, but this provider can encrypt the sensitive contents.
* The encryption is assumed to be symmetric but the encryption key should be secured.
* If the NetBeans {@link KeyringProvider} is used, the first encryption provider to be found
* in global lookup which claims to be enabled will be used;
* a standard implementation exists (at position 1000) which uses a simple master password.
*/
public interface EncryptionProvider {
/**
* Check whether this provider can be used in the current JVM session.
* If integrating a native library, this should attempt to load it.
* This method will be called at most once per JVM session,
* prior to any other methods in this interface being called.
* @return true if this provider should be used, false if not
*/
boolean enabled();
/**
* Define a unique ID for this encryption provider, so that if the same userdir
* is reused on machines of different architecture the encrypted passwords will not conflict.
* @return an arbitrary ID specific to the algorithm
*/
String id();
/**
* Encrypt a password or other sensitive data so that only the current user can decrypt it.
* @param cleartext some data (may be nulled out after this call)
* @return encrypted data
* @throws Exception if anything goes wrong
*/
byte[] encrypt(char[] cleartext) throws Exception;
/**
* Decrypt a password or other sensitive data.
* @param ciphertext encrypted data
* @return cleartext (may be nulled out after this call)
* @throws Exception if anything goes wrong
*/
char[] decrypt(byte[] ciphertext) throws Exception;
/**
* Called if {@link #decrypt} produced incorrect results on a sample key.
* The provider can react by prompting again for a master password, for example.
* Implementations which do not support dynamic changes to the encryption
* key or method should return false from this method.
* @return true if an attempt was made to correct the encryption, false if nothing has changed
*/
boolean decryptionFailed();
/**
* Offers a callback in case the encryption needs to change.
* For example, this may be employed if the user asks to change a master password.
* During the callback, the provider will be asked to decrypt existing secrets
* using the old encryption key; then {@link #encryptionChanged}
* will be called; finally the secrets will be reencrypted using the new encryption key.
*
Implementations which do not support dynamic changes to the encryption
* key or method may ignore this method.
* @param callback a callback which the provider may store and later call
*/
void encryptionChangingCallback(Callable callback);
/**
* See {@link #encryptionChangingCallback} for description.
* Implementations which do not support dynamic changes to the encryption
* key or method may ignore this method.
*/
void encryptionChanged();
/**
* Tells the provider whether this is a new, empty keyring.
* @param fresh true if this is a new keyring, false if it has been used before
*/
void freshKeyring(boolean fresh);
}