zydronium/google-nomulus
1
0
Fork 0
mirror of https://github.com/google/nomulus.git synced 2025-05-13 07:57:13 +02:00
Code Issues Projects Releases Packages Wiki Activity

Fix some GPG related test issues

Browse source 
We were running FOSS tests on an old version of Ubuntu (14.04) which comes with a rather old gpg version 1.4.16 compared to the current version 2.1.22 (https://lists.gnupg.org/pipermail/gnupg-announce/2017q3/000411.html). As a result some default settings have changed between these versions, leading to test failures when tests are run on newer platforms. In this CL several of the settings are made explicit, no longer depending on default values, which makes them work on either platform.

1. "--no-mdc-error" is set. We do not have mdc integrity protection for the test keys, which results in a non-zero return value for newer versions of GPG. Setting this flag makes return value zero again.

2. "--keyid-format" long is set. GPG key IDs are the last 16 (long key id) or 8 (short key id) octets of the key fingerprint (https://security.stackexchange.com/questions/84280/short-openpgp-key-ids-are-insecure-how-to-configure-gnupg-to-use-long-key-ids-i). Older version uses the short id as default, whereas newer versions defaults to long id. Also change the expected key ID to 16 bytes accordingly.

3. Output stderr in GpgSystemCommandRule when failure occurs during key import. This help debug key import failure due to too long gpg root path. Note: this failure itself is not fixed and still would occur on newer Debian or macOS systems.

4. Set gpg root folder permission correctly to 700, otherwise the newer version gpg will return non-zero value. Previously used method set it to 755.

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=178163297
This commit is contained in:
jianglai 2017-12-06 15:32:53 -08:00
parent d87f01e7bf
commit 6bd0fc58de
4 changed files with 59 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

42
javatests/google/registry/testing/GpgSystemCommandRule.java
View file

@ -18,10 +18,17 @@ import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.base.Preconditions.checkState;
import static com.google.common.truth.Truth.assertWithMessage;
import static java.nio.charset.StandardCharsets.UTF_8;
import com.google.common.io.ByteSource;
import com.google.common.io.CharStreams;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.nio.file.Files;
import java.nio.file.attribute.PosixFilePermissions;
import java.util.Objects;
import org.junit.rules.ExternalResource;
/**
@ -53,51 +60,58 @@ public final class GpgSystemCommandRule extends ExternalResource {
/** Returns the temporary directory from which commands are run. */
public File getCwd() {
checkState(cwd != DEV_NULL);
checkState(!Objects.equals(cwd, DEV_NULL));
return cwd;
}
/** Returns the temporary directory in which GnuPG configs are stored. */
public File getConf() {
checkState(conf != DEV_NULL);
checkState(!Objects.equals(conf, DEV_NULL));
return conf;
}
/**
* Runs specified system command and arguments within the GPG testing environment.
*
* @throws IOException
* @see Runtime#exec(String[])
*/
public final Process exec(String... args) throws IOException {
checkState(cwd != DEV_NULL);
checkState(!Objects.equals(cwd, DEV_NULL));
checkArgument(args.length > 0, "args");
return runtime.exec(args, env, cwd);
}
@Override
protected void before() throws IOException, InterruptedException {
checkState(cwd == DEV_NULL);
checkState(Objects.equals(cwd, DEV_NULL));
cwd = File.createTempFile(TEMP_FILE_PREFIX, "", null);
cwd.delete();
cwd.mkdir();
conf = new File(cwd, ".gnupg");
conf.mkdir();
conf.setReadable(true, true);
env = new String[] {
"PATH=" + System.getenv("PATH"),
"GNUPGHOME=" + conf.getAbsolutePath(),
};
Files.setPosixFilePermissions(conf.toPath(), PosixFilePermissions.fromString("rwx------"));
env =
new String[] {
"PATH=" + System.getenv("PATH"), "GNUPGHOME=" + conf.getAbsolutePath(),
};
Process pid = exec("gpg", "--import");
publicKeyring.copyTo(pid.getOutputStream());
pid.getOutputStream().close();
assertWithMessage("Failed to import public keyring").that(pid.waitFor()).isEqualTo(0);
int returnValue = pid.waitFor();
assertWithMessage(
String.format("Failed to import public keyring: \n%s", slurp(pid.getErrorStream())))
.that(returnValue)
.isEqualTo(0);
pid = exec("gpg", "--allow-secret-key-import", "--import");
privateKeyring.copyTo(pid.getOutputStream());
pid.getOutputStream().close();
assertWithMessage("Failed to import private keyring").that(pid.waitFor()).isEqualTo(0);
returnValue = pid.waitFor();
assertWithMessage(
String.format("Failed to import private keyring: \n%s", slurp(pid.getErrorStream())))
.that(returnValue)
.isEqualTo(0);
}
@Override
@ -105,4 +119,8 @@ public final class GpgSystemCommandRule extends ExternalResource {
cwd = DEV_NULL;
conf = DEV_NULL;
}
private String slurp(InputStream is) throws IOException {
return CharStreams.toString(new InputStreamReader(is, UTF_8));
}
}