169 lines
6.2 KiB
Java
169 lines
6.2 KiB
Java
// SPDX-FileCopyrightText: 2021 Paul Schaub <vanitasvitae@fsfe.org>
|
|
//
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package org.pgpainless.sop;
|
|
|
|
import java.io.IOException;
|
|
import java.io.InputStream;
|
|
import java.io.OutputStream;
|
|
import java.util.ArrayList;
|
|
import java.util.List;
|
|
|
|
import org.bouncycastle.openpgp.PGPException;
|
|
import org.bouncycastle.openpgp.PGPSecretKeyRing;
|
|
import org.bouncycastle.openpgp.PGPSecretKeyRingCollection;
|
|
import org.bouncycastle.openpgp.PGPSignature;
|
|
import org.bouncycastle.util.io.Streams;
|
|
import org.pgpainless.PGPainless;
|
|
import org.pgpainless.algorithm.DocumentSignatureType;
|
|
import org.pgpainless.encryption_signing.EncryptionResult;
|
|
import org.pgpainless.encryption_signing.EncryptionStream;
|
|
import org.pgpainless.encryption_signing.ProducerOptions;
|
|
import org.pgpainless.encryption_signing.SigningOptions;
|
|
import org.pgpainless.exception.KeyException;
|
|
import org.pgpainless.key.OpenPgpFingerprint;
|
|
import org.pgpainless.key.SubkeyIdentifier;
|
|
import org.pgpainless.key.info.KeyRingInfo;
|
|
import org.pgpainless.util.ArmoredOutputStreamFactory;
|
|
import org.pgpainless.util.Passphrase;
|
|
import sop.MicAlg;
|
|
import sop.ReadyWithResult;
|
|
import sop.SigningResult;
|
|
import sop.enums.SignAs;
|
|
import sop.exception.SOPGPException;
|
|
import sop.operation.DetachedSign;
|
|
import sop.util.UTF8Util;
|
|
|
|
import javax.annotation.Nonnull;
|
|
|
|
/**
|
|
* Implementation of the <pre>sign</pre> operation using PGPainless.
|
|
*/
|
|
public class DetachedSignImpl implements DetachedSign {
|
|
|
|
private boolean armor = true;
|
|
private SignAs mode = SignAs.binary;
|
|
private final SigningOptions signingOptions = SigningOptions.get();
|
|
private final MatchMakingSecretKeyRingProtector protector = new MatchMakingSecretKeyRingProtector();
|
|
private final List<PGPSecretKeyRing> signingKeys = new ArrayList<>();
|
|
|
|
@Override
|
|
public DetachedSign noArmor() {
|
|
armor = false;
|
|
return this;
|
|
}
|
|
|
|
@Override
|
|
@Nonnull
|
|
public DetachedSign mode(@Nonnull SignAs mode) {
|
|
this.mode = mode;
|
|
return this;
|
|
}
|
|
|
|
@Override
|
|
@Nonnull
|
|
public DetachedSign key(@Nonnull InputStream keyIn) throws SOPGPException.KeyCannotSign, SOPGPException.BadData, IOException {
|
|
PGPSecretKeyRingCollection keys = KeyReader.readSecretKeys(keyIn, true);
|
|
for (PGPSecretKeyRing key : keys) {
|
|
KeyRingInfo info = PGPainless.inspectKeyRing(key);
|
|
if (!info.isUsableForSigning()) {
|
|
throw new SOPGPException.KeyCannotSign("Key " + info.getFingerprint() + " does not have valid, signing capable subkeys.");
|
|
}
|
|
protector.addSecretKey(key);
|
|
signingKeys.add(key);
|
|
}
|
|
return this;
|
|
}
|
|
|
|
@Override
|
|
@Nonnull
|
|
public DetachedSign withKeyPassword(@Nonnull byte[] password) {
|
|
String string = new String(password, UTF8Util.UTF8);
|
|
protector.addPassphrase(Passphrase.fromPassword(string));
|
|
return this;
|
|
}
|
|
|
|
@Override
|
|
@Nonnull
|
|
public ReadyWithResult<SigningResult> data(@Nonnull InputStream data) throws IOException {
|
|
for (PGPSecretKeyRing key : signingKeys) {
|
|
try {
|
|
signingOptions.addDetachedSignature(protector, key, modeToSigType(mode));
|
|
} catch (KeyException.UnacceptableSigningKeyException | KeyException.MissingSecretKeyException e) {
|
|
throw new SOPGPException.KeyCannotSign("Key " + OpenPgpFingerprint.of(key) + " cannot sign.", e);
|
|
} catch (PGPException e) {
|
|
throw new SOPGPException.KeyIsProtected("Key " + OpenPgpFingerprint.of(key) + " cannot be unlocked.", e);
|
|
}
|
|
}
|
|
|
|
OutputStream sink = new NullOutputStream();
|
|
try {
|
|
EncryptionStream signingStream = PGPainless.encryptAndOrSign()
|
|
.onOutputStream(sink)
|
|
.withOptions(ProducerOptions.sign(signingOptions)
|
|
.setAsciiArmor(armor));
|
|
|
|
return new ReadyWithResult<SigningResult>() {
|
|
@Override
|
|
public SigningResult writeTo(@Nonnull OutputStream outputStream) throws IOException {
|
|
|
|
if (signingStream.isClosed()) {
|
|
throw new IllegalStateException("EncryptionStream is already closed.");
|
|
}
|
|
|
|
Streams.pipeAll(data, signingStream);
|
|
signingStream.close();
|
|
EncryptionResult encryptionResult = signingStream.getResult();
|
|
|
|
// forget passphrases
|
|
protector.clear();
|
|
|
|
List<PGPSignature> signatures = new ArrayList<>();
|
|
for (SubkeyIdentifier key : encryptionResult.getDetachedSignatures().keySet()) {
|
|
signatures.addAll(encryptionResult.getDetachedSignatures().get(key));
|
|
}
|
|
|
|
OutputStream out;
|
|
if (armor) {
|
|
out = ArmoredOutputStreamFactory.get(outputStream);
|
|
} else {
|
|
out = outputStream;
|
|
}
|
|
for (PGPSignature sig : signatures) {
|
|
sig.encode(out);
|
|
}
|
|
out.close();
|
|
outputStream.close(); // armor out does not close underlying stream
|
|
|
|
return SigningResult.builder()
|
|
.setMicAlg(micAlgFromSignatures(signatures))
|
|
.build();
|
|
}
|
|
};
|
|
|
|
} catch (PGPException e) {
|
|
throw new RuntimeException(e);
|
|
}
|
|
|
|
}
|
|
|
|
private MicAlg micAlgFromSignatures(Iterable<PGPSignature> signatures) {
|
|
int algorithmId = 0;
|
|
for (PGPSignature signature : signatures) {
|
|
int sigAlg = signature.getHashAlgorithm();
|
|
if (algorithmId == 0 || algorithmId == sigAlg) {
|
|
algorithmId = sigAlg;
|
|
} else {
|
|
return MicAlg.empty();
|
|
}
|
|
}
|
|
return algorithmId == 0 ? MicAlg.empty() : MicAlg.fromHashAlgorithmId(algorithmId);
|
|
}
|
|
|
|
private static DocumentSignatureType modeToSigType(SignAs mode) {
|
|
return mode == SignAs.binary ? DocumentSignatureType.BINARY_DOCUMENT
|
|
: DocumentSignatureType.CANONICAL_TEXT_DOCUMENT;
|
|
}
|
|
}
|