tor-commits February 2017

tor-commits@lists.torproject.org

14 participants
1811 discussions

[metrics-lib/master] Parse "shared-rand-.*" lines in consensuses and votes.
by karsten＠torproject.org 14 Feb '17

14 Feb '17

commit 110cb01250703d2825d956752ec84557583144ec Author: Karsten Loesing <karsten.loesing(a)gmx.net> Date: Mon Feb 13 15:54:06 2017 +0100 Parse "shared-rand-.*" lines in consensuses and votes. --- CHANGELOG.md | 1 + .../descriptor/RelayNetworkStatusConsensus.java | 34 +++++++ .../descriptor/RelayNetworkStatusVote.java | 55 +++++++++++ .../impl/RelayNetworkStatusConsensusImpl.java | 69 +++++++++++++- .../impl/RelayNetworkStatusVoteImpl.java | 104 ++++++++++++++++++++- .../descriptor/impl/ConsensusBuilder.java | 30 ++++++ .../impl/RelayNetworkStatusConsensusImplTest.java | 15 +++ .../impl/RelayNetworkStatusVoteImplTest.java | 97 +++++++++++++++++++ 8 files changed, 402 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6bcfea9..a760143 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -16,6 +16,7 @@ - Parse "proto" lines in server descriptors, "pr" lines in status entries, and "(recommended|required)-(client|relay)-protocols" lines in consensuses and votes. + - Parse "shared-rand-.*" lines in consensuses and votes. # Changes in version 1.5.0 - 2016-10-19 diff --git a/src/main/java/org/torproject/descriptor/RelayNetworkStatusConsensus.java b/src/main/java/org/torproject/descriptor/RelayNetworkStatusConsensus.java index b004b66..57a8dd6 100644 --- a/src/main/java/org/torproject/descriptor/RelayNetworkStatusConsensus.java +++ b/src/main/java/org/torproject/descriptor/RelayNetworkStatusConsensus.java @@ -179,6 +179,40 @@ public interface RelayNetworkStatusConsensus extends Descriptor { public SortedMap<String, Integer> getConsensusParams(); /** + * Return the number of commits used to generate the second-to-last shared + * random value, or -1 if the consensus does not contain a second-to-last + * shared random value. + * + * @since 1.6.0 + */ + public int getSharedRandPreviousNumReveals(); + + /** + * Return the second-to-last shared random value, encoded in base64, or null + * if the consensus does not contain a second-to-last shared random value. + * + * @since 1.6.0 + */ + public String getSharedRandPreviousValue(); + + /** + * Return the number of commits used to generate the latest shared random + * value, or -1 if the consensus does not contain the latest shared random + * value. + * + * @since 1.6.0 + */ + public int getSharedRandCurrentNumReveals(); + + /** + * Return the latest shared random value, encoded in base64, or null if the + * consensus does not contain the latest shared random value. + * + * @since 1.6.0 + */ + public String getSharedRandCurrentValue(); + + /** * Return directory source entries for each directory authority that * contributed to the consensus, with map keys being SHA-1 digests of * the authorities' identity keys in the version 3 directory protocol, diff --git a/src/main/java/org/torproject/descriptor/RelayNetworkStatusVote.java b/src/main/java/org/torproject/descriptor/RelayNetworkStatusVote.java index 9ea804d..cfb012b 100644 --- a/src/main/java/org/torproject/descriptor/RelayNetworkStatusVote.java +++ b/src/main/java/org/torproject/descriptor/RelayNetworkStatusVote.java @@ -306,6 +306,61 @@ public interface RelayNetworkStatusVote extends Descriptor { public String getContactLine(); /** + * Return whether this directory authority supports and can participate in + * the shared random protocol. + * + * @since 1.6.0 + */ + public boolean isSharedRandParticipate(); + + /** + * Return all currently known directory authority commit lines for the shared + * randomness protocol in the original format as they are contained in this + * vote, or null if this vote does not contain any such line. + * + * <pre> + * "shared-rand-commit" SP Version SP AlgName SP Identity SP Commit + * [SP Reveal] NL + * </pre> + * + * @since 1.6.0 + */ + public List<String> getSharedRandCommitLines(); + + /** + * Return the number of commits used to generate the second-to-last shared + * random value, or -1 if this vote does not contain a second-to-last shared + * random value. + * + * @since 1.6.0 + */ + public int getSharedRandPreviousNumReveals(); + + /** + * Return the second-to-last shared random value, encoded in base64, or null + * if this vote does not contain a second-to-last shared random value. + * + * @since 1.6.0 + */ + public String getSharedRandPreviousValue(); + + /** + * Return the number of commits used to generate the latest shared random + * value, or -1 if this vote does not contain the latest shared random value. + * + * @since 1.6.0 + */ + public int getSharedRandCurrentNumReveals(); + + /** + * Return the latest shared random value, encoded in base64, or null if this + * vote does not contain the latest shared random value. + * + * @since 1.6.0 + */ + public String getSharedRandCurrentValue(); + + /** * Return the version of the directory key certificate used by this * authority, which must be 3 or higher. * diff --git a/src/main/java/org/torproject/descriptor/impl/RelayNetworkStatusConsensusImpl.java b/src/main/java/org/torproject/descriptor/impl/RelayNetworkStatusConsensusImpl.java index fd4cf7e..dcb8938 100644 --- a/src/main/java/org/torproject/descriptor/impl/RelayNetworkStatusConsensusImpl.java +++ b/src/main/java/org/torproject/descriptor/impl/RelayNetworkStatusConsensusImpl.java @@ -54,8 +54,9 @@ public class RelayNetworkStatusConsensusImpl extends NetworkStatusImpl Set<String> atMostOnceKeywords = new HashSet<>(Arrays.asList(( "client-versions,server-versions,recommended-client-protocols," + "recommended-relay-protocols,required-client-protocols," - + "required-relay-protocols,params,directory-footer," - + "bandwidth-weights").split(","))); + + "required-relay-protocols,params,shared-rand-previous-value," + + "shared-rand-current-value,directory-footer,bandwidth-weights") + .split(","))); this.checkAtMostOnceKeywords(atMostOnceKeywords); this.checkFirstKeyword("network-status-version"); this.clearParsedKeywords(); @@ -147,6 +148,12 @@ public class RelayNetworkStatusConsensusImpl extends NetworkStatusImpl case "params": this.parseParamsLine(line, parts); break; + case "shared-rand-previous-value": + this.parseSharedRandPreviousValueLine(line, parts); + break; + case "shared-rand-current-value": + this.parseSharedRandCurrentValueLine(line, parts); + break; default: if (this.failUnrecognizedDescriptorLines) { throw new DescriptorParseException("Unrecognized line '" @@ -350,6 +357,36 @@ public class RelayNetworkStatusConsensusImpl extends NetworkStatusImpl parts, 1, "="); } + private void parseSharedRandPreviousValueLine(String line, String[] parts) + throws DescriptorParseException { + if (parts.length != 3) { + throw new DescriptorParseException("Illegal line '" + line + + "' in vote."); + } + try { + this.sharedRandPreviousNumReveals = Integer.parseInt(parts[1]); + } catch (NumberFormatException e) { + throw new DescriptorParseException("Illegal line '" + line + + "' in vote."); + } + this.sharedRandPreviousValue = parts[2]; + } + + private void parseSharedRandCurrentValueLine(String line, String[] parts) + throws DescriptorParseException { + if (parts.length != 3) { + throw new DescriptorParseException("Illegal line '" + line + + "' in vote."); + } + try { + this.sharedRandCurrentNumReveals = Integer.parseInt(parts[1]); + } catch (NumberFormatException e) { + throw new DescriptorParseException("Illegal line '" + line + + "' in vote."); + } + this.sharedRandCurrentValue = parts[2]; + } + private void parseBandwidthWeightsLine(String line, String[] parts) throws DescriptorParseException { this.bandwidthWeights = ParseHelper.parseKeyValueIntegerPairs(line, @@ -486,6 +523,34 @@ public class RelayNetworkStatusConsensusImpl extends NetworkStatusImpl : new TreeMap<>(this.consensusParams); } + private int sharedRandPreviousNumReveals = -1; + + @Override + public int getSharedRandPreviousNumReveals() { + return this.sharedRandPreviousNumReveals; + } + + private String sharedRandPreviousValue = null; + + @Override + public String getSharedRandPreviousValue() { + return this.sharedRandPreviousValue; + } + + private int sharedRandCurrentNumReveals = -1; + + @Override + public int getSharedRandCurrentNumReveals() { + return this.sharedRandCurrentNumReveals; + } + + private String sharedRandCurrentValue = null; + + @Override + public String getSharedRandCurrentValue() { + return this.sharedRandCurrentValue; + } + private SortedMap<String, Integer> bandwidthWeights; @Override diff --git a/src/main/java/org/torproject/descriptor/impl/RelayNetworkStatusVoteImpl.java b/src/main/java/org/torproject/descriptor/impl/RelayNetworkStatusVoteImpl.java index 619b2c1..1f64173 100644 --- a/src/main/java/org/torproject/descriptor/impl/RelayNetworkStatusVoteImpl.java +++ b/src/main/java/org/torproject/descriptor/impl/RelayNetworkStatusVoteImpl.java @@ -54,7 +54,8 @@ public class RelayNetworkStatusVoteImpl extends NetworkStatusImpl "consensus-methods,client-versions,server-versions," + "recommended-client-protocols,recommended-relay-protocols," + "required-client-protocols,required-relay-protocols," - + "flag-thresholds,params,contact," + + "flag-thresholds,params,contact,shared-rand-participate," + + "shared-rand-previous-value,shared-rand-current-value," + "legacy-key,dir-key-crosscert,dir-address,directory-footer") .split(","))); this.checkAtMostOnceKeywords(atMostOnceKeywords); @@ -149,6 +150,18 @@ public class RelayNetworkStatusVoteImpl extends NetworkStatusImpl case "contact": this.parseContactLine(line, parts); break; + case "shared-rand-participate": + this.parseSharedRandParticipateLine(line, parts); + break; + case "shared-rand-commit": + this.parseSharedRandCommitLine(line, parts); + break; + case "shared-rand-previous-value": + this.parseSharedRandPreviousValueLine(line, parts); + break; + case "shared-rand-current-value": + this.parseSharedRandCurrentValueLine(line, parts); + break; case "dir-key-certificate-version": this.parseDirKeyCertificateVersionLine(line, parts); break; @@ -452,6 +465,53 @@ public class RelayNetworkStatusVoteImpl extends NetworkStatusImpl } } + private void parseSharedRandParticipateLine(String line, String[] parts) + throws DescriptorParseException { + if (parts.length != 1) { + throw new DescriptorParseException("Illegal line '" + line + + "' in vote."); + } + this.sharedRandParticipate = true; + } + + private void parseSharedRandCommitLine(String line, String[] parts) + throws DescriptorParseException { + if (this.sharedRandCommitLines == null) { + this.sharedRandCommitLines = new ArrayList<>(); + } + this.sharedRandCommitLines.add(line); + } + + private void parseSharedRandPreviousValueLine(String line, String[] parts) + throws DescriptorParseException { + if (parts.length != 3) { + throw new DescriptorParseException("Illegal line '" + line + + "' in vote."); + } + try { + this.sharedRandPreviousNumReveals = Integer.parseInt(parts[1]); + } catch (NumberFormatException e) { + throw new DescriptorParseException("Illegal line '" + line + + "' in vote."); + } + this.sharedRandPreviousValue = parts[2]; + } + + private void parseSharedRandCurrentValueLine(String line, String[] parts) + throws DescriptorParseException { + if (parts.length != 3) { + throw new DescriptorParseException("Illegal line '" + line + + "' in vote."); + } + try { + this.sharedRandCurrentNumReveals = Integer.parseInt(parts[1]); + } catch (NumberFormatException e) { + throw new DescriptorParseException("Illegal line '" + line + + "' in vote."); + } + this.sharedRandCurrentValue = parts[2]; + } + private void parseDirKeyCertificateVersionLine(String line, String[] parts) throws DescriptorParseException { if (parts.length != 2) { @@ -604,6 +664,48 @@ public class RelayNetworkStatusVoteImpl extends NetworkStatusImpl return this.contactLine; } + private boolean sharedRandParticipate = false; + + @Override + public boolean isSharedRandParticipate() { + return this.sharedRandParticipate; + } + + private List<String> sharedRandCommitLines = null; + + @Override + public List<String> getSharedRandCommitLines() { + return this.sharedRandCommitLines; + } + + private int sharedRandPreviousNumReveals = -1; + + @Override + public int getSharedRandPreviousNumReveals() { + return this.sharedRandPreviousNumReveals; + } + + private String sharedRandPreviousValue = null; + + @Override + public String getSharedRandPreviousValue() { + return this.sharedRandPreviousValue; + } + + private int sharedRandCurrentNumReveals = -1; + + @Override + public int getSharedRandCurrentNumReveals() { + return this.sharedRandCurrentNumReveals; + } + + private String sharedRandCurrentValue = null; + + @Override + public String getSharedRandCurrentValue() { + return this.sharedRandCurrentValue; + } + private int dirKeyCertificateVersion; @Override diff --git a/src/test/java/org/torproject/descriptor/impl/ConsensusBuilder.java b/src/test/java/org/torproject/descriptor/impl/ConsensusBuilder.java index 24d5a02..d1cacc0 100644 --- a/src/test/java/org/torproject/descriptor/impl/ConsensusBuilder.java +++ b/src/test/java/org/torproject/descriptor/impl/ConsensusBuilder.java @@ -188,6 +188,30 @@ public class ConsensusBuilder { return new RelayNetworkStatusConsensusImpl(cb.buildConsensus(), true); } + private String sharedRandPreviousValueLine = + "shared-rand-previous-value 8 " + + "grwbnD6I40odtsdtWYxqs0DvPweCur6qG2Fo5p5ivS4="; + + protected static RelayNetworkStatusConsensus + createWithSharedRandPreviousValueLine(String line) + throws DescriptorParseException { + ConsensusBuilder cb = new ConsensusBuilder(); + cb.sharedRandPreviousValueLine = line; + return new RelayNetworkStatusConsensusImpl(cb.buildConsensus(), true); + } + + private String sharedRandCurrentValueLine = + "shared-rand-current-value 8 " + + "D88plxd8YeLfCIVAR9gjiFlWB1WqpC53kWr350o1pzw="; + + protected static RelayNetworkStatusConsensus + createWithSharedRandCurrentValueLine(String line) + throws DescriptorParseException { + ConsensusBuilder cb = new ConsensusBuilder(); + cb.sharedRandCurrentValueLine = line; + return new RelayNetworkStatusConsensusImpl(cb.buildConsensus(), true); + } + List<String> dirSources = new ArrayList<>(); List<String> statusEntries = new ArrayList<>(); @@ -385,6 +409,12 @@ public class ConsensusBuilder { if (this.paramsLine != null) { sb.append(this.paramsLine).append("\n"); } + if (this.sharedRandPreviousValueLine != null) { + sb.append(this.sharedRandPreviousValueLine).append("\n"); + } + if (this.sharedRandCurrentValueLine != null) { + sb.append(this.sharedRandCurrentValueLine).append("\n"); + } if (this.unrecognizedHeaderLine != null) { sb.append(this.unrecognizedHeaderLine).append("\n"); } diff --git a/src/test/java/org/torproject/descriptor/impl/RelayNetworkStatusConsensusImplTest.java b/src/test/java/org/torproject/descriptor/impl/RelayNetworkStatusConsensusImplTest.java index 786ae54..b150a6a 100644 --- a/src/test/java/org/torproject/descriptor/impl/RelayNetworkStatusConsensusImplTest.java +++ b/src/test/java/org/torproject/descriptor/impl/RelayNetworkStatusConsensusImplTest.java @@ -855,6 +855,21 @@ public class RelayNetworkStatusConsensusImplTest { ConsensusBuilder.createWithParamsLine("params max=2147483648"); } + @Test(expected = DescriptorParseException.class) + public void testSharedRandPreviousNumRevealsOnly() + throws DescriptorParseException { + ConsensusBuilder.createWithSharedRandPreviousValueLine( + "shared-rand-previous-value 8"); + } + + @Test(expected = DescriptorParseException.class) + public void testSharedRandPreviousExtraArg() + throws DescriptorParseException { + ConsensusBuilder.createWithSharedRandCurrentValueLine( + "shared-rand-current-value 8 " + + "D88plxd8YeLfCIVAR9gjiFlWB1WqpC53kWr350o1pzw= -1.0"); + } + @Test() public void testDirSourceLegacyNickname() throws DescriptorParseException { diff --git a/src/test/java/org/torproject/descriptor/impl/RelayNetworkStatusVoteImplTest.java b/src/test/java/org/torproject/descriptor/impl/RelayNetworkStatusVoteImplTest.java index ea7b927..727d707 100644 --- a/src/test/java/org/torproject/descriptor/impl/RelayNetworkStatusVoteImplTest.java +++ b/src/test/java/org/torproject/descriptor/impl/RelayNetworkStatusVoteImplTest.java @@ -252,6 +252,52 @@ public class RelayNetworkStatusVoteImplTest { return new RelayNetworkStatusVoteImpl(vb.buildVote(), true); } + private String sharedRandParticipateLine = "shared-rand-participate"; + + private static RelayNetworkStatusVote createWithSharedRandParticipateLine( + String line) throws DescriptorParseException { + VoteBuilder vb = new VoteBuilder(); + vb.sharedRandParticipateLine = line; + return new RelayNetworkStatusVoteImpl(vb.buildVote(), true); + } + + private List<String> sharedRandCommitLines = Arrays.asList(new String[] { + "shared-rand-commit 1 sha3-256 " + + "0232AF901C31A04EE9848595AF9BB7620D4C5B2E " + + "AAAAAFieVABh3Aauk2h31FVKaW0xIm28T7VPDkzP5nHwoMItxp7iQg==", + "shared-rand-commit 1 sha3-256 " + + "14C131DFC5C6F93646BE72FA1401C02A8DF2E8B4 " + + "AAAAAFieVAA26LuAu9z2UhalmV7zuczWauSkqp1c/bsPA3AkH85iGw==" }); + + private static RelayNetworkStatusVote createWithSharedRandCommitLines( + List<String> lines) throws DescriptorParseException { + VoteBuilder vb = new VoteBuilder(); + vb.sharedRandCommitLines = lines; + return new RelayNetworkStatusVoteImpl(vb.buildVote(), true); + } + + private String sharedRandPreviousValueLine = + "shared-rand-previous-value 8 " + + "grwbnD6I40odtsdtWYxqs0DvPweCur6qG2Fo5p5ivS4="; + + private static RelayNetworkStatusVote createWithSharedRandPreviousValueLine( + String line) throws DescriptorParseException { + VoteBuilder vb = new VoteBuilder(); + vb.sharedRandPreviousValueLine = line; + return new RelayNetworkStatusVoteImpl(vb.buildVote(), true); + } + + private String sharedRandCurrentValueLine = + "shared-rand-current-value 8 " + + "D88plxd8YeLfCIVAR9gjiFlWB1WqpC53kWr350o1pzw="; + + private static RelayNetworkStatusVote createWithSharedRandCurrentValueLine( + String line) throws DescriptorParseException { + VoteBuilder vb = new VoteBuilder(); + vb.sharedRandCurrentValueLine = line; + return new RelayNetworkStatusVoteImpl(vb.buildVote(), true); + } + private String legacyDirKeyLine = null; private static RelayNetworkStatusVote @@ -572,6 +618,20 @@ public class RelayNetworkStatusVoteImplTest { if (this.contactLine != null) { sb.append(this.contactLine).append("\n"); } + if (this.sharedRandParticipateLine != null) { + sb.append(this.sharedRandParticipateLine).append("\n"); + } + if (this.sharedRandCommitLines != null) { + for (String line : this.sharedRandCommitLines) { + sb.append(line).append("\n"); + } + } + if (this.sharedRandPreviousValueLine != null) { + sb.append(this.sharedRandPreviousValueLine).append("\n"); + } + if (this.sharedRandCurrentValueLine != null) { + sb.append(this.sharedRandCurrentValueLine).append("\n"); + } if (this.legacyDirKeyLine != null) { sb.append(this.legacyDirKeyLine).append("\n"); } @@ -1252,6 +1312,43 @@ public class RelayNetworkStatusVoteImplTest { + "Appelbaum <jacob(a)appelbaum.net>"); } + @Test(expected = DescriptorParseException.class) + public void testSharedRandParticipateLineDuplicate() + throws DescriptorParseException { + VoteBuilder.createWithSharedRandParticipateLine("shared-rand-participate\n" + + "shared-rand-participate"); + } + + @Test(expected = DescriptorParseException.class) + public void testSharedRandParticipateLineArg() + throws DescriptorParseException { + VoteBuilder.createWithSharedRandParticipateLine( + "shared-rand-participate 1"); + } + + @Test() + public void testSharedRandCommitLinesEmpty() throws DescriptorParseException { + RelayNetworkStatusVote vote = + VoteBuilder.createWithSharedRandCommitLines(null); + assertNull(vote.getSharedRandCommitLines()); + } + + @Test(expected = DescriptorParseException.class) + public void testSharedRandPreviousValueBeforeNumReveals() + throws DescriptorParseException { + VoteBuilder.createWithSharedRandPreviousValueLine( + "shared-rand-previous-value " + + "grwbnD6I40odtsdtWYxqs0DvPweCur6qG2Fo5p5ivS4= 8"); + } + + @Test(expected = DescriptorParseException.class) + public void testSharedRandCurrentNoNumReveals() + throws DescriptorParseException { + VoteBuilder.createWithSharedRandCurrentValueLine( + "shared-rand-current-value " + + "D88plxd8YeLfCIVAR9gjiFlWB1WqpC53kWr350o1pzw="); + } + @Test() public void testLegacyDirKeyLine() throws DescriptorParseException { RelayNetworkStatusVote vote = VoteBuilder.createWithLegacyDirKeyLine(

1 0

[metrics-lib/master] Parse new protocol versions lines.
by karsten＠torproject.org 14 Feb '17

14 Feb '17

commit 2bcd6bb0e4cf8b535cf3b4c4ef0eed83dfc82676 Author: Karsten Loesing <karsten.loesing(a)gmx.net> Date: Mon Feb 13 12:05:47 2017 +0100 Parse new protocol versions lines. --- CHANGELOG.md | 3 + .../torproject/descriptor/NetworkStatusEntry.java | 9 +++ .../descriptor/RelayNetworkStatusConsensus.java | 36 +++++++++ .../descriptor/RelayNetworkStatusVote.java | 32 ++++++++ .../torproject/descriptor/ServerDescriptor.java | 10 +++ .../descriptor/impl/NetworkStatusEntryImpl.java | 17 ++++ .../torproject/descriptor/impl/ParseHelper.java | 47 +++++++++++ .../impl/RelayNetworkStatusConsensusImpl.java | 68 +++++++++++++++- .../impl/RelayNetworkStatusVoteImpl.java | 66 ++++++++++++++++ .../descriptor/impl/ServerDescriptorImpl.java | 20 ++++- .../descriptor/impl/ConsensusBuilder.java | 60 ++++++++++++++ .../impl/RelayNetworkStatusConsensusImplTest.java | 79 +++++++++++++++++++ .../impl/RelayNetworkStatusVoteImplTest.java | 92 ++++++++++++++++++++++ .../descriptor/impl/ServerDescriptorImplTest.java | 49 ++++++++++-- 14 files changed, 581 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 755428d..6bcfea9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,9 @@ the application can decide at any time to stop consuming descriptors without having to worry about the reader thread not being done. + - Parse "proto" lines in server descriptors, "pr" lines in status + entries, and "(recommended|required)-(client|relay)-protocols" + lines in consensuses and votes. # Changes in version 1.5.0 - 2016-10-19 diff --git a/src/main/java/org/torproject/descriptor/NetworkStatusEntry.java b/src/main/java/org/torproject/descriptor/NetworkStatusEntry.java index 68f6939..ba413bb 100644 --- a/src/main/java/org/torproject/descriptor/NetworkStatusEntry.java +++ b/src/main/java/org/torproject/descriptor/NetworkStatusEntry.java @@ -5,6 +5,7 @@ package org.torproject.descriptor; import java.util.List; import java.util.Set; +import java.util.SortedMap; import java.util.SortedSet; /** @@ -123,6 +124,14 @@ public interface NetworkStatusEntry { public String getVersion(); /** + * Return the version numbers of all protocols supported by this server, or + * null if the status entry does not specify supported protocol versions. + * + * @since 1.6.0 + */ + public SortedMap<String, SortedSet<Long>> getProtocols(); + + /** * Return the bandwidth weight of this server or -1 if the status entry * didn't contain a bandwidth line. * diff --git a/src/main/java/org/torproject/descriptor/RelayNetworkStatusConsensus.java b/src/main/java/org/torproject/descriptor/RelayNetworkStatusConsensus.java index a2deba3..b004b66 100644 --- a/src/main/java/org/torproject/descriptor/RelayNetworkStatusConsensus.java +++ b/src/main/java/org/torproject/descriptor/RelayNetworkStatusConsensus.java @@ -113,6 +113,42 @@ public interface RelayNetworkStatusConsensus extends Descriptor { public List<String> getRecommendedClientVersions(); /** + * Return the version numbers of all protocols that clients should support, + * or null if the consensus does not contain an opinion about protocol + * versions. + * + * @since 1.6.0 + */ + public SortedMap<String, SortedSet<Long>> getRecommendedClientProtocols(); + + /** + * Return the version numbers of all protocols that relays should support, + * or null if the consensus does not contain an opinion about protocol + * versions. + * + * @since 1.6.0 + */ + public SortedMap<String, SortedSet<Long>> getRecommendedRelayProtocols(); + + /** + * Return the version numbers of all protocols that clients must support, + * or null if the consensus does not contain an opinion about protocol + * versions. + * + * @since 1.6.0 + */ + public SortedMap<String, SortedSet<Long>> getRequiredClientProtocols(); + + /** + * Return the version numbers of all protocols that relays must support, + * or null if the consensus does not contain an opinion about protocol + * versions. + * + * @since 1.6.0 + */ + public SortedMap<String, SortedSet<Long>> getRequiredRelayProtocols(); + + /** * Return a list of software packages and their versions together with a * URL and one or more digests in the format <code>PackageName Version * URL DIGESTS</code> that are known by at least three directory diff --git a/src/main/java/org/torproject/descriptor/RelayNetworkStatusVote.java b/src/main/java/org/torproject/descriptor/RelayNetworkStatusVote.java index a3f8170..9ea804d 100644 --- a/src/main/java/org/torproject/descriptor/RelayNetworkStatusVote.java +++ b/src/main/java/org/torproject/descriptor/RelayNetworkStatusVote.java @@ -105,6 +105,38 @@ public interface RelayNetworkStatusVote extends Descriptor { public List<String> getRecommendedClientVersions(); /** + * Return the version numbers of all protocols that clients should support, + * or null if the vote does not contain an opinion about protocol versions. + * + * @since 1.6.0 + */ + public SortedMap<String, SortedSet<Long>> getRecommendedClientProtocols(); + + /** + * Return the version numbers of all protocols that relays should support, + * or null if the vote does not contain an opinion about protocol versions. + * + * @since 1.6.0 + */ + public SortedMap<String, SortedSet<Long>> getRecommendedRelayProtocols(); + + /** + * Return the version numbers of all protocols that clients must support, + * or null if the vote does not contain an opinion about protocol versions. + * + * @since 1.6.0 + */ + public SortedMap<String, SortedSet<Long>> getRequiredClientProtocols(); + + /** + * Return the version numbers of all protocols that relays must support, + * or null if the vote does not contain an opinion about protocol versions. + * + * @since 1.6.0 + */ + public SortedMap<String, SortedSet<Long>> getRequiredRelayProtocols(); + + /** * Return a list of software packages and their versions together with a * URL and one or more digests in the format <code>PackageName Version * URL DIGESTS</code> that are known by this directory authority, or diff --git a/src/main/java/org/torproject/descriptor/ServerDescriptor.java b/src/main/java/org/torproject/descriptor/ServerDescriptor.java index 418cb55..4ecade6 100644 --- a/src/main/java/org/torproject/descriptor/ServerDescriptor.java +++ b/src/main/java/org/torproject/descriptor/ServerDescriptor.java @@ -4,6 +4,8 @@ package org.torproject.descriptor; import java.util.List; +import java.util.SortedMap; +import java.util.SortedSet; /** * Contains a relay or sanitized bridge server descriptor. @@ -152,6 +154,14 @@ public interface ServerDescriptor extends Descriptor { public String getPlatform(); /** + * Return the version numbers of all protocols supported by this server, or + * null if this descriptor does not specify supported protocol versions. + * + * @since 1.6.0 + */ + public SortedMap<String, SortedSet<Long>> getProtocols(); + + /** * Return the time in milliseconds since the epoch when this descriptor * and the corresponding extra-info descriptor were generated. * diff --git a/src/main/java/org/torproject/descriptor/impl/NetworkStatusEntryImpl.java b/src/main/java/org/torproject/descriptor/impl/NetworkStatusEntryImpl.java index d26eaeb..f67e6bd 100644 --- a/src/main/java/org/torproject/descriptor/impl/NetworkStatusEntryImpl.java +++ b/src/main/java/org/torproject/descriptor/impl/NetworkStatusEntryImpl.java @@ -57,6 +57,7 @@ public class NetworkStatusEntryImpl implements NetworkStatusEntry { this.atMostOnceKeywords = new TreeSet<>(); this.atMostOnceKeywords.add("s"); this.atMostOnceKeywords.add("v"); + this.atMostOnceKeywords.add("pr"); this.atMostOnceKeywords.add("w"); this.atMostOnceKeywords.add("p"); } @@ -95,6 +96,9 @@ public class NetworkStatusEntryImpl implements NetworkStatusEntry { case "v": this.parseVLine(line, parts); break; + case "pr": + this.parsePrLine(line, parts); + break; case "w": this.parseWLine(line, parts); break; @@ -191,6 +195,12 @@ public class NetworkStatusEntryImpl implements NetworkStatusEntry { } } + private void parsePrLine(String line, String[] parts) + throws DescriptorParseException { + this.parsedAtMostOnceKeyword("pr"); + this.protocols = ParseHelper.parseProtocolVersions(line, line, parts); + } + private void parseWLine(String line, String[] parts) throws DescriptorParseException { this.parsedAtMostOnceKeyword("w"); @@ -359,6 +369,13 @@ public class NetworkStatusEntryImpl implements NetworkStatusEntry { return this.version; } + private SortedMap<String, SortedSet<Long>> protocols; + + @Override + public SortedMap<String, SortedSet<Long>> getProtocols() { + return this.protocols; + } + private long bandwidth = -1L; @Override diff --git a/src/main/java/org/torproject/descriptor/impl/ParseHelper.java b/src/main/java/org/torproject/descriptor/impl/ParseHelper.java index dfa9065..f73a591 100644 --- a/src/main/java/org/torproject/descriptor/impl/ParseHelper.java +++ b/src/main/java/org/torproject/descriptor/impl/ParseHelper.java @@ -8,13 +8,16 @@ import org.torproject.descriptor.DescriptorParseException; import java.text.DateFormat; import java.text.ParseException; import java.text.SimpleDateFormat; +import java.util.Collections; import java.util.HashMap; import java.util.LinkedHashMap; import java.util.Locale; import java.util.Map; import java.util.SortedMap; +import java.util.SortedSet; import java.util.TimeZone; import java.util.TreeMap; +import java.util.TreeSet; import java.util.regex.Pattern; import javax.xml.bind.DatatypeConverter; @@ -578,5 +581,49 @@ public class ParseHelper { throw new DescriptorParseException("Unable to locate " + "master-key-ed25519 in identity-ed25519."); } + + private static Map<String, SortedMap<String, SortedSet<Long>>> + parsedProtocolVersions = new HashMap<>(); + + protected static SortedMap<String, SortedSet<Long>> parseProtocolVersions( + String line, String lineNoOpt, String[] partsNoOpt) + throws DescriptorParseException { + if (!parsedProtocolVersions.containsKey(lineNoOpt)) { + SortedMap<String, SortedSet<Long>> parsed = new TreeMap<>(); + boolean invalid = false; + try { + for (int i = 1; i < partsNoOpt.length; i++) { + String[] part = partsNoOpt[i].split("="); + SortedSet<Long> versions = new TreeSet<>(); + for (String val : part[1].split(",")) { + if (val.contains("-")) { + String[] fromTo = val.split("-"); + long from = Long.parseLong(fromTo[0]); + long to = Long.parseLong(fromTo[1]); + if (from > to || to >= 0x1_0000_0000L) { + invalid = true; + } else { + for (long j = from; + j <= to; j++) { + versions.add(j); + } + } + } else { + versions.add(Long.parseLong(val)); + } + } + parsed.put(part[0], Collections.unmodifiableSortedSet(versions)); + } + } catch (ArrayIndexOutOfBoundsException | NumberFormatException e) { + throw new DescriptorParseException("Invalid line '" + line + "'.", e); + } + if (invalid) { + throw new DescriptorParseException("Invalid line '" + line + "'."); + } + parsedProtocolVersions.put(lineNoOpt, + Collections.unmodifiableSortedMap(parsed)); + } + return parsedProtocolVersions.get(lineNoOpt); + } } diff --git a/src/main/java/org/torproject/descriptor/impl/RelayNetworkStatusConsensusImpl.java b/src/main/java/org/torproject/descriptor/impl/RelayNetworkStatusConsensusImpl.java index 8733729..fd4cf7e 100644 --- a/src/main/java/org/torproject/descriptor/impl/RelayNetworkStatusConsensusImpl.java +++ b/src/main/java/org/torproject/descriptor/impl/RelayNetworkStatusConsensusImpl.java @@ -52,7 +52,9 @@ public class RelayNetworkStatusConsensusImpl extends NetworkStatusImpl + "valid-until,voting-delay,known-flags").split(","))); this.checkExactlyOnceKeywords(exactlyOnceKeywords); Set<String> atMostOnceKeywords = new HashSet<>(Arrays.asList(( - "client-versions,server-versions,params,directory-footer," + "client-versions,server-versions,recommended-client-protocols," + + "recommended-relay-protocols,required-client-protocols," + + "required-relay-protocols,params,directory-footer," + "bandwidth-weights").split(","))); this.checkAtMostOnceKeywords(atMostOnceKeywords); this.checkFirstKeyword("network-status-version"); @@ -124,6 +126,18 @@ public class RelayNetworkStatusConsensusImpl extends NetworkStatusImpl case "server-versions": this.parseServerVersionsLine(line, parts); break; + case "recommended-client-protocols": + this.parseRecommendedClientProtocolsLine(line, parts); + break; + case "recommended-relay-protocols": + this.parseRecommendedRelayProtocolsLine(line, parts); + break; + case "required-client-protocols": + this.parseRequiredClientProtocolsLine(line, parts); + break; + case "required-relay-protocols": + this.parseRequiredRelayProtocolsLine(line, parts); + break; case "package": this.parsePackageLine(line, parts); break; @@ -281,6 +295,30 @@ public class RelayNetworkStatusConsensusImpl extends NetworkStatusImpl line, parts); } + private void parseRecommendedClientProtocolsLine(String line, String[] parts) + throws DescriptorParseException { + this.recommendedClientProtocols = ParseHelper.parseProtocolVersions(line, + line, parts); + } + + private void parseRecommendedRelayProtocolsLine(String line, String[] parts) + throws DescriptorParseException { + this.recommendedRelayProtocols = ParseHelper.parseProtocolVersions(line, + line, parts); + } + + private void parseRequiredClientProtocolsLine(String line, String[] parts) + throws DescriptorParseException { + this.requiredClientProtocols = ParseHelper.parseProtocolVersions(line, + line, parts); + } + + private void parseRequiredRelayProtocolsLine(String line, String[] parts) + throws DescriptorParseException { + this.requiredRelayProtocols = ParseHelper.parseProtocolVersions(line, line, + parts); + } + private void parsePackageLine(String line, String[] parts) throws DescriptorParseException { if (parts.length < 5) { @@ -397,6 +435,34 @@ public class RelayNetworkStatusConsensusImpl extends NetworkStatusImpl : Arrays.asList(this.recommendedServerVersions); } + private SortedMap<String, SortedSet<Long>> recommendedClientProtocols; + + @Override + public SortedMap<String, SortedSet<Long>> getRecommendedClientProtocols() { + return this.recommendedClientProtocols; + } + + private SortedMap<String, SortedSet<Long>> recommendedRelayProtocols; + + @Override + public SortedMap<String, SortedSet<Long>> getRecommendedRelayProtocols() { + return this.recommendedRelayProtocols; + } + + private SortedMap<String, SortedSet<Long>> requiredClientProtocols; + + @Override + public SortedMap<String, SortedSet<Long>> getRequiredClientProtocols() { + return this.requiredClientProtocols; + } + + private SortedMap<String, SortedSet<Long>> requiredRelayProtocols; + + @Override + public SortedMap<String, SortedSet<Long>> getRequiredRelayProtocols() { + return this.requiredRelayProtocols; + } + private List<String> packageLines; @Override diff --git a/src/main/java/org/torproject/descriptor/impl/RelayNetworkStatusVoteImpl.java b/src/main/java/org/torproject/descriptor/impl/RelayNetworkStatusVoteImpl.java index 02390de..619b2c1 100644 --- a/src/main/java/org/torproject/descriptor/impl/RelayNetworkStatusVoteImpl.java +++ b/src/main/java/org/torproject/descriptor/impl/RelayNetworkStatusVoteImpl.java @@ -52,6 +52,8 @@ public class RelayNetworkStatusVoteImpl extends NetworkStatusImpl this.checkExactlyOnceKeywords(exactlyOnceKeywords); Set<String> atMostOnceKeywords = new HashSet<>(Arrays.asList(( "consensus-methods,client-versions,server-versions," + + "recommended-client-protocols,recommended-relay-protocols," + + "required-client-protocols,required-relay-protocols," + "flag-thresholds,params,contact," + "legacy-key,dir-key-crosscert,dir-address,directory-footer") .split(","))); @@ -117,6 +119,18 @@ public class RelayNetworkStatusVoteImpl extends NetworkStatusImpl case "server-versions": this.parseServerVersionsLine(line, parts); break; + case "recommended-client-protocols": + this.parseRecommendedClientProtocolsLine(line, parts); + break; + case "recommended-relay-protocols": + this.parseRecommendedRelayProtocolsLine(line, parts); + break; + case "required-client-protocols": + this.parseRequiredClientProtocolsLine(line, parts); + break; + case "required-relay-protocols": + this.parseRequiredRelayProtocolsLine(line, parts); + break; case "package": this.parsePackageLine(line, parts); break; @@ -305,6 +319,30 @@ public class RelayNetworkStatusVoteImpl extends NetworkStatusImpl line, parts); } + private void parseRecommendedClientProtocolsLine(String line, String[] parts) + throws DescriptorParseException { + this.recommendedClientProtocols = ParseHelper.parseProtocolVersions(line, + line, parts); + } + + private void parseRecommendedRelayProtocolsLine(String line, String[] parts) + throws DescriptorParseException { + this.recommendedRelayProtocols = ParseHelper.parseProtocolVersions(line, + line, parts); + } + + private void parseRequiredClientProtocolsLine(String line, String[] parts) + throws DescriptorParseException { + this.requiredClientProtocols = ParseHelper.parseProtocolVersions(line, + line, parts); + } + + private void parseRequiredRelayProtocolsLine(String line, String[] parts) + throws DescriptorParseException { + this.requiredRelayProtocols = ParseHelper.parseProtocolVersions(line, line, + parts); + } + private void parsePackageLine(String line, String[] parts) throws DescriptorParseException { if (parts.length < 5) { @@ -710,6 +748,34 @@ public class RelayNetworkStatusVoteImpl extends NetworkStatusImpl : Arrays.asList(this.recommendedServerVersions); } + private SortedMap<String, SortedSet<Long>> recommendedClientProtocols; + + @Override + public SortedMap<String, SortedSet<Long>> getRecommendedClientProtocols() { + return this.recommendedClientProtocols; + } + + private SortedMap<String, SortedSet<Long>> recommendedRelayProtocols; + + @Override + public SortedMap<String, SortedSet<Long>> getRecommendedRelayProtocols() { + return this.recommendedRelayProtocols; + } + + private SortedMap<String, SortedSet<Long>> requiredClientProtocols; + + @Override + public SortedMap<String, SortedSet<Long>> getRequiredClientProtocols() { + return this.requiredClientProtocols; + } + + private SortedMap<String, SortedSet<Long>> requiredRelayProtocols; + + @Override + public SortedMap<String, SortedSet<Long>> getRequiredRelayProtocols() { + return this.requiredRelayProtocols; + } + private List<String> packageLines; @Override diff --git a/src/main/java/org/torproject/descriptor/impl/ServerDescriptorImpl.java b/src/main/java/org/torproject/descriptor/impl/ServerDescriptorImpl.java index 183959a..309cad4 100644 --- a/src/main/java/org/torproject/descriptor/impl/ServerDescriptorImpl.java +++ b/src/main/java/org/torproject/descriptor/impl/ServerDescriptorImpl.java @@ -16,6 +16,8 @@ import java.util.HashSet; import java.util.List; import java.util.Scanner; import java.util.Set; +import java.util.SortedMap; +import java.util.SortedSet; import javax.xml.bind.DatatypeConverter; @@ -34,7 +36,7 @@ public abstract class ServerDescriptorImpl extends DescriptorImpl "router,bandwidth,published".split(","))); this.checkExactlyOnceKeywords(exactlyOnceKeywords); Set<String> atMostOnceKeywords = new HashSet<>(Arrays.asList(( - "identity-ed25519,master-key-ed25519,platform,fingerprint," + "identity-ed25519,master-key-ed25519,platform,proto,fingerprint," + "hibernating,uptime,contact,family,read-history,write-history," + "eventdns,caches-extra-info,extra-info-digest," + "hidden-service-dir,protocols,allow-single-hop-exits,onion-key," @@ -80,6 +82,9 @@ public abstract class ServerDescriptorImpl extends DescriptorImpl case "platform": this.parsePlatformLine(line, lineNoOpt, partsNoOpt); break; + case "proto": + this.parseProtoLine(line, lineNoOpt, partsNoOpt); + break; case "published": this.parsePublishedLine(line, lineNoOpt, partsNoOpt); break; @@ -303,6 +308,12 @@ public abstract class ServerDescriptorImpl extends DescriptorImpl } } + private void parseProtoLine(String line, String lineNoOpt, + String[] partsNoOpt) throws DescriptorParseException { + this.protocols = ParseHelper.parseProtocolVersions(line, lineNoOpt, + partsNoOpt); + } + private void parsePublishedLine(String line, String lineNoOpt, String[] partsNoOpt) throws DescriptorParseException { this.publishedMillis = ParseHelper.parseTimestampAtIndex(line, @@ -812,6 +823,13 @@ public abstract class ServerDescriptorImpl extends DescriptorImpl return this.platform; } + private SortedMap<String, SortedSet<Long>> protocols; + + @Override + public SortedMap<String, SortedSet<Long>> getProtocols() { + return this.protocols; + } + private long publishedMillis; @Override diff --git a/src/test/java/org/torproject/descriptor/impl/ConsensusBuilder.java b/src/test/java/org/torproject/descriptor/impl/ConsensusBuilder.java index b765be6..24d5a02 100644 --- a/src/test/java/org/torproject/descriptor/impl/ConsensusBuilder.java +++ b/src/test/java/org/torproject/descriptor/impl/ConsensusBuilder.java @@ -126,6 +126,54 @@ public class ConsensusBuilder { return new RelayNetworkStatusConsensusImpl(cb.buildConsensus(), true); } + private String recommendedClientProtocolsLine = + "recommended-client-protocols Cons=1-2 Desc=1-2 DirCache=1 HSDir=1 " + + "HSIntro=3 HSRend=1 Link=4 LinkAuth=1 Microdesc=1-2 Relay=2"; + + protected static RelayNetworkStatusConsensus + createWithRecommendedClientProtocolsLine(String line) + throws DescriptorParseException { + ConsensusBuilder cb = new ConsensusBuilder(); + cb.recommendedClientProtocolsLine = line; + return new RelayNetworkStatusConsensusImpl(cb.buildConsensus(), true); + } + + private String recommendedRelayProtocolsLine = + "recommended-relay-protocols Cons=1-2 Desc=1-2 DirCache=1 HSDir=1 " + + "HSIntro=3 HSRend=1 Link=4 LinkAuth=1 Microdesc=1-2 Relay=2"; + + protected static RelayNetworkStatusConsensus + createWithRecommendedRelayProtocolsLine(String line) + throws DescriptorParseException { + ConsensusBuilder cb = new ConsensusBuilder(); + cb.recommendedRelayProtocolsLine = line; + return new RelayNetworkStatusConsensusImpl(cb.buildConsensus(), true); + } + + private String requiredClientProtocolsLine = + "required-client-protocols Cons=1-2 Desc=1-2 DirCache=1 HSDir=1 " + + "HSIntro=3 HSRend=1 Link=4 LinkAuth=1 Microdesc=1-2 Relay=2"; + + protected static RelayNetworkStatusConsensus + createWithRequiredClientProtocolsLine(String line) + throws DescriptorParseException { + ConsensusBuilder cb = new ConsensusBuilder(); + cb.requiredClientProtocolsLine = line; + return new RelayNetworkStatusConsensusImpl(cb.buildConsensus(), true); + } + + private String requiredRelayProtocolsLine = + "required-relay-protocols Cons=1 Desc=1 DirCache=1 HSDir=1 HSIntro=3 " + + "HSRend=1 Link=3-4 LinkAuth=1 Microdesc=1 Relay=1-2"; + + protected static RelayNetworkStatusConsensus + createWithRequiredRelayProtocolsLine(String line) + throws DescriptorParseException { + ConsensusBuilder cb = new ConsensusBuilder(); + cb.requiredRelayProtocolsLine = line; + return new RelayNetworkStatusConsensusImpl(cb.buildConsensus(), true); + } + private String paramsLine = "params " + "CircuitPriorityHalflifeMsec=30000 bwauthbestratio=1 " + "bwauthcircs=1 bwauthdescbw=0 bwauthkp=10000 bwauthpid=1 " @@ -322,6 +370,18 @@ public class ConsensusBuilder { if (this.knownFlagsLine != null) { sb.append(this.knownFlagsLine).append("\n"); } + if (this.recommendedClientProtocolsLine != null) { + sb.append(this.recommendedClientProtocolsLine).append("\n"); + } + if (this.recommendedRelayProtocolsLine != null) { + sb.append(this.recommendedRelayProtocolsLine).append("\n"); + } + if (this.requiredClientProtocolsLine != null) { + sb.append(this.requiredClientProtocolsLine).append("\n"); + } + if (this.requiredRelayProtocolsLine != null) { + sb.append(this.requiredRelayProtocolsLine).append("\n"); + } if (this.paramsLine != null) { sb.append(this.paramsLine).append("\n"); } diff --git a/src/test/java/org/torproject/descriptor/impl/RelayNetworkStatusConsensusImplTest.java b/src/test/java/org/torproject/descriptor/impl/RelayNetworkStatusConsensusImplTest.java index ebcbd83..786ae54 100644 --- a/src/test/java/org/torproject/descriptor/impl/RelayNetworkStatusConsensusImplTest.java +++ b/src/test/java/org/torproject/descriptor/impl/RelayNetworkStatusConsensusImplTest.java @@ -19,6 +19,7 @@ import org.junit.Test; import java.util.ArrayList; import java.util.Arrays; import java.util.List; +import java.util.TreeSet; /* TODO Add test cases for all lines starting with "opt ". */ @@ -242,6 +243,16 @@ public class RelayNetworkStatusConsensusImplTest { return createWithStatusEntry(seb.buildStatusEntry()); } + private String prLine = "pr Cons=1-2 Desc=1-2 DirCache=1 HSDir=1 " + + "HSIntro=3 HSRend=1-2 Link=1-4 LinkAuth=1 Microdesc=1-2 Relay=1-2"; + + private static RelayNetworkStatusConsensus + createWithPrLine(String line) throws DescriptorParseException { + StatusEntryBuilder seb = new StatusEntryBuilder(); + seb.prLine = line; + return createWithStatusEntry(seb.buildStatusEntry()); + } + @SuppressWarnings("checkstyle:membername") private String wLine = "w Bandwidth=1"; @@ -275,6 +286,9 @@ public class RelayNetworkStatusConsensusImplTest { if (this.vLine != null) { sb.append(this.vLine).append("\n"); } + if (this.prLine != null) { + sb.append(this.prLine).append("\n"); + } if (this.wLine != null) { sb.append(this.wLine).append("\n"); } @@ -353,6 +367,14 @@ public class RelayNetworkStatusConsensusImplTest { assertTrue(consensus.getRecommendedServerVersions().contains( "0.2.3.8-alpha")); assertTrue(consensus.getKnownFlags().contains("Running")); + assertTrue(consensus.getRecommendedClientProtocols().get("Cons") + .contains(1L)); + assertFalse(consensus.getRecommendedRelayProtocols().get("Cons") + .contains(33L)); + assertFalse(consensus.getRequiredClientProtocols().get("Relay") + .contains(1L)); + assertTrue(consensus.getRequiredRelayProtocols().get("Relay") + .contains(1L)); assertEquals(30000, (int) consensus.getConsensusParams().get( "CircuitPriorityHalflifeMsec")); assertEquals("86.59.21.38", consensus.getDirSourceEntries().get( @@ -667,6 +689,54 @@ public class RelayNetworkStatusConsensusImplTest { } @Test() + public void testRecommendedClientProtocols123() + throws DescriptorParseException { + RelayNetworkStatusConsensus consensus = ConsensusBuilder + .createWithRecommendedClientProtocolsLine( + "recommended-client-protocols Cons=1,2,3"); + assertEquals(new TreeSet<Long>(Arrays.asList(new Long[] { 1L, 2L, 3L })), + consensus.getRecommendedClientProtocols().get("Cons")); + } + + @Test() + public void testRecommendedRelayProtocols134() + throws DescriptorParseException { + RelayNetworkStatusConsensus consensus = ConsensusBuilder + .createWithRecommendedRelayProtocolsLine( + "recommended-relay-protocols Cons=1,3-4"); + assertEquals(new TreeSet<Long>(Arrays.asList(new Long[] { 1L, 3L, 4L })), + consensus.getRecommendedRelayProtocols().get("Cons")); + } + + @Test() + public void testRequiredClientProtocols1425() + throws DescriptorParseException { + RelayNetworkStatusConsensus consensus = ConsensusBuilder + .createWithRequiredClientProtocolsLine( + "required-client-protocols Cons=1-3,2-4"); + assertEquals(new TreeSet<Long>(Arrays.asList( + new Long[] { 1L, 2L, 3L, 4L })), + consensus.getRequiredClientProtocols().get("Cons")); + } + + @Test() + public void testRequiredRelayProtocols1111() + throws DescriptorParseException { + RelayNetworkStatusConsensus consensus = ConsensusBuilder + .createWithRequiredRelayProtocolsLine( + "required-relay-protocols Cons=1-1,1-1"); + assertEquals(new TreeSet<Long>(Arrays.asList(new Long[] { 1L })), + consensus.getRequiredRelayProtocols().get("Cons")); + } + + @Test(expected = DescriptorParseException.class) + public void testRequiredRelayProtocolsTwice() + throws DescriptorParseException { + ConsensusBuilder.createWithRequiredRelayProtocolsLine( + "required-relay-protocols Cons=1\nrequired-relay-protocols Cons=1"); + } + + @Test() public void testPackageNone() throws DescriptorParseException { RelayNetworkStatusConsensus consensus = ConsensusBuilder.createWithPackageLines(null); @@ -1022,6 +1092,15 @@ public class RelayNetworkStatusConsensusImplTest { } @Test(expected = DescriptorParseException.class) + public void testTwoPrLines() throws DescriptorParseException { + StatusEntryBuilder sb = new StatusEntryBuilder(); + sb.prLine = sb.prLine + "\n" + sb.prLine; + ConsensusBuilder cb = new ConsensusBuilder(); + cb.statusEntries.add(sb.buildStatusEntry()); + new RelayNetworkStatusConsensusImpl(cb.buildConsensus(), true); + } + + @Test(expected = DescriptorParseException.class) public void testWLineNoSpace() throws DescriptorParseException { StatusEntryBuilder.createWithWLine("w"); } diff --git a/src/test/java/org/torproject/descriptor/impl/RelayNetworkStatusVoteImplTest.java b/src/test/java/org/torproject/descriptor/impl/RelayNetworkStatusVoteImplTest.java index 847c538..ea7b927 100644 --- a/src/test/java/org/torproject/descriptor/impl/RelayNetworkStatusVoteImplTest.java +++ b/src/test/java/org/torproject/descriptor/impl/RelayNetworkStatusVoteImplTest.java @@ -16,6 +16,7 @@ import org.junit.Test; import java.util.ArrayList; import java.util.Arrays; import java.util.List; +import java.util.TreeSet; /* TODO Add test cases for all lines starting with "opt ". */ @@ -153,6 +154,54 @@ public class RelayNetworkStatusVoteImplTest { return new RelayNetworkStatusVoteImpl(vb.buildVote(), true); } + private String recommendedClientProtocolsLine = + "recommended-client-protocols Cons=1-2 Desc=1-2 DirCache=1 HSDir=1 " + + "HSIntro=3 HSRend=1 Link=4 LinkAuth=1 Microdesc=1-2 Relay=2"; + + private static RelayNetworkStatusVote + createWithRecommendedClientProtocolsLine(String line) + throws DescriptorParseException { + VoteBuilder vb = new VoteBuilder(); + vb.recommendedClientProtocolsLine = line; + return new RelayNetworkStatusVoteImpl(vb.buildVote(), true); + } + + private String recommendedRelayProtocolsLine = + "recommended-relay-protocols Cons=1-2 Desc=1-2 DirCache=1 HSDir=1 " + + "HSIntro=3 HSRend=1 Link=4 LinkAuth=1 Microdesc=1-2 Relay=2"; + + private static RelayNetworkStatusVote + createWithRecommendedRelayProtocolsLine(String line) + throws DescriptorParseException { + VoteBuilder vb = new VoteBuilder(); + vb.recommendedRelayProtocolsLine = line; + return new RelayNetworkStatusVoteImpl(vb.buildVote(), true); + } + + private String requiredClientProtocolsLine = + "required-client-protocols Cons=1-2 Desc=1-2 DirCache=1 HSDir=1 " + + "HSIntro=3 HSRend=1 Link=4 LinkAuth=1 Microdesc=1-2 Relay=2"; + + private static RelayNetworkStatusVote + createWithRequiredClientProtocolsLine(String line) + throws DescriptorParseException { + VoteBuilder vb = new VoteBuilder(); + vb.requiredClientProtocolsLine = line; + return new RelayNetworkStatusVoteImpl(vb.buildVote(), true); + } + + private String requiredRelayProtocolsLine = + "required-relay-protocols Cons=1 Desc=1 DirCache=1 HSDir=1 HSIntro=3 " + + "HSRend=1 Link=3-4 LinkAuth=1 Microdesc=1 Relay=1-2"; + + private static RelayNetworkStatusVote + createWithRequiredRelayProtocolsLine(String line) + throws DescriptorParseException { + VoteBuilder vb = new VoteBuilder(); + vb.requiredRelayProtocolsLine = line; + return new RelayNetworkStatusVoteImpl(vb.buildVote(), true); + } + private String flagThresholdsLine = "flag-thresholds " + "stable-uptime=693369 stable-mtbf=153249 fast-speed=40960 " + "guard-wfu=94.669% guard-tk=691200 guard-bw-inc-exits=174080 " @@ -493,6 +542,18 @@ public class RelayNetworkStatusVoteImplTest { if (this.knownFlagsLine != null) { sb.append(this.knownFlagsLine).append("\n"); } + if (this.recommendedClientProtocolsLine != null) { + sb.append(this.recommendedClientProtocolsLine).append("\n"); + } + if (this.recommendedRelayProtocolsLine != null) { + sb.append(this.recommendedRelayProtocolsLine).append("\n"); + } + if (this.requiredClientProtocolsLine != null) { + sb.append(this.requiredClientProtocolsLine).append("\n"); + } + if (this.requiredRelayProtocolsLine != null) { + sb.append(this.requiredRelayProtocolsLine).append("\n"); + } if (this.flagThresholdsLine != null) { sb.append(this.flagThresholdsLine).append("\n"); } @@ -875,6 +936,37 @@ public class RelayNetworkStatusVoteImplTest { "client-versions ,0.2.2.34"); } + @Test(expected = DescriptorParseException.class) + public void testRecommendedClientProtocols21() + throws DescriptorParseException { + VoteBuilder.createWithRecommendedClientProtocolsLine( + "recommended-client-protocols Cons=2-1"); + } + + @Test() + public void testRecommendedRelayProtocols0() + throws DescriptorParseException { + RelayNetworkStatusVote vote = + VoteBuilder.createWithRecommendedRelayProtocolsLine( + "recommended-relay-protocols Cons=0"); + assertEquals(new TreeSet<Long>(Arrays.asList(new Long[] { 0L })), + vote.getRecommendedRelayProtocols().get("Cons")); + } + + @Test(expected = DescriptorParseException.class) + public void testRequiredClientProtocols1Max() + throws DescriptorParseException { + VoteBuilder.createWithRequiredClientProtocolsLine( + "recommended-client-protocols Cons=1-4294967296"); + } + + @Test(expected = DescriptorParseException.class) + public void testRequiredRelayProtocolsMinus1() + throws DescriptorParseException { + VoteBuilder.createWithRequiredRelayProtocolsLine( + "recommended-client-protocols Cons=-1"); + } + @Test() public void testPackageNone() throws DescriptorParseException { RelayNetworkStatusVote vote = diff --git a/src/test/java/org/torproject/descriptor/impl/ServerDescriptorImplTest.java b/src/test/java/org/torproject/descriptor/impl/ServerDescriptorImplTest.java index 3769ead..4370321 100644 --- a/src/test/java/org/torproject/descriptor/impl/ServerDescriptorImplTest.java +++ b/src/test/java/org/torproject/descriptor/impl/ServerDescriptorImplTest.java @@ -21,6 +21,7 @@ import java.util.ArrayList; import java.util.Arrays; import java.util.List; import java.util.SortedMap; +import java.util.TreeSet; /* Test parsing of relay server descriptors. */ public class ServerDescriptorImplTest { @@ -226,7 +227,7 @@ public class ServerDescriptorImplTest { return new RelayServerDescriptorImpl(db.buildDescriptor(), true); } - private String protocolsLine = "opt protocols Link 1 2 Circuit 1"; + private String protocolsLine = null; private static ServerDescriptor createWithProtocolsLine( String line) throws DescriptorParseException { @@ -235,6 +236,16 @@ public class ServerDescriptorImplTest { return new RelayServerDescriptorImpl(db.buildDescriptor(), true); } + private String protoLine = "proto Cons=1-2 Desc=1-2 DirCache=1 HSDir=1 " + + "HSIntro=3 HSRend=1-2 Link=1-4 LinkAuth=1 Microdesc=1-2 Relay=1-2"; + + private static ServerDescriptor createWithProtoLine( + String line) throws DescriptorParseException { + DescriptorBuilder db = new DescriptorBuilder(); + db.protoLine = line; + return new RelayServerDescriptorImpl(db.buildDescriptor(), true); + } + private String allowSingleHopExitsLine = null; private static ServerDescriptor @@ -395,6 +406,9 @@ public class ServerDescriptorImplTest { if (this.protocolsLine != null) { sb.append(this.protocolsLine).append("\n"); } + if (this.protoLine != null) { + sb.append(this.protoLine).append("\n"); + } if (this.allowSingleHopExitsLine != null) { sb.append(this.allowSingleHopExitsLine).append("\n"); } @@ -446,10 +460,10 @@ public class ServerDescriptorImplTest { assertEquals(0, (int) descriptor.getDirPort()); assertEquals("Tor 0.2.2.35 (git-b04388f9e7546a9f) on Linux i686", descriptor.getPlatform()); - assertEquals(Arrays.asList(new Integer[] {1, 2}), - descriptor.getLinkProtocolVersions()); - assertEquals(Arrays.asList(new Integer[] {1}), - descriptor.getCircuitProtocolVersions()); + assertEquals(new TreeSet<Long>(Arrays.asList( + new Long[] { 1L, 2L, 3L, 4L })), descriptor.getProtocols().get("Link")); + assertEquals(new TreeSet<Long>(Arrays.asList( + new Long[] { 1L })), descriptor.getProtocols().get("LinkAuth")); assertEquals(1325390599000L, descriptor.getPublishedMillis()); assertEquals("D8733048FC8EC9102466AD8F3098622BF1BF71FD", descriptor.getFingerprint()); @@ -605,6 +619,16 @@ public class ServerDescriptorImplTest { } @Test() + public void testProtocolsOpt() throws DescriptorParseException { + ServerDescriptor descriptor = DescriptorBuilder + .createWithProtocolsLine("opt protocols Link 1 2 Circuit 1"); + assertEquals(Arrays.asList(new Integer[] {1, 2}), + descriptor.getLinkProtocolVersions()); + assertEquals(Arrays.asList(new Integer[] {1}), + descriptor.getCircuitProtocolVersions()); + } + + @Test() public void testProtocolsNoOpt() throws DescriptorParseException { ServerDescriptor descriptor = DescriptorBuilder .createWithProtocolsLine("protocols Link 1 2 Circuit 1"); @@ -626,6 +650,21 @@ public class ServerDescriptorImplTest { DescriptorBuilder.createWithProtocolsLine("opt protocols Link 1 2"); } + @Test() + public void testProtoGreenPurple() throws DescriptorParseException { + ServerDescriptor descriptor = DescriptorBuilder + .createWithProtoLine("proto Green=23 Purple=42"); + assertEquals(new TreeSet<Long>(Arrays.asList(new Long[] { 23L })), + descriptor.getProtocols().get("Green")); + assertEquals(new TreeSet<Long>(Arrays.asList(new Long[] { 42L })), + descriptor.getProtocols().get("Purple")); + } + + @Test(expected = DescriptorParseException.class) + public void testProtoInvalid() throws DescriptorParseException { + DescriptorBuilder.createWithProtoLine("proto Invalid=1+2+3"); + } + @Test(expected = DescriptorParseException.class) public void testPublishedMissing() throws DescriptorParseException { DescriptorBuilder.createWithPublishedLine(null);

1 0

[rbm/master] Set timestamp on files in zip wrapper
by boklm＠torproject.org 14 Feb '17

14 Feb '17

commit 3fdeb23bc4ab4dc65e69ff0fac49db603c4efb08 Author: Nicolas Vigier <boklm(a)torproject.org> Date: Tue Feb 14 11:35:10 2017 +0100 Set timestamp on files in zip wrapper --- lib/RBM/DefaultConfig.pm | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lib/RBM/DefaultConfig.pm b/lib/RBM/DefaultConfig.pm index 052cf16..aad9451 100644 --- a/lib/RBM/DefaultConfig.pm +++ b/lib/RBM/DefaultConfig.pm @@ -569,6 +569,8 @@ TAR_END #### zip => <<ZIP_END, [%- SET src = c('zip_src', { error_if_undef => 1 }) -%] +[% USE date -%] +find [% src.join(' ') %] -exec touch -m -t [% date.format(c('timestamp'), format = '%Y%m%d%H%M') %] -- {} + find [% src.join(' ') %] [% IF c('gnu_utils') %]-executable[% ELSE %]-perm +0111[% END %] -exec chmod 700 {} \\; find [% src.join(' ') %] ! [% IF c('gnu_utils') %]-executable[% ELSE %]-perm +0111[% END %] -exec chmod 600 {} \\; find [% src.join(' ') %] | sort | \

1 0

[tor-browser-build/master] projects/tor: use faketime on OSX
by boklm＠torproject.org 14 Feb '17

14 Feb '17

commit de8a0de76cf4a07bf2e9138e9c39bd4af8a93446 Author: Nicolas Vigier <boklm(a)torproject.org> Date: Tue Feb 14 13:04:22 2017 +0100 projects/tor: use faketime on OSX --- projects/tor/build | 7 +++++++ projects/tor/config | 4 ++++ 2 files changed, 11 insertions(+) diff --git a/projects/tor/build b/projects/tor/build index bd86928..a568512 100644 --- a/projects/tor/build +++ b/projects/tor/build @@ -58,8 +58,15 @@ cd /var/tmp/build/[% project %]-[% c('version') %] ./configure --disable-asciidoc --with-libevent-dir="$libeventdir" --with-openssl-dir="$openssldir" \ [% IF c("var/windows") %]--with-zlib-dir="$zlibdir"[% END %] \ --prefix="$distdir" [% c("var/configure_opt") %] +[% IF c("var/osx") -%] + export LD_PRELOAD=/usr/lib/faketime/libfaketime.so.1 + export FAKETIME="[% USE date; GET date.format(c('timestamp'), format = '%Y-%m-%d %H:%M:%S') %]" +[% END -%] make -j4 make install +[% IF c("var/osx") -%] + unset LD_PRELOAD +[% END -%] cp $distdir/share/tor/geoip $TORCONFIGDIR cp $distdir/share/tor/geoip6 $TORCONFIGDIR diff --git a/projects/tor/config b/projects/tor/config index b73a447..2fbbf24 100644 --- a/projects/tor/config +++ b/projects/tor/config @@ -36,6 +36,10 @@ targets: - libtool - zlib1g-dev - hardening-wrapper + osx-x86_64: + var: + arch_deps: + - faketime expert-bundle: var: expert_bundle: 1

1 0

[metrics-web/master] Add Tor's physical address to the contact section.
by karsten＠torproject.org 14 Feb '17

14 Feb '17

commit 79450bbc91d8f1b30ed82954e6329b1debba4c9b Author: Karsten Loesing <karsten.loesing(a)gmx.net> Date: Tue Feb 14 10:21:32 2017 +0100 Add Tor's physical address to the contact section. --- website/web/WEB-INF/about.jsp | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/website/web/WEB-INF/about.jsp b/website/web/WEB-INF/about.jsp index b71135c..7a4d303 100644 --- a/website/web/WEB-INF/about.jsp +++ b/website/web/WEB-INF/about.jsp @@ -30,6 +30,11 @@ <div class="container"> <h2>Contact <a href="#contact" name="contact" class="anchor">#</a></h2> <p>If you have any questions or suggestions, contact us at <a href="mailto:metrics-team@lists.torproject.org">metrics-team(a)lists.torproject.org</a>, which is a <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/metrics-team" target="_blank">public mailing list</a>.</p> + + <p>Tor Metrics is a project of:</p> +<pre>The Tor Project, Inc. +217 1st Ave South #4903 +Seattle, WA 98194 USA</pre> </div> <div class="container">

1 0

[collector/master] Clean up files in recent/exit-lists/ again.
by karsten＠torproject.org 14 Feb '17

14 Feb '17

commit b81852f7c8ee8a8dd58dfaa20e1c5d6008516c51 Author: Karsten Loesing <karsten.loesing(a)gmx.net> Date: Tue Feb 14 09:08:46 2017 +0100 Clean up files in recent/exit-lists/ again. Fixes #21443. --- CHANGELOG.md | 6 ++++++ .../java/org/torproject/collector/exitlists/ExitListDownloader.java | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 107423c..2365447 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +# Changes in version 1.?.? - 2017-??-?? + + * Medium changes + - Clean up files in recent/exit-lists/ again. + + # Changes in version 1.1.2 - 2017-01-17 * Medium changes diff --git a/src/main/java/org/torproject/collector/exitlists/ExitListDownloader.java b/src/main/java/org/torproject/collector/exitlists/ExitListDownloader.java index 877057e..0ac5112 100644 --- a/src/main/java/org/torproject/collector/exitlists/ExitListDownloader.java +++ b/src/main/java/org/torproject/collector/exitlists/ExitListDownloader.java @@ -199,7 +199,7 @@ public class ExitListDownloader extends CollecTorMain { long cutOffMillis = System.currentTimeMillis() - 3L * 24L * 60L * 60L * 1000L; Stack<File> allFiles = new Stack<File>(); - allFiles.add(new File(recentPathName, EXITLISTS)); + allFiles.add(new File(recentPathName)); while (!allFiles.isEmpty()) { File file = allFiles.pop(); if (file.isDirectory()) {

1 0

[tor-browser-build/master] Add support for optional local configuration file rbm.local.conf
by boklm＠torproject.org 14 Feb '17

14 Feb '17

commit 99f69d0aa0665e57a5036f66e16dbdcd0fea94d0 Author: Nicolas Vigier <boklm(a)torproject.org> Date: Tue Feb 14 00:40:49 2017 +0100 Add support for optional local configuration file rbm.local.conf Update rbm and add example rbm.local.conf file. --- .gitignore | 1 + README | 2 ++ README.BUILD_ERRORS | 2 ++ rbm | 2 +- rbm.local.conf.example | 22 ++++++++++++++++++++++ 5 files changed, 28 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index c755fcf..98554a3 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ alpha alpha_nightly nightly hardened +rbm.local.conf diff --git a/README b/README index 775f782..001a692 100644 --- a/README +++ b/README @@ -89,6 +89,8 @@ the RBM_NO_DEBUG environment variable to 1: export RBM_NO_DEBUG=1 +Or set the debug option to 0 in the rbm.local.conf file. + If you want to select the output directory, you can use rbm's --output-dir option. You can look at the Makefile to find the rbm command for what you want to build, and add the --output-dir option. For example if you diff --git a/README.BUILD_ERRORS b/README.BUILD_ERRORS index c1ee70c..6be4319 100644 --- a/README.BUILD_ERRORS +++ b/README.BUILD_ERRORS @@ -42,3 +42,5 @@ $ mkdir /home/user/tmp $ export TMPDIR=/home/user/tmp ---- +You can also define the tmp_dir option in the rbm.local.conf file. + diff --git a/rbm b/rbm index af970a5..a57b484 160000 --- a/rbm +++ b/rbm @@ -1 +1 @@ -Subproject commit af970a558f122acaba080e0b015e3293f74509fb +Subproject commit a57b4846c8aba5697ce1f197996e2962ffb5b534 diff --git a/rbm.local.conf.example b/rbm.local.conf.example new file mode 100644 index 0000000..fab3213 --- /dev/null +++ b/rbm.local.conf.example @@ -0,0 +1,22 @@ +--- +### This file is used to override options from rbm.conf to adapt them +### to your local setup. +### +### Copy this file as rbm.local.conf to enable it, and uncomment the +### options you want to modify. + + +### The tmp_dir option defines where temporary files are stored. +### You should modify this if your /tmp partition is small. +#tmp_dir: /tmp + +### The debug option defines whether a debugging shell should be opened +### automatically in the build directory/container in case of build +### failure. If you are doing automated builds, you might want to disable +### this. +#debug: 0 + +var: + local_conf: 1 + +# vim: filetype=yaml sw=2

1 0

[tor-browser-build/master] Add build signing options to rbm.local.conf
by boklm＠torproject.org 14 Feb '17

14 Feb '17

commit 8c36b34c471ddcc7ebb0ff54e41bb5c30fe15594 Author: Nicolas Vigier <boklm(a)torproject.org> Date: Tue Feb 14 01:02:52 2017 +0100 Add build signing options to rbm.local.conf --- README | 4 +++- projects/release/config | 4 ++-- rbm.conf | 3 +++ rbm.local.conf.example | 9 +++++++++ 4 files changed, 17 insertions(+), 3 deletions(-) diff --git a/README b/README index 001a692..956e162 100644 --- a/README +++ b/README @@ -157,7 +157,9 @@ Signing builds If the environment variable RBM_SIGN_BUILD is set to 1, the sha256sums-unsigned-build.txt file will be signed with gpg. You can use the RBM_GPG_OPTS environment variable to add some options -to the gpg command used to sign the file. +to the gpg command used to sign the file. You can also set the +var/sign_build and var/sign_build_gpg_opts options in the rbm.local.conf +file. Cleaning obsolete files and containers images diff --git a/projects/release/config b/projects/release/config index daa78dd..0b3727f 100644 --- a/projects/release/config +++ b/projects/release/config @@ -125,7 +125,7 @@ build: | [% END -%] cd "$destdir" sha256sum $(ls -1 *.exe *.tar.xz *.dmg *.mar *.zip | grep -v '\.incremental\.mar$' | sort) > sha256sums-unsigned-build.txt - [% IF ENV.RBM_SIGN_BUILD -%] - gpg -abs [% ENV.RBM_GPG_OPTS %] sha256sums-unsigned-build.txt + [% IF c("var/sign_build") -%] + gpg -abs [% c("var/sign_build_gpg_opts") %] sha256sums-unsigned-build.txt [% END -%] cat sha256sums-unsigned-build.txt diff --git a/rbm.conf b/rbm.conf index 05e45a6..5dfdc30 100644 --- a/rbm.conf +++ b/rbm.conf @@ -49,6 +49,9 @@ var: - vi - zh-CN + sign_build: '[% ENV.RBM_SIGN_BUILD %]' + sign_build_gpg_opts: '[% ENV.RBM_GPG_OPTS %]' + targets: notarget: linux-x86_64 diff --git a/rbm.local.conf.example b/rbm.local.conf.example index fab3213..42bf431 100644 --- a/rbm.local.conf.example +++ b/rbm.local.conf.example @@ -19,4 +19,13 @@ var: local_conf: 1 + ### The var/sign_build option defines if you want to sign the + ### sha256sums-unsigned-build.txt file with gpg. + #sign_build: 1 + + ### The var/sign_build_gpg_opts option can be used to define some gpg + ### options to select the key to use to sign the sha256sums-unsigned-build.txt + ### file. + #sign_build_gpg_opts: '--local-user XXXXXXXX' + # vim: filetype=yaml sw=2

1 0

[tor-browser-build/master] Add docker_image_prefix option to rbm.local.conf
by boklm＠torproject.org 14 Feb '17

14 Feb '17

commit e30719ad9b5ad2c63156d88e63a5d4a082021455 Author: Nicolas Vigier <boklm(a)torproject.org> Date: Tue Feb 14 01:31:22 2017 +0100 Add docker_image_prefix option to rbm.local.conf --- README | 12 ++++++++++++ projects/docker-image/config | 1 - rbm.conf | 1 + rbm.local.conf.example | 6 ++++++ 4 files changed, 19 insertions(+), 1 deletion(-) diff --git a/README b/README index 956e162..e3672ec 100644 --- a/README +++ b/README @@ -169,6 +169,18 @@ There will be a script to clean old build files and containers that are no longer used, but it has not been added yet. +Multiple build directories on the same host +------------------------------------------- + +You can do multiple builds of Tor Browser in different directories on +the same host. However the docker images namespace is global, so you +may have some conflicts with the same image names used by the +different builds. By default, the docker images are prefixed with +tor-browser_$USER. You can change this prefix by defining the +docker_image_prefix option in rbm.local.conf, using a different prefix +for each of your build directories. + + Common Build Errors ------------------- diff --git a/projects/docker-image/config b/projects/docker-image/config index 27d2654..1968b77 100644 --- a/projects/docker-image/config +++ b/projects/docker-image/config @@ -1,7 +1,6 @@ # vim: filetype=yaml sw=2 filename: '[% sha256(c("pre")).substr(0, 12) %]' remote_docker: 1 -docker_image_prefix: '[% GET c("var/project_name") ? c("var/project_name") : "rbm-build" %]_[% GET ENV.RBM_BUILDNAME ? ENV.RBM_BUILDNAME : ENV.USER ? ENV.USER : c("uid") %]' docker_save_image: '[% c("docker_image_prefix") %]:[% c("filename") %]' pkg_type: build diff --git a/rbm.conf b/rbm.conf index 5dfdc30..47ffbfb 100644 --- a/rbm.conf +++ b/rbm.conf @@ -155,6 +155,7 @@ targets: docker_image: '[% pc("docker-image", "docker_save_image") %]' +docker_image_prefix: '[% GET c("var/project_name") ? c("var/project_name") : "rbm-build" %]_[% GET ENV.RBM_BUILDNAME ? ENV.RBM_BUILDNAME : ENV.USER ? ENV.USER : c("uid") %]' # change the default gpg_wrapper to allow git tag signed using an # expired key. diff --git a/rbm.local.conf.example b/rbm.local.conf.example index 42bf431..20f081f 100644 --- a/rbm.local.conf.example +++ b/rbm.local.conf.example @@ -16,6 +16,12 @@ ### this. #debug: 0 +### If you are doing multiple builds in different directories on the +### same host, you should define docker_image_prefix with a different +### value for each build directory, so that the different builds don't +### use the same docker image names. +#docker_image_prefix: tor-browser_XXXXX + var: local_conf: 1

1 0

[rbm/master] Add support for optional local configuration file rbm.local.conf
by boklm＠torproject.org 13 Feb '17

13 Feb '17

commit a57b4846c8aba5697ce1f197996e2962ffb5b534 Author: Nicolas Vigier <boklm(a)torproject.org> Date: Tue Feb 14 00:28:45 2017 +0100 Add support for optional local configuration file rbm.local.conf --- NEWS | 2 ++ doc/rbm_cli.asc | 3 +++ doc/rbm_config.asc | 29 ++++++++++++++++++++++++++--- lib/RBM.pm | 10 +++++++++- lib/RBM/DefaultConfig.pm | 1 + rbm | 3 ++- 6 files changed, 43 insertions(+), 5 deletions(-) diff --git a/NEWS b/NEWS index 82890a5..1a1789f 100644 --- a/NEWS +++ b/NEWS @@ -1,3 +1,5 @@ +- Add support for optional local configuration file rbm.local.conf + - add the git_submodule option - add the hg_opt option diff --git a/doc/rbm_cli.asc b/doc/rbm_cli.asc index 92b84ef..66f6025 100644 --- a/doc/rbm_cli.asc +++ b/doc/rbm_cli.asc @@ -31,6 +31,9 @@ The following options can be set on the command line : --sysconf-file=<file>:: Set the optional system configuration file path + --localconf-file=<file>:: + Set the optional local configuration file path + --target=<target>:: Set the target. This option can be used multiple times to use more than one target. See link:rbm_targets.html[rbm_targets(7)] for diff --git a/doc/rbm_config.asc b/doc/rbm_config.asc index 27b8f7a..e8decd9 100644 --- a/doc/rbm_config.asc +++ b/doc/rbm_config.asc @@ -8,11 +8,13 @@ rbm_config - The rbm configuration DESCRIPTION ----------- -All configuration options can be defined in 3 different places : +All configuration options can be defined in 5 different places : -- in the main configuration in your working directory +- in the main configuration in your working directory (+rbm.conf+) -- in the global system configuration +- in the local configuration in your working directory (+rbm.local.conf+) + +- in the global system configuration (+/etc/rbm.conf+) - in a project configuration @@ -30,6 +32,14 @@ The option values are used with the following priority order : - project config +- local config for matching step and target + +- local config for matching step + +- local config for matching target + +- local config + - workspace config for matching step and target - workspace config for matching step @@ -62,6 +72,13 @@ This is where you will put configuration relevant to all projects under this working directory. All relative paths used in the configuration are relative from the +rbm.conf+ location. +The local configuration file is +rbm.local.conf+ (or the file defined +by the +localconf_file+ option), in the same directory as the +rbm.conf+ +file. If the file does not exists, it is ignored. The +rbm.local.conf+ +file is used to override some options from +rbm.conf+ relevent to your +local setup, whithout modifying the +rbm.conf+ file which is usually +maintained in a VCS. + An example +rbm.conf+ file will look like this : ---- @@ -89,6 +106,12 @@ sysconf_file:: is +/etc/rbm.conf+. This can also be set with the --sysconf-file command line parameter. +localconf_file:: + The path to an optional local configuration file. The default + is +rbm.local.conf+. If the path is relative, it is relative to + the directory where the +rbm.conf+ file is located. This can + also be set with the --localconf-file command line parameter. + projects_dir:: The directory containing the projects definitions. The default value is +projects+. diff --git a/lib/RBM.pm b/lib/RBM.pm index ad39526..4b5bfe9 100644 --- a/lib/RBM.pm +++ b/lib/RBM.pm @@ -61,6 +61,13 @@ sub load_system_config { $config->{system} = -f $cfile ? load_config_file($cfile) : {}; } +sub load_local_config { + my ($project) = @_; + my $cfile = project_config($project ? $project : 'undef', 'localconf_file'); + $cfile = path($cfile); + $config->{local} = -f $cfile ? load_config_file($cfile) : {}; +} + sub find_config_file { for (my $dir = getcwd; $dir ne '/'; $dir = dirname($dir)) { return "$dir/rbm.conf" if -f "$dir/rbm.conf"; @@ -209,7 +216,8 @@ sub project_config { my $opt_save = $config->{opt}; $config->{opt} = { %{$config->{opt}}, %$options } if $options; $res = config($project, $name, $options, ['opt'], ['run'], - ['projects', $project], [], ['system'], ['default']); + ['projects', $project], ['local'], [], + ['system'], ['default']); if (!$options->{no_tmpl} && defined($res) && !ref $res && !notmpl(confkey_str($name), $project)) { $res = process_template($project, $res, diff --git a/lib/RBM/DefaultConfig.pm b/lib/RBM/DefaultConfig.pm index 8172f04..052cf16 100644 --- a/lib/RBM/DefaultConfig.pm +++ b/lib/RBM/DefaultConfig.pm @@ -103,6 +103,7 @@ sub docker_version { our %default_config = ( sysconf_file => '/etc/rbm.conf', + localconf_file=> 'rbm.local.conf', tmp_dir => '[% GET ENV.TMPDIR ? ENV.TMPDIR : "/tmp"; %]', projects_dir => 'projects', output_dir => 'out', diff --git a/rbm b/rbm index 52f3076..c618ada 100755 --- a/rbm +++ b/rbm @@ -95,7 +95,7 @@ sub set_options { gpg-keyring=s gpg-keyring-dir=s gpg-args=s gpg-bin=s sysconf-file=s debsign-keyid=s use-pbuilder! step=s target=s@ publish-src-dir=s debug! hg-clone-dir=s - hg-hash=s); + hg-hash=s localconf-file=s); my %val; Getopt::Long::GetOptionsFromArray(\@_, \%val, @options) || exit 1; foreach my $k (keys %val) { @@ -108,6 +108,7 @@ sub set_options { $RBM::config->{run}{$l} = $val{$k}; } RBM::load_system_config(@_); + RBM::load_local_config(@_); return $RBM::config->{run}{args} = \@_; }

1 0

Jump to page:

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

tor-commits February 2017