70 lines
1.8 KiB
Java
70 lines
1.8 KiB
Java
// SPDX-FileCopyrightText: 2021 Paul Schaub <vanitasvitae@fsfe.org>
|
|
//
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package sop.operation;
|
|
|
|
import java.io.ByteArrayInputStream;
|
|
import java.io.IOException;
|
|
import java.io.InputStream;
|
|
|
|
import sop.ReadyWithResult;
|
|
import sop.SigningResult;
|
|
import sop.enums.SignAs;
|
|
import sop.exception.SOPGPException;
|
|
|
|
public interface Sign {
|
|
|
|
/**
|
|
* Disable ASCII armor encoding.
|
|
*
|
|
* @return builder instance
|
|
*/
|
|
Sign noArmor();
|
|
|
|
/**
|
|
* Sets the signature mode.
|
|
* Note: This method has to be called before {@link #key(InputStream)} is called.
|
|
*
|
|
* @param mode signature mode
|
|
* @return builder instance
|
|
*/
|
|
Sign mode(SignAs mode) throws SOPGPException.UnsupportedOption;
|
|
|
|
/**
|
|
* Add one or more signing keys.
|
|
*
|
|
* @param key input stream containing encoded keys
|
|
* @return builder instance
|
|
*/
|
|
Sign key(InputStream key) throws SOPGPException.KeyIsProtected, SOPGPException.BadData, IOException;
|
|
|
|
/**
|
|
* Add one or more signing keys.
|
|
*
|
|
* @param key byte array containing encoded keys
|
|
* @return builder instance
|
|
*/
|
|
default Sign key(byte[] key) throws SOPGPException.KeyIsProtected, SOPGPException.BadData, IOException {
|
|
return key(new ByteArrayInputStream(key));
|
|
}
|
|
|
|
/**
|
|
* Signs data.
|
|
*
|
|
* @param data input stream containing data
|
|
* @return ready
|
|
*/
|
|
ReadyWithResult<SigningResult> data(InputStream data) throws IOException, SOPGPException.ExpectedText;
|
|
|
|
/**
|
|
* Signs data.
|
|
*
|
|
* @param data byte array containing data
|
|
* @return ready
|
|
*/
|
|
default ReadyWithResult<SigningResult> data(byte[] data) throws IOException, SOPGPException.ExpectedText {
|
|
return data(new ByteArrayInputStream(data));
|
|
}
|
|
}
|