();
- proxy_uri = null;
- proxy_scheme = null;
- block1 = null;
- block2 = null;
- size1 = null;
- size2 = null;
- observe = null;
- oscore = null;
- no_response = null;
+ proxy_uri = null;
+ proxy_scheme = null;
+ block1 = null;
+ block2 = null;
+ size1 = null;
+ size2 = null;
+ observe = null;
+ oscore = null;
+ no_response = null;
- others = null; // new LinkedList<>();
+ others = null; // new LinkedList<>();
}
/**
@@ -134,33 +135,33 @@ public OptionSet(OptionSet origin) {
if (origin == null) {
throw new NullPointerException("option set must not be null!");
}
- if_match_list = copyList(origin.if_match_list);
- uri_host = origin.uri_host;
- etag_list = copyList(origin.etag_list);
- if_none_match = origin.if_none_match;
- uri_port = origin.uri_port;
- location_path_list = copyList(origin.location_path_list);
- uri_path_list = copyList(origin.uri_path_list);
- content_format = origin.content_format;
- max_age = origin.max_age;
- uri_query_list = copyList(origin.uri_query_list);
+ if_match_list = copyList(origin.if_match_list);
+ uri_host = origin.uri_host;
+ etag_list = copyList(origin.etag_list);
+ if_none_match = origin.if_none_match;
+ uri_port = origin.uri_port;
+ location_path_list = copyList(origin.location_path_list);
+ uri_path_list = copyList(origin.uri_path_list);
+ content_format = origin.content_format;
+ max_age = origin.max_age;
+ uri_query_list = copyList(origin.uri_query_list);
uri_query_parameter = origin.uri_query_parameter;
- accept = origin.accept;
+ accept = origin.accept;
location_query_list = copyList(origin.location_query_list);
- proxy_uri = origin.proxy_uri;
- proxy_scheme = origin.proxy_scheme;
+ proxy_uri = origin.proxy_uri;
+ proxy_scheme = origin.proxy_scheme;
- block1 = origin.block1;
- block2 = origin.block2;
+ block1 = origin.block1;
+ block2 = origin.block2;
- size1 = origin.size1;
- size2 = origin.size2;
- observe = origin.observe;
- if(origin.oscore != null) {
- oscore = origin.oscore.clone();
+ size1 = origin.size1;
+ size2 = origin.size2;
+ observe = origin.observe;
+ if (origin.oscore != null) {
+ oscore = origin.oscore.clone();
}
- no_response = origin.no_response;
- others = copyList(origin.others);
+ no_response = origin.no_response;
+ others = copyList(origin.others);
}
/**
@@ -249,7 +250,8 @@ public int getIfMatchCount() {
* server denoting the current resource state.
*
* @param check the ETag of the current resource state
- * @return {@code true}, if ETag matches or message contains an empty If-Match option
+ * @return {@code true}, if ETag matches or message contains an empty
+ * If-Match option
*/
public boolean isIfMatch(byte[] check) {
@@ -279,7 +281,7 @@ public boolean isIfMatch(byte[] check) {
* @throws IllegalArgumentException if the etag has more than 8 bytes.
*/
public OptionSet addIfMatch(byte[] etag) {
- checkOptionValue(OptionNumberRegistry.IF_MATCH, etag);
+ checkOptionValue(StandardOptionRegistry.IF_MATCH, etag);
getIfMatch().add(etag);
return this;
}
@@ -333,7 +335,7 @@ public boolean hasUriHost() {
* 255 bytes.
*/
public OptionSet setUriHost(String host) {
- checkOptionValue(OptionNumberRegistry.URI_HOST, host);
+ checkOptionValue(StandardOptionRegistry.URI_HOST, host);
this.uri_host = host;
return this;
}
@@ -405,7 +407,7 @@ public boolean containsETag(byte[] check) {
* 8 bytes.
*/
public OptionSet addETag(byte[] etag) {
- checkOptionValue(OptionNumberRegistry.ETAG, etag);
+ checkOptionValue(StandardOptionRegistry.ETAG, etag);
if (!containsETag(etag)) {
getETags().add(etag.clone());
}
@@ -422,7 +424,7 @@ public OptionSet addETag(byte[] etag) {
* 8 bytes.
*/
public OptionSet removeETag(byte[] etag) {
- checkOptionValue(OptionNumberRegistry.ETAG, etag);
+ checkOptionValue(StandardOptionRegistry.ETAG, etag);
if (etag_list != null) {
for (int index = 0; index < etag_list.size(); ++index) {
if (Arrays.equals(etag_list.get(index), etag)) {
@@ -490,7 +492,7 @@ public boolean hasUriPort() {
* @throws IllegalArgumentException if port is not in valid range
*/
public OptionSet setUriPort(int port) {
- OptionNumberRegistry.assertValue(OptionNumberRegistry.URI_PORT, port);
+ checkOptionValue(StandardOptionRegistry.URI_PORT, port);
this.uri_port = port;
return this;
}
@@ -563,7 +565,7 @@ public int getLocationPathCount() {
* @throws IllegalArgumentException if the segment has more than 255 bytes.
*/
public OptionSet addLocationPath(String segment) {
- checkOptionValue(OptionNumberRegistry.LOCATION_PATH, segment);
+ checkOptionValue(StandardOptionRegistry.LOCATION_PATH, segment);
getLocationPath().add(segment);
return this;
}
@@ -690,7 +692,7 @@ public OptionSet setUriPath(String path) {
* @throws IllegalArgumentException if the segment has more than 255 bytes.
*/
public OptionSet addUriPath(String segment) {
- checkOptionValue(OptionNumberRegistry.URI_PATH, segment);
+ checkOptionValue(StandardOptionRegistry.URI_PATH, segment);
getUriPath().add(segment);
return this;
}
@@ -758,7 +760,7 @@ public OptionSet setContentFormat(int format) {
if (MediaTypeRegistry.UNDEFINED == format) {
content_format = null;
} else {
- OptionNumberRegistry.assertValue(OptionNumberRegistry.CONTENT_FORMAT, format);
+ checkOptionValue(StandardOptionRegistry.CONTENT_FORMAT, format);
content_format = format;
}
return this;
@@ -803,7 +805,7 @@ public boolean hasMaxAge() {
* @throws IllegalArgumentException if the age has more than 4 bytes.
*/
public OptionSet setMaxAge(long age) {
- OptionNumberRegistry.assertValue(OptionNumberRegistry.MAX_AGE, age);
+ checkOptionValue(StandardOptionRegistry.MAX_AGE, age);
max_age = age;
return this;
}
@@ -884,7 +886,7 @@ public OptionSet setUriQuery(String query) {
* @throws IllegalArgumentException if the argument has more than 255 bytes.
*/
public OptionSet addUriQuery(String argument) {
- checkOptionValue(OptionNumberRegistry.URI_QUERY, argument);
+ checkOptionValue(StandardOptionRegistry.URI_QUERY, argument);
getUriQuery().add(argument);
uri_query_parameter = null;
return this;
@@ -936,7 +938,8 @@ public UriQueryParameter getUriQueryParameter() {
*
*
* @param supportedParameterNames list of supported parameter names. May be
- * {@code null} or empty, if the parameter names should not be verified.
+ * {@code null} or empty, if the parameter names should not be
+ * verified.
* @return the map of Uri-Query parameter
* @throws IllegalArgumentException if a provided query parameter could not
* be verified.
@@ -1018,7 +1021,7 @@ public boolean isAccept(int format) {
* @see MediaTypeRegistry
*/
public OptionSet setAccept(int format) {
- OptionNumberRegistry.assertValue(OptionNumberRegistry.ACCEPT, format);
+ checkOptionValue(StandardOptionRegistry.ACCEPT, format);
accept = format;
return this;
}
@@ -1099,7 +1102,7 @@ public OptionSet setLocationQuery(String query) {
* @throws IllegalArgumentException if the argument has more than 255 bytes.
*/
public OptionSet addLocationQuery(String argument) {
- checkOptionValue(OptionNumberRegistry.LOCATION_QUERY, argument);
+ checkOptionValue(StandardOptionRegistry.LOCATION_QUERY, argument);
getLocationQuery().add(argument);
return this;
}
@@ -1153,7 +1156,7 @@ public boolean hasProxyUri() {
* 1034 bytes.
*/
public OptionSet setProxyUri(String uri) {
- checkOptionValue(OptionNumberRegistry.PROXY_URI, uri);
+ checkOptionValue(StandardOptionRegistry.PROXY_URI, uri);
proxy_uri = uri;
return this;
}
@@ -1196,7 +1199,7 @@ public boolean hasProxyScheme() {
* than 255 bytes.
*/
public OptionSet setProxyScheme(String scheme) {
- checkOptionValue(OptionNumberRegistry.PROXY_SCHEME, scheme);
+ checkOptionValue(StandardOptionRegistry.PROXY_SCHEME, scheme);
proxy_scheme = scheme;
return this;
}
@@ -1442,7 +1445,7 @@ public boolean hasObserve() {
* 2^24 - 1
*/
public OptionSet setObserve(final int seqnum) {
- OptionNumberRegistry.assertValue(OptionNumberRegistry.OBSERVE, seqnum);
+ checkOptionValue(StandardOptionRegistry.OBSERVE, seqnum);
this.observe = seqnum;
return this;
}
@@ -1495,7 +1498,7 @@ public boolean hasOscore() {
* @throws IllegalArgumentException if the oscore has more than 255 bytes.
*/
public OptionSet setOscore(byte[] oscore) {
- checkOptionValue(OptionNumberRegistry.OSCORE, oscore);
+ checkOptionValue(StandardOptionRegistry.OSCORE, oscore);
this.oscore = oscore.clone();
return this;
}
@@ -1513,7 +1516,8 @@ public OptionSet removeOscore() {
/**
* Gets the NoResponse option.
*
- * @return the NoResponse option, or, {@code null}, if the option is not present
+ * @return the NoResponse option, or, {@code null}, if the option is not
+ * present
* @since 3.0
*/
public NoResponseOption getNoResponse() {
@@ -1573,11 +1577,26 @@ public OptionSet removeNoResponse() {
*
* @param number the option number
* @return {@code true}, if present
+ * @deprecated use {@link #hasOption(OptionDefinition)} instead
*/
+ @Deprecated
public boolean hasOption(int number) {
return Collections.binarySearch(asSortedList(), new Option(number)) >= 0;
}
+ /**
+ * Checks, if an arbitrary option is present.
+ *
+ * Note: implementation uses {@link #asSortedList()} and is therefore not
+ * recommended to be called too frequently.
+ *
+ * @param definition the option definition
+ * @return {@code true}, if present
+ */
+ public boolean hasOption(OptionDefinition definition) {
+ return Collections.binarySearch(asSortedList(), new Option(definition)) >= 0;
+ }
+
private List getOthersInternal() {
synchronized (this) {
if (others == null)
@@ -1604,9 +1623,12 @@ public List getOthers() {
* Gets list of other options.
*
* @param number other option
- * @return an unmodifiable and unsorted list of other options with the provided number.
+ * @return an unmodifiable and unsorted list of other options with the
+ * provided number.
* @since 3.7
+ * @deprecated use {@link #getOthers(OptionDefinition)} instead
*/
+ @Deprecated
public List getOthers(int number) {
List options = null;
List others = this.others;
@@ -1627,6 +1649,34 @@ public List getOthers(int number) {
}
}
+ /**
+ * Gets list of other options.
+ *
+ * @param definition other option definition
+ * @return an unmodifiable and unsorted list of other options with the
+ * provided definition.
+ * @since 3.8
+ */
+ public List getOthers(OptionDefinition definition) {
+ List options = null;
+ List others = this.others;
+ if (others != null) {
+ for (Option option : others) {
+ if (definition.equals(option.getDefinition())) {
+ if (options == null) {
+ options = new ArrayList<>();
+ }
+ options.add(option);
+ }
+ }
+ }
+ if (options == null) {
+ return Collections.emptyList();
+ } else {
+ return Collections.unmodifiableList(options);
+ }
+ }
+
/**
* Gets other option.
*
@@ -1635,7 +1685,9 @@ public List getOthers(int number) {
* @param number other option
* @return other option, or {@code null}, if not available.
* @since 3.7
+ * @deprecated use {@link #getOtherOption(OptionDefinition)} instead
*/
+ @Deprecated
public Option getOtherOption(int number) {
List others = this.others;
if (others != null) {
@@ -1648,6 +1700,27 @@ public Option getOtherOption(int number) {
return null;
}
+ /**
+ * Gets other option.
+ *
+ * If the other option is contained more than once, return the first.
+ *
+ * @param definition other option definition
+ * @return other option, or {@code null}, if not available.
+ * @since 3.8
+ */
+ public Option getOtherOption(OptionDefinition definition) {
+ List others = this.others;
+ if (others != null) {
+ for (Option option : others) {
+ if (definition.equals(option.getDefinition())) {
+ return option;
+ }
+ }
+ }
+ return null;
+ }
+
/**
* Gets all options in a list sorted according to their option number.
*
@@ -1661,52 +1734,52 @@ public List asSortedList() {
if (if_match_list != null)
for (byte[] value : if_match_list)
- options.add(new Option(OptionNumberRegistry.IF_MATCH, value));
+ options.add(StandardOptionRegistry.IF_MATCH.create(value));
if (hasUriHost())
- options.add(new Option(OptionNumberRegistry.URI_HOST, getUriHost()));
+ options.add(StandardOptionRegistry.URI_HOST.create(getUriHost()));
if (etag_list != null)
for (byte[] value : etag_list)
- options.add(new Option(OptionNumberRegistry.ETAG, value));
+ options.add(StandardOptionRegistry.ETAG.create(value));
if (hasIfNoneMatch())
- options.add(new Option(OptionNumberRegistry.IF_NONE_MATCH, Bytes.EMPTY));
+ options.add(StandardOptionRegistry.IF_NONE_MATCH.create(Bytes.EMPTY));
if (hasUriPort())
- options.add(new Option(OptionNumberRegistry.URI_PORT, getUriPort()));
+ options.add(StandardOptionRegistry.URI_PORT.create(getUriPort()));
if (location_path_list != null)
for (String str : location_path_list)
- options.add(new Option(OptionNumberRegistry.LOCATION_PATH, str));
+ options.add(StandardOptionRegistry.LOCATION_PATH.create(str));
if (uri_path_list != null)
for (String str : uri_path_list)
- options.add(new Option(OptionNumberRegistry.URI_PATH, str));
+ options.add(StandardOptionRegistry.URI_PATH.create(str));
if (hasContentFormat())
- options.add(new Option(OptionNumberRegistry.CONTENT_FORMAT, getContentFormat()));
+ options.add(StandardOptionRegistry.CONTENT_FORMAT.create(getContentFormat()));
if (hasMaxAge())
- options.add(new Option(OptionNumberRegistry.MAX_AGE, getMaxAge()));
+ options.add(StandardOptionRegistry.MAX_AGE.create(getMaxAge()));
if (uri_query_list != null)
for (String str : uri_query_list)
- options.add(new Option(OptionNumberRegistry.URI_QUERY, str));
+ options.add(StandardOptionRegistry.URI_QUERY.create(str));
if (hasAccept())
- options.add(new Option(OptionNumberRegistry.ACCEPT, getAccept()));
+ options.add(StandardOptionRegistry.ACCEPT.create(getAccept()));
if (location_query_list != null)
for (String str : location_query_list)
- options.add(new Option(OptionNumberRegistry.LOCATION_QUERY, str));
+ options.add(StandardOptionRegistry.LOCATION_QUERY.create(str));
if (hasProxyUri())
- options.add(new Option(OptionNumberRegistry.PROXY_URI, getProxyUri()));
+ options.add(StandardOptionRegistry.PROXY_URI.create(getProxyUri()));
if (hasProxyScheme())
- options.add(new Option(OptionNumberRegistry.PROXY_SCHEME, getProxyScheme()));
+ options.add(StandardOptionRegistry.PROXY_SCHEME.create(getProxyScheme()));
if (hasObserve())
- options.add(new Option(OptionNumberRegistry.OBSERVE, getObserve()));
+ options.add(StandardOptionRegistry.OBSERVE.create(getObserve()));
if (hasBlock1())
- options.add(new Option(OptionNumberRegistry.BLOCK1, getBlock1().getValue()));
+ options.add(StandardOptionRegistry.BLOCK1.create(getBlock1().getValue()));
if (hasBlock2())
- options.add(new Option(OptionNumberRegistry.BLOCK2, getBlock2().getValue()));
+ options.add(StandardOptionRegistry.BLOCK2.create(getBlock2().getValue()));
if (hasSize1())
- options.add(new Option(OptionNumberRegistry.SIZE1, getSize1()));
+ options.add(StandardOptionRegistry.SIZE1.create(getSize1()));
if (hasSize2())
- options.add(new Option(OptionNumberRegistry.SIZE2, getSize2()));
+ options.add(StandardOptionRegistry.SIZE2.create(getSize2()));
if (hasOscore())
- options.add(new Option(OptionNumberRegistry.OSCORE, getOscore()));
+ options.add(StandardOptionRegistry.OSCORE.create(getOscore()));
if (hasNoResponse())
options.add(getNoResponse().toOption());
@@ -1758,77 +1831,76 @@ public OptionSet addOptions(List options) {
* @return this OptionSet for a fluent API.
*/
public OptionSet addOption(Option option) {
- // TODO this is not so elegant ...
- if (option instanceof SignalingOption) {
- getOthersInternal().add(option);
- return this;
- }
-
- switch (option.getNumber()) {
- case OptionNumberRegistry.IF_MATCH:
- addIfMatch(option.getValue());
- break;
- case OptionNumberRegistry.URI_HOST:
- setUriHost(option.getStringValue());
- break;
- case OptionNumberRegistry.ETAG:
- addETag(option.getValue());
- break;
- case OptionNumberRegistry.IF_NONE_MATCH:
- setIfNoneMatch(true);
- break;
- case OptionNumberRegistry.URI_PORT:
- setUriPort(option.getIntegerValue());
- break;
- case OptionNumberRegistry.LOCATION_PATH:
- addLocationPath(option.getStringValue());
- break;
- case OptionNumberRegistry.URI_PATH:
- addUriPath(option.getStringValue());
- break;
- case OptionNumberRegistry.CONTENT_FORMAT:
- setContentFormat(option.getIntegerValue());
- break;
- case OptionNumberRegistry.MAX_AGE:
- setMaxAge(option.getLongValue());
- break;
- case OptionNumberRegistry.URI_QUERY:
- addUriQuery(option.getStringValue());
- break;
- case OptionNumberRegistry.ACCEPT:
- setAccept(option.getIntegerValue());
- break;
- case OptionNumberRegistry.LOCATION_QUERY:
- addLocationQuery(option.getStringValue());
- break;
- case OptionNumberRegistry.PROXY_URI:
- setProxyUri(option.getStringValue());
- break;
- case OptionNumberRegistry.PROXY_SCHEME:
- setProxyScheme(option.getStringValue());
- break;
- case OptionNumberRegistry.BLOCK1:
- setBlock1(option.getValue());
- break;
- case OptionNumberRegistry.BLOCK2:
- setBlock2(option.getValue());
- break;
- case OptionNumberRegistry.SIZE1:
- setSize1(option.getIntegerValue());
- break;
- case OptionNumberRegistry.SIZE2:
- setSize2(option.getIntegerValue());
- break;
- case OptionNumberRegistry.OBSERVE:
- setObserve(option.getIntegerValue());
- break;
- case OptionNumberRegistry.OSCORE:
- setOscore(option.getValue());
- break;
- case OptionNumberRegistry.NO_RESPONSE:
- setNoResponse(option.getIntegerValue());
- break;
- default:
+ OptionDefinition definition = option.getDefinition();
+ if (StandardOptionRegistry.STANDARD_OPTIONS.contains(definition)) {
+ switch (option.getNumber()) {
+ case OptionNumberRegistry.IF_MATCH:
+ addIfMatch(option.getValue());
+ break;
+ case OptionNumberRegistry.URI_HOST:
+ setUriHost(option.getStringValue());
+ break;
+ case OptionNumberRegistry.ETAG:
+ addETag(option.getValue());
+ break;
+ case OptionNumberRegistry.IF_NONE_MATCH:
+ setIfNoneMatch(true);
+ break;
+ case OptionNumberRegistry.URI_PORT:
+ setUriPort(option.getIntegerValue());
+ break;
+ case OptionNumberRegistry.LOCATION_PATH:
+ addLocationPath(option.getStringValue());
+ break;
+ case OptionNumberRegistry.URI_PATH:
+ addUriPath(option.getStringValue());
+ break;
+ case OptionNumberRegistry.CONTENT_FORMAT:
+ setContentFormat(option.getIntegerValue());
+ break;
+ case OptionNumberRegistry.MAX_AGE:
+ setMaxAge(option.getLongValue());
+ break;
+ case OptionNumberRegistry.URI_QUERY:
+ addUriQuery(option.getStringValue());
+ break;
+ case OptionNumberRegistry.ACCEPT:
+ setAccept(option.getIntegerValue());
+ break;
+ case OptionNumberRegistry.LOCATION_QUERY:
+ addLocationQuery(option.getStringValue());
+ break;
+ case OptionNumberRegistry.PROXY_URI:
+ setProxyUri(option.getStringValue());
+ break;
+ case OptionNumberRegistry.PROXY_SCHEME:
+ setProxyScheme(option.getStringValue());
+ break;
+ case OptionNumberRegistry.BLOCK1:
+ setBlock1(option.getValue());
+ break;
+ case OptionNumberRegistry.BLOCK2:
+ setBlock2(option.getValue());
+ break;
+ case OptionNumberRegistry.SIZE1:
+ setSize1(option.getIntegerValue());
+ break;
+ case OptionNumberRegistry.SIZE2:
+ setSize2(option.getIntegerValue());
+ break;
+ case OptionNumberRegistry.OBSERVE:
+ setObserve(option.getIntegerValue());
+ break;
+ case OptionNumberRegistry.OSCORE:
+ setOscore(option.getValue());
+ break;
+ case OptionNumberRegistry.NO_RESPONSE:
+ setNoResponse(option.getIntegerValue());
+ break;
+ default:
+ getOthersInternal().add(option);
+ }
+ } else {
getOthersInternal().add(option);
}
return this;
@@ -1843,9 +1915,6 @@ public OptionSet addOption(Option option) {
* {@link #addOption(Option)} for all options, including others, which are
* not intended for tests.
*
- * If custom options are added by this function, the additional validation
- * will be applied based on a {@link CustomOptionNumberRegistry}.
- *
* @param option the Option object to add
* @return this OptionSet for a fluent API.
* @throws NullPointerException if option is {@code null}.
@@ -1856,36 +1925,17 @@ public OptionSet addOtherOption(Option option) {
if (option == null) {
throw new NullPointerException("Option must not be null!");
}
- int number = option.getNumber();
- // TODO this is not so elegant...
- if (option instanceof SignalingOption) {
- SignalingCode code = ((SignalingOption) option).getCode();
- SignalingOptionNumberRegistry.assertValueLength(code, number, option.getLength());
- List others = getOthersInternal();
- if (SignalingOptionNumberRegistry.isSingleValue(code, number)) {
- for (int index=0; index < others.size(); ++index) {
- if (others.get(index).getNumber() == number) {
- others.remove(index);
- break;
- }
- }
- }
- others.add(option);
- } else {
- if (OptionNumberRegistry.isCustomOption(number)) {
- OptionNumberRegistry.assertValueLength(number, option.getLength());
- }
- List others = getOthersInternal();
- if (OptionNumberRegistry.isSingleValue(number)) {
- for (int index=0; index < others.size(); ++index) {
- if (others.get(index).getNumber() == number) {
- others.remove(index);
- break;
- }
+ OptionDefinition definition = option.getDefinition();
+ List others = getOthersInternal();
+ if (definition.isSingleValue()) {
+ for (int index = 0; index < others.size(); ++index) {
+ if (definition.equals(others.get(index).getDefinition())) {
+ others.remove(index);
+ break;
}
}
- others.add(option);
}
+ others.add(option);
return this;
}
@@ -1893,8 +1943,8 @@ public OptionSet addOtherOption(Option option) {
* Clear other option by value.
*
* Note: the removing is based on {@link Option#equals(Object)}, which
- * includes the value as well. For repeatable options all are removed,
- * if the options are equal.
+ * includes the value as well. For repeatable options all are removed, if
+ * the options are equal.
*
* @param option other option
* @return this OptionSet for a fluent API.
@@ -1926,7 +1976,9 @@ public OptionSet clearOtherOption(Option option) {
* @return this OptionSet for a fluent API.
* @see #clearOtherOption(Option)
* @since 3.7
+ * @deprecated use {@link #clearOtherOption(OptionDefinition)} instead.
*/
+ @Deprecated
public OptionSet clearOtherOption(int number) {
Iterator iterator = getOthersInternal().iterator();
while (iterator.hasNext()) {
@@ -1938,6 +1990,28 @@ public OptionSet clearOtherOption(int number) {
return this;
}
+ /**
+ * Clear other option by number.
+ *
+ * Note: the removing is based on {@link Option#getNumber()}. For repeatable
+ * options all are removed, if the number is matching.
+ *
+ * @param definition other option definition
+ * @return this OptionSet for a fluent API.
+ * @see #clearOtherOption(Option)
+ * @since 3.8
+ */
+ public OptionSet clearOtherOption(OptionDefinition definition) {
+ Iterator iterator = getOthersInternal().iterator();
+ while (iterator.hasNext()) {
+ Option currentOption = iterator.next();
+ if (definition.equals(currentOption.getDefinition())) {
+ iterator.remove();
+ }
+ }
+ return this;
+ }
+
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
@@ -1952,13 +2026,13 @@ public String toString() {
if (oldNr != -1) {
if (list)
sbv.append(']');
- sb.append(sbv.toString()).append(", ");
+ sb.append(sbv).append(", ");
sbv.setLength(0);
}
list = false;
sb.append('"');
- sb.append(opt.getName());
+ sb.append(opt.getDefinition().getName());
sb.append('"');
sb.append(':');
} else {
@@ -1973,7 +2047,7 @@ public String toString() {
}
if (list)
sbv.append(']');
- sb.append(sbv.toString());
+ sb.append(sbv);
sb.append('}');
return sb.toString();
@@ -2011,32 +2085,45 @@ private void appendMultiOption(StringBuilder builder, List multiOption,
/**
* Check option value.
*
- * @param optionNumber option number
+ * @param definition option definition
* @param value value of option
* @throws NullPointerException if provided value is {@code null}
- * @throws IllegalArgumentException if provided value encoded in UTF-8 is
- * out of the provided range.
- * @since 3.0
+ * @throws IllegalArgumentException if provided value encoded in UTF-8
+ * doesn't match the option definition.
+ * @since 3.8 (change parameter to {@link OptionDefinition})
*/
- private static void checkOptionValue(int optionNumber, String value) {
- checkOptionValue(optionNumber, value == null ? null : value.getBytes(CoAP.UTF8_CHARSET));
+ private void checkOptionValue(OptionDefinition definition, String value) {
+ checkOptionValue(definition, value == null ? null : value.getBytes(CoAP.UTF8_CHARSET));
}
/**
* Check option value.
*
- * @param optionNumber option number
+ * @param definition option definition
+ * @param longValue value of option
+ * @throws IllegalArgumentException if provided value doesn't match the
+ * option definition.
+ * @since 3.8
+ */
+ private void checkOptionValue(OptionDefinition definition, long longValue) {
+ byte[] value = IntegerOptionDefinition.setLongValue(longValue);
+ checkOptionValue(definition, value);
+ }
+
+ /**
+ * Check option value.
+ *
+ * @param definition option definition
* @param value value of option
* @throws NullPointerException if provided value is {@code null}
- * @throws IllegalArgumentException if provided value encoded in UTF-8 is
- * out of the provided range.
- * @since 3.0
+ * @throws IllegalArgumentException if provided value doesn't match the
+ * option definition.
+ * @since 3.8 (change parameter to {@link OptionDefinition})
*/
- private static void checkOptionValue(int optionNumber, byte[] value) {
+ private void checkOptionValue(OptionDefinition definition, byte[] value) {
if (value == null) {
- String optionName = OptionNumberRegistry.toString(optionNumber);
- throw new NullPointerException(optionName + " option must not be null!");
+ throw new NullPointerException(definition.getName() + " option must not be null!");
}
- OptionNumberRegistry.assertValueLength(optionNumber, value.length);
+ definition.assertValue(value);
}
}
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/coap/SignalingOption.java b/californium-core/src/main/java/org/eclipse/californium/core/coap/SignalingOption.java
deleted file mode 100644
index 57e218f584..0000000000
--- a/californium-core/src/main/java/org/eclipse/californium/core/coap/SignalingOption.java
+++ /dev/null
@@ -1,61 +0,0 @@
-package org.eclipse.californium.core.coap;
-
-import org.eclipse.californium.core.coap.CoAP.SignalingCode;
-import org.eclipse.californium.elements.util.StringUtil;
-
-public class SignalingOption extends Option{
-
- private SignalingCode code;
-
- public SignalingOption(SignalingCode code, int optionNumber) {
- super(optionNumber);
- this.code = code;
- }
-
- public SignalingOption(SignalingCode code, int optionNumber, String str) {
- super(optionNumber);
- this.code = code;
- }
-
- public SignalingOption(SignalingCode code, int optionNumber, int val) {
- super(optionNumber);
- this.code = code;
- }
-
- public String getName() {
- return SignalingOptionNumberRegistry.toString(code,getNumber());
- }
-
- public SignalingCode getCode() {
- return code;
- }
-
- protected void assertValueLength() {
- SignalingOptionNumberRegistry.assertValueLength(code,getNumber(), getValue().length);
- }
-
- /**
- * Renders the option value as string. Takes into account of option type,
- * thus giving more accurate representation of an option {@code value}.
- * Formats {@code value} as integer or string if so defined in
- * {@link OptionNumberRegistry}. In case of option {@code value} is just
- * an opaque byte array, formats this value as hex string.
- *
- * @return the option value as string
- */
- public String toValueString() {
- if (value == null) {
- return "not available";
- }
- switch (SignalingOptionNumberRegistry.getFormatByNr(code,getNumber())) {
- case INTEGER:
- return Long.toString(getLongValue());
- case STRING:
- return "\"" + this.getStringValue() + "\"";
- case EMPTY:
- return "";
- default:
- return "0x" + StringUtil.byteArray2Hex(getValue());
- }
- }
-}
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/coap/SignalingOptionNumberRegistry.java b/californium-core/src/main/java/org/eclipse/californium/core/coap/SignalingOptionNumberRegistry.java
deleted file mode 100644
index 7f9286df4a..0000000000
--- a/californium-core/src/main/java/org/eclipse/californium/core/coap/SignalingOptionNumberRegistry.java
+++ /dev/null
@@ -1,183 +0,0 @@
-package org.eclipse.californium.core.coap;
-
-import org.eclipse.californium.core.coap.CoAP.SignalingCode;
-import org.eclipse.californium.core.coap.OptionNumberRegistry.OptionFormat;
-
-public class SignalingOptionNumberRegistry {
-
- // RFC 8323 : https://datatracker.ietf.org/doc/html/rfc8323#section-11.2
- public static final int MAX_MESSAGE_SIZE= 2;
- public static final int BLOCK_WISE_TRANSFER= 4;
- public static final int CUSTODY= 2;
- public static final int ALTERNATIVE_ADDRESS= 2;
- public static final int HOLD_OFF= 4;
- public static final int BAD_CSM_OPTION= 2;
-
- /**
- * Signaling Option names.
- */
- public static class Names {
- // RFC 8323 : https://datatracker.ietf.org/doc/html/rfc8323#section-11.2
- public static final String Max_Message_Size = "Max-Message-Size";
- public static final String Block_Wise_Transfer = "Block-Wise-Transfer";
- public static final String Custody = "Custody";
- public static final String Alternative_Address = "Alternative-Address";
- public static final String Hold_Off = "Hold-Off";
- public static final String Bad_CSM_Option = "Bad-CSM-Option";
- }
-
- public static String toString(SignalingCode code, int optionNumber) {
- switch (code) {
- case CSM:
- switch (optionNumber) {
- case MAX_MESSAGE_SIZE:
- return Names.Max_Message_Size;
- case BLOCK_WISE_TRANSFER:
- return Names.Block_Wise_Transfer;
- }
- case PING:
- case PONG:
- switch (optionNumber) {
- case CUSTODY:
- return Names.Custody;
- }
- case RELEASE:
- switch (optionNumber) {
- case ALTERNATIVE_ADDRESS:
- return Names.Alternative_Address;
- case HOLD_OFF:
- return Names.Hold_Off;
- }
- case ABORT:
- switch (optionNumber) {
- case BAD_CSM_OPTION:
- return Names.Bad_CSM_Option;
- }
- }
- return String.format("Unknown (%s, %d)", optionNumber);
- }
-
- public static void assertValueLength(SignalingCode code, int optionNumber, int valueLength) {
- int min = 0;
- int max = 65535 + 269;
- switch (code) {
- case CSM:
- switch (optionNumber) {
- case MAX_MESSAGE_SIZE:
- max=4;
- break;
- case BLOCK_WISE_TRANSFER:
- max=0;
- break;
- }
- case PING:
- case PONG:
- switch (optionNumber) {
- case CUSTODY:
- max=0;
- break;
- }
- case RELEASE:
- switch (optionNumber) {
- case ALTERNATIVE_ADDRESS:
- min=1;
- max=255;
- break;
- case HOLD_OFF:
- max=3;
- break;
- }
- case ABORT:
- switch (optionNumber) {
- case BAD_CSM_OPTION:
- max=2;
- break;
- }
- }
-
- if (valueLength < min || valueLength > max) {
- String name = toString(code, optionNumber);
- if (min == max) {
- if (min == 0) {
- throw new IllegalArgumentException(
- "Option " + name + " value of " + valueLength + " bytes must be empty.");
- } else {
- throw new IllegalArgumentException(
- "Option " + name + " value of " + valueLength + " bytes must be " + min + " bytes.");
- }
- } else {
- throw new IllegalArgumentException("Option " + name + " value of " + valueLength
- + " bytes must be in range of [" + min + "-" + max + "] bytes.");
- }
- }
- }
-
- /**
- * Checks whether an option has a single value.
- *
- * @param optionNumber
- * the option number
- * @return {@code true} if the option has a single value
- */
- public static boolean isSingleValue(SignalingCode code, int optionNumber) {
- switch (code) {
- case CSM:
- switch (optionNumber) {
- case MAX_MESSAGE_SIZE:
- return true;
- case BLOCK_WISE_TRANSFER:
- return true;
- }
- case PING:
- case PONG:
- switch (optionNumber) {
- case CUSTODY:
- return true;
- }
- case RELEASE:
- switch (optionNumber) {
- case ALTERNATIVE_ADDRESS:
- return true;
- case HOLD_OFF:
- return true;
- }
- case ABORT:
- switch (optionNumber) {
- case BAD_CSM_OPTION:
- return true;
- }
- }
- return true;
- }
-
- public static OptionFormat getFormatByNr(SignalingCode code, int optionNumber) {
- switch (code) {
- case CSM:
- switch (optionNumber) {
- case MAX_MESSAGE_SIZE:
- return OptionFormat.INTEGER;
- case BLOCK_WISE_TRANSFER:
- return OptionFormat.EMPTY;
- }
- case PING:
- case PONG:
- switch (optionNumber) {
- case CUSTODY:
- return OptionFormat.EMPTY;
- }
- case RELEASE:
- switch (optionNumber) {
- case ALTERNATIVE_ADDRESS:
- return OptionFormat.STRING;
- case HOLD_OFF:
- return OptionFormat.INTEGER;
- }
- case ABORT:
- switch (optionNumber) {
- case BAD_CSM_OPTION:
- return OptionFormat.INTEGER;
- }
- }
- return OptionFormat.UNKNOWN;
- }
-}
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/coap/option/BaseOptionDefinition.java b/californium-core/src/main/java/org/eclipse/californium/core/coap/option/BaseOptionDefinition.java
new file mode 100644
index 0000000000..1ecdc7336b
--- /dev/null
+++ b/californium-core/src/main/java/org/eclipse/californium/core/coap/option/BaseOptionDefinition.java
@@ -0,0 +1,177 @@
+/********************************************************************************
+ * Copyright (c) 2023 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * https://www.eclipse.org/legal/epl-2.0, or the Eclipse Distribution License
+ * v1.0 which is available at
+ * https://www.eclipse.org/org/documents/edl-v10.php.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
+ ********************************************************************************/
+package org.eclipse.californium.core.coap.option;
+
+import java.util.Arrays;
+
+import org.eclipse.californium.core.coap.Option;
+import org.eclipse.californium.core.coap.OptionNumberRegistry.OptionFormat;
+
+/**
+ * Basic option definition.
+ *
+ * @since 3.8
+ */
+public abstract class BaseOptionDefinition implements OptionDefinition {
+
+ /**
+ * Default option lengths.
+ *
+ * The maximum value length is derived from the encoding, it's rather
+ * unrealistic to use more than 1035 (as for the Proxy-Uri option).
+ */
+ private static final int[] LENGTHS = { 0, 65535 + 269 };
+
+ /**
+ * Number of the option.
+ *
+ * @see RFC7252 5.4.6. Option Numbers
+ */
+ private final int number;
+ /**
+ * Name of the option.
+ */
+ private final String name;
+ /**
+ * Value format of the option.
+ *
+ * @see RFC7252 3.2. Option Value Formats
+ */
+ private final OptionFormat format;
+ /**
+ * Indicates, if the option is a single value option or may be used multiple
+ * times.
+ *
+ * @see RFC7252 5.4.5. Repeatable Options
+ */
+ private final boolean singleValue;
+ /**
+ * Array with minimum and maximum value length. {@code lengths[0]} with the
+ * minimum length.
+ */
+ private final int[] lengths;
+
+ /**
+ * Create instance with provided parameter.
+ *
+ * @param number option number
+ * @param name option name
+ * @param format option format
+ * @param singleValue {@code true}, if option supports a single value,
+ * {@code false}, if option supports multiple values.
+ * @param lengths minimum and maximum value lengths. If only one length is
+ * provided, this is used for both, minimum and maximum length.
+ */
+ protected BaseOptionDefinition(int number, String name, OptionFormat format, boolean singleValue, int[] lengths) {
+ if (number > 0xffff || number < 0) {
+ throw new IllegalArgumentException(number + " invalid option number!");
+ }
+ this.number = number;
+ this.name = name;
+ this.format = format;
+ this.singleValue = singleValue;
+ if (lengths == null || lengths.length == 0) {
+ // default lengths
+ this.lengths = LENGTHS;
+ } else if (lengths.length == 1) {
+ // min and max length are the same
+ this.lengths = new int[2];
+ this.lengths[0] = lengths[0];
+ this.lengths[1] = lengths[0];
+ } else {
+ this.lengths = Arrays.copyOf(lengths, 2);
+ }
+ }
+
+ @Override
+ public OptionFormat getFormat() {
+ return format;
+ }
+
+ @Override
+ public boolean isSingleValue() {
+ return singleValue;
+ }
+
+ @Override
+ public final int[] getValueLengths() {
+ return lengths;
+ }
+
+ @Override
+ public void assertValue(byte[] value) {
+ int min = lengths[0];
+ int max = lengths[1];
+ int valueLength = value.length;
+ if (getFormat() == OptionFormat.INTEGER) {
+ // skip leading 0s
+ for (byte b : value) {
+ if (b == 0) {
+ --valueLength;
+ } else {
+ break;
+ }
+ }
+ }
+ if (valueLength < min || valueLength > max) {
+ if (min == max) {
+ if (min == 0) {
+ throw new IllegalArgumentException(
+ "Option " + name + " value of " + valueLength + " bytes must be empty.");
+ } else {
+ throw new IllegalArgumentException(
+ "Option " + name + " value of " + valueLength + " bytes must be " + min + " bytes.");
+ }
+ } else {
+ throw new IllegalArgumentException("Option " + name + " value of " + valueLength
+ + " bytes must be in range of [" + min + "-" + max + "] bytes.");
+ }
+ }
+ }
+
+ @Override
+ public String toString() {
+ return name + "/" + format;
+ }
+
+ @Override
+ public int getNumber() {
+ return number;
+ }
+
+ @Override
+ public String getName() {
+ return name;
+ }
+
+ @Override
+ public Option create(byte[] value) {
+ return new Option(this, value);
+ }
+
+ @Override
+ public Option create(String value) {
+ throw new IllegalArgumentException(getClass().getSimpleName() + " doesn't support string-values!");
+ }
+
+ @Override
+ public Option create(long value) {
+ throw new IllegalArgumentException(getClass().getSimpleName() + " doesn't support integer-values!");
+ }
+
+}
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/coap/option/EmptyOptionDefinition.java b/californium-core/src/main/java/org/eclipse/californium/core/coap/option/EmptyOptionDefinition.java
new file mode 100644
index 0000000000..300cb2ae99
--- /dev/null
+++ b/californium-core/src/main/java/org/eclipse/californium/core/coap/option/EmptyOptionDefinition.java
@@ -0,0 +1,54 @@
+/********************************************************************************
+ * Copyright (c) 2023 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * https://www.eclipse.org/legal/epl-2.0, or the Eclipse Distribution License
+ * v1.0 which is available at
+ * https://www.eclipse.org/org/documents/edl-v10.php.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
+ ********************************************************************************/
+package org.eclipse.californium.core.coap.option;
+
+import org.eclipse.californium.core.coap.Option;
+import org.eclipse.californium.core.coap.OptionNumberRegistry.OptionFormat;
+import org.eclipse.californium.elements.util.Bytes;
+
+/**
+ * Option definition for empty options.
+ *
+ * @see RFC7252 3.2. Option Value Formats
+ *
+ * @since 3.8
+ */
+public class EmptyOptionDefinition extends BaseOptionDefinition {
+
+ private static final int[] LENGTHS = { 0, 0 };
+
+ /**
+ * Create option definition for an empty option.
+ *
+ * @param number option number
+ * @param name option name
+ */
+ public EmptyOptionDefinition(int number, String name) {
+ super(number, name, OptionFormat.EMPTY, true, LENGTHS);
+ }
+
+ @Override
+ public Option create(byte[] value) {
+ if (value == null) {
+ throw new NullPointerException("Option " + getName() + " value must not be null.");
+ }
+ if (value.length > 0) {
+ throw new IllegalArgumentException("Option " + getName() + " value must be empty.");
+ }
+ return new Option(this, Bytes.EMPTY);
+ }
+
+}
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/coap/option/IntegerOptionDefinition.java b/californium-core/src/main/java/org/eclipse/californium/core/coap/option/IntegerOptionDefinition.java
new file mode 100644
index 0000000000..6921d30985
--- /dev/null
+++ b/californium-core/src/main/java/org/eclipse/californium/core/coap/option/IntegerOptionDefinition.java
@@ -0,0 +1,137 @@
+/********************************************************************************
+ * Copyright (c) 2023 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * https://www.eclipse.org/legal/epl-2.0, or the Eclipse Distribution License
+ * v1.0 which is available at
+ * https://www.eclipse.org/org/documents/edl-v10.php.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
+ ********************************************************************************/
+package org.eclipse.californium.core.coap.option;
+
+import org.eclipse.californium.core.coap.Option;
+import org.eclipse.californium.core.coap.OptionNumberRegistry.OptionFormat;
+
+/**
+ * Option definition for integer options.
+ *
+ * @see RFC7252 3.2. Option Value Formats
+ *
+ * @since 3.8
+ */
+public class IntegerOptionDefinition extends BaseOptionDefinition {
+
+ private static final int[] LENGTHS = { 0, 8 };
+
+ /**
+ * Create option definition for an single value integer option.
+ *
+ * @param number option number
+ * @param name option name
+ */
+ public IntegerOptionDefinition(int number, String name) {
+ this(number, name, true, LENGTHS);
+ }
+
+ /**
+ * Create option definition for an integer option.
+ *
+ * @param number option number
+ * @param name option name
+ * @param singleValue {@code true}, if option supports a single value,
+ * {@code false}, if option supports multiple values.
+ */
+ public IntegerOptionDefinition(int number, String name, boolean singleValue) {
+ this(number, name, singleValue, LENGTHS);
+ }
+
+ /**
+ * Create option definition for an integer option with provide length range.
+ *
+ * @param number option number
+ * @param name option name
+ * @param singleValue {@code true}, if option supports a single value,
+ * {@code false}, if option supports multiple values.
+ * @param lengths minimum and maximum value lengths. If only one length is
+ * provided, this is used for both, minimum and maximum length.
+ */
+ public IntegerOptionDefinition(int number, String name, boolean singleValue, int... lengths) {
+ super(number, name, OptionFormat.INTEGER, singleValue, lengths);
+ }
+
+ @Override
+ public Option create(long value) {
+ return new Option(this, value);
+ }
+
+ /**
+ * Gets the option value as integer.
+ *
+ * Handles cases where {@code value} contains leading 0's or a case where
+ * {@code value} is empty which returns 0.
+ *
+ * @param value value as array
+ * @return the integer value
+ */
+ public static int getIntegerValue(byte[] value) {
+ int ret = 0;
+ for (int i = 0; i < value.length; i++) {
+ ret += (value[value.length - i - 1] & 0xFF) << (i * 8);
+ }
+ return ret;
+ }
+
+ /**
+ * Gets the option value as long.
+ *
+ * Handles cases where {@code value} contains leading 0's or a case where
+ * {@code value} is empty which returns 0.
+ *
+ * @param value value as array
+ * @return the long value
+ */
+ public static long getLongValue(byte[] value) {
+ long ret = 0;
+ for (int i = 0; i < value.length; i++) {
+ ret += (long) (value[value.length - i - 1] & 0xFF) << (i * 8);
+ }
+ return ret;
+ }
+
+ /**
+ * Sets the option value from an integer.
+ *
+ * @param val the new option value as integer
+ * @return the value as byte array
+ */
+ public static byte[] setIntegerValue(int val) {
+ int length = (Integer.SIZE - Integer.numberOfLeadingZeros(val) + 7) / Byte.SIZE;
+ byte[] value = new byte[length];
+ for (int i = 0; i < length; i++) {
+ value[length - i - 1] = (byte) (val >> i * 8);
+ }
+ return value;
+ }
+
+ /**
+ * Sets the option value from a long.
+ *
+ * @param val the new option value as long
+ * @return the value as byte array
+ */
+ public static byte[] setLongValue(long val) {
+ int length = (Long.SIZE - Long.numberOfLeadingZeros(val) + 7) / Byte.SIZE;
+ byte[] value = new byte[length];
+ for (int i = 0; i < length; i++) {
+ value[length - i - 1] = (byte) (val >> i * 8);
+ }
+ return value;
+ }
+
+}
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/coap/option/IntegerRangeOptionDefinition.java b/californium-core/src/main/java/org/eclipse/californium/core/coap/option/IntegerRangeOptionDefinition.java
new file mode 100644
index 0000000000..b25e0eaa16
--- /dev/null
+++ b/californium-core/src/main/java/org/eclipse/californium/core/coap/option/IntegerRangeOptionDefinition.java
@@ -0,0 +1,80 @@
+/********************************************************************************
+ * Copyright (c) 2023 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * https://www.eclipse.org/legal/epl-2.0, or the Eclipse Distribution License
+ * v1.0 which is available at
+ * https://www.eclipse.org/org/documents/edl-v10.php.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
+ ********************************************************************************/
+package org.eclipse.californium.core.coap.option;
+
+/**
+ * Option definition for integer options with specific value ranges.
+ *
+ * @see RFC7252 3.2. Option Value Formats
+ *
+ * @since 3.8
+ */
+public class IntegerRangeOptionDefinition extends IntegerOptionDefinition {
+
+ /**
+ * Minimum value.
+ */
+ private final long min;
+ /**
+ * Maximum value.
+ */
+ private final long max;
+
+ /**
+ * Create option definition for an single value integer option.
+ *
+ * @param number option number
+ * @param name option name
+ * @param min minimum value (inclusive)
+ * @param max maximum value (inclusive)
+ */
+ public IntegerRangeOptionDefinition(int number, String name, long min, long max) {
+ this(number, name, true, min, max);
+ }
+
+ /**
+ * Create option definition for an integer option.
+ *
+ * @param number option number
+ * @param name option name
+ * @param singleValue {@code true}, if option supports a single value,
+ * {@code false}, if option supports multiple values.
+ * @param min minimum value (inclusive)
+ * @param max maximum value (inclusive)
+ */
+ public IntegerRangeOptionDefinition(int number, String name, boolean singleValue, long min, long max) {
+ super(number, name, singleValue, null);
+ if (min <= max) {
+ this.min = min;
+ this.max = max;
+ } else {
+ this.min = max;
+ this.max = min;
+ }
+ }
+
+ @Override
+ public void assertValue(byte[] value) {
+ long number = getLongValue(value);
+ if (number < min) {
+ throw new IllegalArgumentException(
+ "Option " + getName() + " value " + number + " must be at least " + min + ".");
+ } else if (number > max) {
+ throw new IllegalArgumentException(
+ "Option " + getName() + " value " + number + " must be at most " + max + ".");
+ }
+ }
+}
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/coap/option/LegacyMapBasedOptionRegistry.java b/californium-core/src/main/java/org/eclipse/californium/core/coap/option/LegacyMapBasedOptionRegistry.java
new file mode 100644
index 0000000000..9584cd1804
--- /dev/null
+++ b/californium-core/src/main/java/org/eclipse/californium/core/coap/option/LegacyMapBasedOptionRegistry.java
@@ -0,0 +1,347 @@
+/********************************************************************************
+ * Copyright (c) 2023 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * https://www.eclipse.org/legal/epl-2.0, or the Eclipse Distribution License
+ * v1.0 which is available at
+ * https://www.eclipse.org/org/documents/edl-v10.php.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
+ ********************************************************************************/
+package org.eclipse.californium.core.coap.option;
+
+import java.util.Arrays;
+
+import org.eclipse.californium.core.coap.Option;
+import org.eclipse.californium.core.coap.OptionNumberRegistry;
+import org.eclipse.californium.core.coap.OptionNumberRegistry.CustomOptionNumberRegistry;
+import org.eclipse.californium.core.coap.OptionNumberRegistry.OptionFormat;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Legacy option registry.
+ *
+ * Provides backwards compatibility for the deprecated
+ * {@link CustomOptionNumberRegistry}.
+ *
+ * @deprecated only for backwards compatibility
+ * @since 3.8
+ */
+@Deprecated
+public class LegacyMapBasedOptionRegistry extends MapBasedOptionRegistry {
+
+ private final static Logger LOGGER = LoggerFactory.getLogger(LegacyMapBasedOptionRegistry.class);
+
+ /**
+ * Enables to support undefined options.
+ *
+ * Only for backwards compatibility. Please add {@link OptionDefinition}s
+ * for all used customer options. With the next major version, all undefined
+ * options will be either ignored (none-critical) or cause an error
+ * (critical).
+ */
+ private final boolean supportUndefinedOptions;
+ /**
+ * Array with supported critical custom options.
+ *
+ * Only for backwards compatibility. Please add {@link OptionDefinition}s
+ * for all used customer options. With the next major version, all undefined
+ * options will be either ignored (none-critical) or cause an error
+ * (critical).
+ */
+ private final int[] criticalCustomOptions;
+ /**
+ * Custom option number registry.
+ *
+ * Only for backwards compatibility. Please add {@link OptionDefinition}s
+ * for all used customer options. With the next major version, all undefined
+ * options will be either ignored (none-critical) or cause an error
+ * (critical).
+ */
+ private final CustomOptionNumberRegistry customOptionNumberRegistry;
+
+ /**
+ * Create legacy option registry.
+ *
+ * @param supportUndefinedOptions {@code true} to enable support for
+ * undefined options.
+ * @param criticalCustomOptions array with option numbers of critical custom
+ * options. If {@code null} but option registries with a custom
+ * option number registry are provided, use that as default.
+ * @param registries registries to include
+ */
+ public LegacyMapBasedOptionRegistry(boolean supportUndefinedOptions, int[] criticalCustomOptions,
+ OptionRegistry... registries) {
+ this.supportUndefinedOptions = supportUndefinedOptions;
+ this.customOptionNumberRegistry = getCustomOptionNumberRegistry(registries);
+ if (this.customOptionNumberRegistry != null && criticalCustomOptions == null) {
+ criticalCustomOptions = this.customOptionNumberRegistry.getCriticalCustomOptions();
+ }
+ if (criticalCustomOptions != null) {
+ this.criticalCustomOptions = criticalCustomOptions.clone();
+ Arrays.sort(this.criticalCustomOptions);
+ } else {
+ this.criticalCustomOptions = null;
+ }
+ for (OptionRegistry registry : registries) {
+ add(registry);
+ }
+ }
+
+ /**
+ * Create legacy option registry.
+ *
+ * @param supportUndefinedOptions {@code true} to enable support for
+ * undefined options.
+ * @param customOptionNumberRegistry custom option number registry. If
+ * {@code null} but option registries with a custom option number
+ * registry are provided, use that as default.
+ * @param registries registries to include
+ */
+ public LegacyMapBasedOptionRegistry(boolean supportUndefinedOptions,
+ CustomOptionNumberRegistry customOptionNumberRegistry, OptionRegistry... registries) {
+ int[] criticalCustomOptions = null;
+ this.supportUndefinedOptions = supportUndefinedOptions;
+
+ if (customOptionNumberRegistry != null) {
+ this.customOptionNumberRegistry = customOptionNumberRegistry;
+ criticalCustomOptions = this.customOptionNumberRegistry.getCriticalCustomOptions();
+ } else {
+ this.customOptionNumberRegistry = getCustomOptionNumberRegistry(registries);
+ if (this.customOptionNumberRegistry != null) {
+ criticalCustomOptions = this.customOptionNumberRegistry.getCriticalCustomOptions();
+ }
+ }
+ if (criticalCustomOptions != null) {
+ this.criticalCustomOptions = criticalCustomOptions.clone();
+ Arrays.sort(this.criticalCustomOptions);
+ } else {
+ this.criticalCustomOptions = null;
+ }
+ for (OptionRegistry registry : registries) {
+ add(registry);
+ }
+ }
+
+ /**
+ * Check, if option number is a (supported) critical custom option.
+ *
+ * @param optionNumber option number to check
+ * @return {@code true}, if option number is a critical custom option,
+ * {@code false}, if not.
+ */
+ private boolean isSupportedCiriticalCustomOption(int optionNumber) {
+ return criticalCustomOptions == null || Arrays.binarySearch(criticalCustomOptions, optionNumber) >= 0;
+ }
+
+ @Override
+ public void add(OptionRegistry registry) {
+ super.add(registry);
+ }
+
+ @Override
+ public void put(OptionDefinition definition) {
+ super.put(definition);
+ }
+
+ @Override
+ protected OptionDefinition getCustomDefinition(int optionNumber) {
+ boolean add = false;
+ OptionDefinition definition = null;
+ if (customOptionNumberRegistry != null) {
+ String name = customOptionNumberRegistry.toString(optionNumber);
+ if (customOptionNumberRegistry.toNumber(name) != OptionNumberRegistry.UNKNOWN) {
+ definition = new CustomOptionDefinition(optionNumber, customOptionNumberRegistry);
+ add = true;
+ }
+ }
+ if (definition == null && supportUndefinedOptions) {
+ if (!OptionNumberRegistry.isCritical(optionNumber) || isSupportedCiriticalCustomOption(optionNumber)) {
+ definition = new UnspecificOptionDefinition(optionNumber);
+ }
+ }
+ if (add) {
+ try {
+ put(definition);
+ LOGGER.debug("{}/{} added.", definition.getNumber(), definition.getName());
+ } catch (IllegalArgumentException ex) {
+ return super.getInternal(optionNumber);
+ }
+ }
+ return definition;
+ }
+
+ @Override
+ public boolean contains(OptionDefinition definition) {
+ if (super.contains(definition)) {
+ return true;
+ }
+ if (supportUndefinedOptions) {
+ return definition instanceof UnspecificOptionDefinition;
+ }
+ return false;
+ }
+
+ private static CustomOptionNumberRegistry getCustomOptionNumberRegistry(OptionRegistry... registries) {
+ CustomOptionNumberRegistry customRegistry = null;
+ for (OptionRegistry registry : registries) {
+ if (registry instanceof LegacyMapBasedOptionRegistry) {
+ if (customRegistry == null) {
+ customRegistry = ((LegacyMapBasedOptionRegistry) registry).customOptionNumberRegistry;
+ } else if (customRegistry != ((LegacyMapBasedOptionRegistry) registry).customOptionNumberRegistry) {
+ throw new IllegalArgumentException("Ambiguous custom registry");
+ }
+ }
+ }
+ return customRegistry;
+ }
+
+ private static class UnspecificOptionDefinition implements OptionDefinition {
+
+ private static final int[] LENGTHS = { 0, 65535 + 269 };
+
+ private final int optionNumber;
+ private final String name;
+
+ protected UnspecificOptionDefinition(int optionNumber) {
+ this(optionNumber, String.format("Unknown (%d)", optionNumber));
+ }
+
+ protected UnspecificOptionDefinition(int optionNumber, String name) {
+ this.optionNumber = optionNumber;
+ this.name = name;
+ }
+
+ @Override
+ public OptionFormat getFormat() {
+ return OptionFormat.UNKNOWN;
+ }
+
+ @Override
+ public boolean isSingleValue() {
+ return true;
+ }
+
+ @Override
+ public void assertValue(byte[] value) {
+ int valueLength = value.length;
+ int lengths[] = getValueLengths();
+ int min = lengths[0];
+ int max = lengths.length == 1 ? min : lengths[1];
+
+ if (valueLength < min || valueLength > max) {
+ if (min == max) {
+ if (min == 0) {
+ throw new IllegalArgumentException(
+ "Option " + getName() + " value of " + valueLength + " bytes must be empty.");
+ } else {
+ throw new IllegalArgumentException("Option " + getName() + " value of " + valueLength
+ + " bytes must be " + min + " bytes.");
+ }
+ } else {
+ throw new IllegalArgumentException("Option " + getName() + " value of " + valueLength
+ + " bytes must be in range of [" + min + "-" + max + "] bytes.");
+ }
+ }
+ }
+
+ @Override
+ public int[] getValueLengths() {
+ return LENGTHS;
+ }
+
+ @Override
+ public int getNumber() {
+ return optionNumber;
+ }
+
+ @Override
+ public String getName() {
+ return name;
+ }
+
+ @Override
+ public Option create(byte[] value) {
+ return new Option(this, value);
+ }
+
+ @Override
+ public Option create(String value) {
+ return create(StringOptionDefinition.setStringValue(value));
+ }
+
+ @Override
+ public Option create(long value) {
+ return create(IntegerOptionDefinition.setLongValue(value));
+ }
+
+ @Override
+ public int hashCode() {
+ return getNumber() + 0x1000000;
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (this == obj)
+ return true;
+ if (obj == null)
+ return false;
+ if (getClass() != obj.getClass())
+ return false;
+ if (!(obj instanceof UnspecificOptionDefinition))
+ return false;
+ UnspecificOptionDefinition other = (UnspecificOptionDefinition) obj;
+ return getNumber() == other.getNumber() && getName().equals(other.getName());
+ }
+
+ }
+
+ private static class CustomOptionDefinition extends UnspecificOptionDefinition {
+
+ private final CustomOptionNumberRegistry customOptionNumberRegistry;
+
+ private CustomOptionDefinition(int optionNumber, CustomOptionNumberRegistry customOptionNumberRegistry) {
+ super(optionNumber, customOptionNumberRegistry.toString(optionNumber));
+ this.customOptionNumberRegistry = customOptionNumberRegistry;
+ }
+
+ @Override
+ public OptionFormat getFormat() {
+ return customOptionNumberRegistry.getFormatByNr(getNumber());
+ }
+
+ @Override
+ public boolean isSingleValue() {
+ return customOptionNumberRegistry.isSingleValue(getNumber());
+ }
+
+ @Override
+ public void assertValue(byte[] value) {
+ super.assertValue(value);
+ if (getFormat() == OptionFormat.INTEGER) {
+ long numberValue = IntegerOptionDefinition.getLongValue(value);
+ customOptionNumberRegistry.assertValue(getNumber(), numberValue);
+ }
+ }
+
+ @Override
+ public int[] getValueLengths() {
+ int[] lengths = customOptionNumberRegistry.getValueLengths(getNumber());
+ if (lengths == null) {
+ lengths = super.getValueLengths();
+ }
+ return lengths;
+ }
+
+ @Override
+ public String getName() {
+ return customOptionNumberRegistry.toString(getNumber());
+ }
+
+ }
+}
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/coap/option/MapBasedOptionRegistry.java b/californium-core/src/main/java/org/eclipse/californium/core/coap/option/MapBasedOptionRegistry.java
new file mode 100644
index 0000000000..abfcd6976e
--- /dev/null
+++ b/californium-core/src/main/java/org/eclipse/californium/core/coap/option/MapBasedOptionRegistry.java
@@ -0,0 +1,317 @@
+/********************************************************************************
+ * Copyright (c) 2023 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * https://www.eclipse.org/legal/epl-2.0, or the Eclipse Distribution License
+ * v1.0 which is available at
+ * https://www.eclipse.org/org/documents/edl-v10.php.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
+ ********************************************************************************/
+package org.eclipse.californium.core.coap.option;
+
+import java.util.Iterator;
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
+
+import org.eclipse.californium.core.coap.CoAP;
+import org.eclipse.californium.core.coap.CoAP.CodeClass;
+import org.eclipse.californium.core.coap.Message;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Option registry.
+ *
+ * Using {@link Map}s to keep the {@link OptionDefinition}s.
+ *
+ * @since 3.8
+ */
+public class MapBasedOptionRegistry implements OptionRegistry {
+
+ private final static Logger LOGGER = LoggerFactory.getLogger(MapBasedOptionRegistry.class);
+
+ /**
+ * Map by option number.
+ *
+ * To support message code specific option numbers, the option number is
+ * extended with the message code.
+ *
+ * @see #getExtendedNumber(int, int)
+ */
+ protected final Map numberMap = new ConcurrentHashMap<>();
+ /**
+ * Map by option name.
+ */
+ private final Map nameMap = new ConcurrentHashMap<>();
+
+ /**
+ * Create option definition map from option definitions.
+ *
+ * @param definitions option definitions to add
+ */
+ public MapBasedOptionRegistry(OptionDefinition... definitions) {
+ try {
+ for (OptionDefinition definition : definitions) {
+ put(definition);
+ }
+ } catch (IllegalArgumentException ex) {
+ LOGGER.error("{}", ex.getMessage());
+ throw ex;
+ }
+ }
+
+ /**
+ * Create option definition map from option registry and option definitions.
+ *
+ * @param registry option registry to add.
+ * @param definitions option definitions to add
+ */
+ public MapBasedOptionRegistry(OptionRegistry registry, OptionDefinition... definitions) {
+ try {
+ add(registry);
+ for (OptionDefinition definition : definitions) {
+ put(definition);
+ }
+ } catch (IllegalArgumentException ex) {
+ LOGGER.error("{}", ex.getMessage());
+ throw ex;
+ }
+ }
+
+ /**
+ * Create option definition map from option registries.
+ *
+ * @param registry option registry to add.
+ * @param registries additional option registry to add.
+ */
+ public MapBasedOptionRegistry(OptionRegistry registry, OptionRegistry... registries) {
+ try {
+ add(registry);
+ for (OptionRegistry reg : registries) {
+ add(reg);
+ }
+ } catch (IllegalArgumentException ex) {
+ LOGGER.error("{}", ex.getMessage());
+ throw ex;
+ }
+ }
+
+ /**
+ * Add option registry.
+ *
+ * @param registry option registry to add.
+ */
+ protected void add(OptionRegistry registry) {
+ for (Entry entry : registry) {
+ putInternal(entry.getKey(), entry.getOptioneDefinition());
+ }
+ }
+
+ /**
+ * Add message code unspecific option definition.
+ *
+ * @param definition option definition
+ */
+ protected void put(OptionDefinition definition) {
+ putInternal(getExtendedNumber(0, definition.getNumber()), definition);
+ }
+
+ /**
+ * Add message code specific option definition.
+ *
+ * @param code message code
+ * @param definition option definition
+ * @see Message#getRawCode()
+ * @see #getExtendedNumber(int, int)
+ */
+ protected void put(int code, OptionDefinition definition) {
+ putInternal(getExtendedNumber(code, definition.getNumber()), definition);
+ }
+
+ /**
+ * Add message code specific option definition.
+ *
+ * @param key extended option number
+ * @param definition option definition
+ * @see #getExtendedNumber(int, int)
+ */
+ protected synchronized void putInternal(int key, OptionDefinition definition) {
+ OptionDefinition current = numberMap.get(key);
+ if (current != null) {
+ throw new IllegalArgumentException(
+ "Number " + definition.getNumber() + " already in use for " + current.getName());
+ }
+ current = nameMap.get(definition.getName());
+ if (current != null) {
+ throw new IllegalArgumentException(
+ "Name " + definition.getName() + " already in use for " + current.getNumber());
+ }
+ numberMap.put(key, definition);
+ nameMap.put(definition.getName(), definition);
+ }
+
+ /**
+ * {@inheritDoc}
+ *
+ * Calls {@link #getCustomDefinition(int)} on missing none code specific
+ * definition. Legacy support adds either a {@code CustomOptionDefinition},
+ * if missing and supported by {@code CustomOptionNumberRegistry}, or
+ * returns a ephemeral {@code UnspecificOptionDefinition}, if
+ * {@code #supportUndefinedOptions} is enabled.
+ */
+ @Override
+ public OptionDefinition getDefinitionByNumber(int code, int optionNumber) {
+ int key = getExtendedNumber(code, optionNumber);
+ OptionDefinition defintion = getInternal(key);
+ if (defintion == null && key == optionNumber) {
+ defintion = getCustomDefinition(optionNumber);
+ }
+ return defintion;
+ }
+
+ /**
+ * {@inheritDoc}
+ *
+ * Calls {@link #getCustomDefinition(int)} on missing definition. Legacy
+ * support adds either a {@code CustomOptionDefinition}, if missing and
+ * supported by {@code CustomOptionNumberRegistry}, or returns a ephemeral
+ * {@code UnspecificOptionDefinition}, if {@code #supportUndefinedOptions}
+ * is enabled.
+ */
+ @Override
+ public OptionDefinition getDefinitionByNumber(int optionNumber) {
+ int key = getExtendedNumber(0, optionNumber);
+ OptionDefinition defintion = getInternal(key);
+ if (defintion == null) {
+ defintion = getCustomDefinition(optionNumber);
+ }
+ return defintion;
+ }
+
+ /**
+ * Get custom definition.
+ *
+ * Intended to be overwritten, if legacy support for custom definitions is
+ * required.
+ *
+ * @param optionNumber option number
+ * @return option definition
+ * @deprecated please add used option definition before using it
+ */
+ @Deprecated
+ protected OptionDefinition getCustomDefinition(int optionNumber) {
+ return null;
+ }
+
+ /**
+ * Get option definition.
+ *
+ * @param key key (extended option number)
+ * @return option definition
+ * @see #getExtendedNumber(int, int)
+ */
+ protected OptionDefinition getInternal(int key) {
+ return numberMap.get(key);
+ }
+
+ @Override
+ public OptionDefinition getDefinitionByName(String name) {
+ return nameMap.get(name);
+ }
+
+ @Override
+ public boolean contains(OptionDefinition definition) {
+ if (numberMap.containsValue(definition)) {
+ return true;
+ }
+ OptionDefinition contained = numberMap.get(definition.getNumber());
+ if (contained != null) {
+ LOGGER.debug("{}/{} => {}/{}: {}.", definition.getNumber(), definition.getName(), contained.getNumber(),
+ contained.getName(), contained == definition);
+ return definition.equals(contained);
+ }
+ return false;
+ }
+
+ @Override
+ public Iterator iterator() {
+ return new Iterator() {
+
+ private final Iterator> cursor = numberMap.entrySet().iterator();
+
+ @Override
+ public boolean hasNext() {
+ return cursor.hasNext();
+ }
+
+ @Override
+ public Entry next() {
+ return new DefinitionEntry(cursor.next());
+ }
+
+ @Override
+ public void remove() {
+ cursor.remove();
+ }
+
+ };
+ }
+
+ /**
+ * Definition entry.
+ *
+ * Used internal for {@link MapBasedOptionRegistry#iterator()}.
+ */
+ private static class DefinitionEntry implements Entry {
+
+ /**
+ * Related map entry.
+ */
+ private final Map.Entry entry;
+
+ /**
+ * Create definition entry from map entry.
+ *
+ * @param entry map entry
+ */
+ private DefinitionEntry(Map.Entry entry) {
+ this.entry = entry;
+ }
+
+ @Override
+ public int getKey() {
+ return entry.getKey();
+ }
+
+ @Override
+ public OptionDefinition getOptioneDefinition() {
+ return entry.getValue();
+ }
+
+ }
+
+ /**
+ * Get extended message code specific option number.
+ *
+ * @param code message code
+ * @param optionNumber option number
+ * @return extended option number
+ * @see Message#getRawCode()
+ * @see OptionDefinition#getNumber()
+ */
+ protected static int getExtendedNumber(int code, int optionNumber) {
+ if (optionNumber > 0xffff || optionNumber < 0) {
+ throw new IllegalArgumentException(optionNumber + " invalid option number!");
+ }
+ if (CoAP.getCodeClass(code) == CodeClass.SIGNAL.value) {
+ return (optionNumber & 0xffff) + (code << 16);
+ } else {
+ return optionNumber;
+ }
+ }
+}
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/coap/option/OpaqueOptionDefinition.java b/californium-core/src/main/java/org/eclipse/californium/core/coap/option/OpaqueOptionDefinition.java
new file mode 100644
index 0000000000..0c9dce5991
--- /dev/null
+++ b/californium-core/src/main/java/org/eclipse/californium/core/coap/option/OpaqueOptionDefinition.java
@@ -0,0 +1,65 @@
+/********************************************************************************
+ * Copyright (c) 2023 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * https://www.eclipse.org/legal/epl-2.0, or the Eclipse Distribution License
+ * v1.0 which is available at
+ * https://www.eclipse.org/org/documents/edl-v10.php.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
+ ********************************************************************************/
+package org.eclipse.californium.core.coap.option;
+
+import org.eclipse.californium.core.coap.OptionNumberRegistry.OptionFormat;
+
+/**
+ * Option definition for opaque options.
+ *
+ * @see RFC7252 3.2. Option Value Formats
+ *
+ * @since 3.8
+ */
+public class OpaqueOptionDefinition extends BaseOptionDefinition {
+
+ /**
+ * Create option definition for an single value opaque option.
+ *
+ * @param number option number
+ * @param name option name
+ */
+ public OpaqueOptionDefinition(int number, String name) {
+ this(number, name, true, null);
+ }
+
+ /**
+ * Create option definition for an opaque option.
+ *
+ * @param number option number
+ * @param name option name
+ * @param singleValue {@code true}, if option supports a single value,
+ * {@code false}, if option supports multiple values.
+ */
+ public OpaqueOptionDefinition(int number, String name, boolean singleValue) {
+ this(number, name, singleValue, null);
+ }
+
+ /**
+ * Create option definition for an opaque option with provide length range.
+ *
+ * @param number option number
+ * @param name option name
+ * @param singleValue {@code true}, if option supports a single value,
+ * {@code false}, if option supports multiple values.
+ * @param lengths minimum and maximum value lengths. If only one length is
+ * provided, this is used for both, minimum and maximum length.
+ */
+ public OpaqueOptionDefinition(int number, String name, boolean singleValue, int... lengths) {
+ super(number, name, OptionFormat.OPAQUE, singleValue, lengths);
+ }
+
+}
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/coap/option/OptionDefinition.java b/californium-core/src/main/java/org/eclipse/californium/core/coap/option/OptionDefinition.java
new file mode 100644
index 0000000000..d1d9c7d226
--- /dev/null
+++ b/californium-core/src/main/java/org/eclipse/californium/core/coap/option/OptionDefinition.java
@@ -0,0 +1,117 @@
+/********************************************************************************
+ * Copyright (c) 2023 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * https://www.eclipse.org/legal/epl-2.0, or the Eclipse Distribution License
+ * v1.0 which is available at
+ * https://www.eclipse.org/org/documents/edl-v10.php.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
+ ********************************************************************************/
+package org.eclipse.californium.core.coap.option;
+
+import org.eclipse.californium.core.coap.Option;
+import org.eclipse.californium.core.coap.OptionNumberRegistry.OptionFormat;
+
+/**
+ * Option definition.
+ *
+ * Generic definition for CoAP options.
+ *
+ * @since 3.8
+ */
+public interface OptionDefinition {
+
+ /**
+ * Returns the option number.
+ *
+ * @return the option number
+ *
+ * @see RFC7252 5.4.6. Option Numbers
+ */
+ int getNumber();
+
+ /**
+ * Get name of option.
+ *
+ * @return name of the option
+ */
+ String getName();
+
+ /**
+ * Returns a string representation of the custom option definition.
+ *
+ * @return a string describing the custom option definition.
+ */
+ String toString();
+
+ /**
+ * Create option from byte array.
+ *
+ * @param value the option value
+ * @return create options
+ */
+ Option create(byte[] value);
+
+ /**
+ * Create option from string.
+ *
+ * @param value the option value
+ * @return create options
+ */
+ Option create(String value);
+
+ /**
+ * Create option from long.
+ *
+ * @param value the option value
+ * @return create options
+ */
+ Option create(long value);
+
+ /**
+ * Get option format.
+ *
+ * @return option format
+ *
+ * @see RFC7252 3.2. Option Value Formats
+ */
+ OptionFormat getFormat();
+
+ /**
+ * Checks whether an option has a single value.
+ *
+ * @return {@code true}, if the option has a single value, {@code false}, if
+ * the option is repeatable
+ *
+ * @see RFC7252 5.4.5. Repeatable Options
+ */
+ boolean isSingleValue();
+
+ /**
+ * Assert, that the value matches the custom options's definition.
+ *
+ * @param value value to check
+ * @throws IllegalArgumentException if value doesn't match the definition
+ */
+ void assertValue(byte[] value);
+
+ /**
+ * Get value length of custom option.
+ *
+ * @return array with minimum and maximum length of values. If both are
+ * equal, the array may contain only one length. If {@code null} is
+ * returned, the default lengths of values is used.
+ * @deprecated obsolete, use {@link OptionDefinition#assertValue(byte[])}
+ */
+ @Deprecated
+ int[] getValueLengths();
+
+}
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/coap/option/OptionRegistry.java b/californium-core/src/main/java/org/eclipse/californium/core/coap/option/OptionRegistry.java
new file mode 100644
index 0000000000..97420d5755
--- /dev/null
+++ b/californium-core/src/main/java/org/eclipse/californium/core/coap/option/OptionRegistry.java
@@ -0,0 +1,93 @@
+/********************************************************************************
+ * Copyright (c) 2023 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * https://www.eclipse.org/legal/epl-2.0, or the Eclipse Distribution License
+ * v1.0 which is available at
+ * https://www.eclipse.org/org/documents/edl-v10.php.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
+ ********************************************************************************/
+package org.eclipse.californium.core.coap.option;
+
+import org.eclipse.californium.core.coap.Message;
+
+/**
+ * Registry of option definitions.
+ *
+ * @since 3.8
+ */
+public interface OptionRegistry extends Iterable {
+
+ /**
+ * Returns the option definition based on the option number and message
+ * code.
+ *
+ * RFC7252, RFC7641, RFC7959, RFC7967 and RFC8613 specifies options based on
+ * the option number only, RFC 8323 introduces message specific options.
+ *
+ * @param code the message code. Maybe {@code 0} for common RFC7252
+ * messages.
+ * @param optionNumber The option number
+ * @return The option definition corresponding to the option number,
+ * {@code null}, if not available.
+ * @throws IllegalArgumentException if a critical option is unknown.
+ * @see Message#getRawCode()
+ * @see OptionDefinition#getNumber()
+ * @see #getDefinitionByNumber(int)
+ */
+ OptionDefinition getDefinitionByNumber(int code, int optionNumber);
+
+ /**
+ * Returns the option definition based on the option number.
+ *
+ * @param optionNumber The option number
+ * @return The option definition corresponding to the option number,
+ * {@code null}, if not available.
+ * @see #getDefinitionByNumber(int, int)
+ */
+ OptionDefinition getDefinitionByNumber(int optionNumber);
+
+ /**
+ * Returns the option definition based on the option name.
+ *
+ * @param name the option name
+ * @return The option definition corresponding to the option number,
+ * {@code null}, if not available.
+ * @see #getDefinitionByNumber(int, int)
+ */
+ OptionDefinition getDefinitionByName(String name);
+
+ /**
+ * Checks, if an option definition is contained.
+ *
+ * @param definition the option definition to check
+ * @return {@code true}, if available, {@code false}, otherwise.
+ */
+ boolean contains(OptionDefinition definition);
+
+ /**
+ * Option definition entry.
+ */
+ interface Entry {
+
+ /**
+ * Get the option definition key.
+ *
+ * @return the option definition key
+ */
+ int getKey();;
+
+ /**
+ * Get the option definition.
+ *
+ * @return the option definition
+ */
+ OptionDefinition getOptioneDefinition();
+ }
+
+}
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/coap/option/SignalingOptionRegistry.java b/californium-core/src/main/java/org/eclipse/californium/core/coap/option/SignalingOptionRegistry.java
new file mode 100644
index 0000000000..c174dbd537
--- /dev/null
+++ b/californium-core/src/main/java/org/eclipse/californium/core/coap/option/SignalingOptionRegistry.java
@@ -0,0 +1,137 @@
+/*******************************************************************************
+ * Copyright (c) 2023 Rogier Cobben.
+ *
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * and Eclipse Distribution License v1.0 which accompany this distribution.
+ *
+ * The Eclipse Public License is available at
+ * http://www.eclipse.org/legal/epl-v20.html
+ * and the Eclipse Distribution License is available at
+ * http://www.eclipse.org/org/documents/edl-v10.html.
+ *
+ * Contributors:
+ * Rogier Cobben - Added map based signaling option registry
+ ******************************************************************************/
+package org.eclipse.californium.core.coap.option;
+
+import org.eclipse.californium.core.coap.CoAP.SignalingCode;
+
+/**
+ * Signaling Options registry.
+ *
+ * @see RFC8323 11.2. CoAP Signaling Option Numbers
+ * Registry
+ *
+ */
+public class SignalingOptionRegistry extends MapBasedOptionRegistry {
+
+ /**
+ * Signaling Option numbers.
+ */
+ public static class Numbers {
+
+ public static final int MAX_MESSAGE_SIZE = 2;
+ public static final int BLOCK_WISE_TRANSFER = 4;
+ public static final int CUSTODY = 2;
+ public static final int ALTERNATIVE_ADDRESS = 2;
+ public static final int HOLD_OFF = 4;
+ public static final int BAD_CSM_OPTION = 2;
+ }
+
+ /**
+ * Signaling Option names.
+ */
+ public static class Names {
+
+ public static final String Max_Message_Size = "Max-Message-Size";
+ public static final String Block_Wise_Transfer = "Block-Wise-Transfer";
+ public static final String Custody = "Custody";
+ public static final String Alternative_Address = "Alternative-Address";
+ public static final String Hold_Off = "Hold-Off";
+ public static final String Bad_CSM_Option = "Bad-CSM-Option";
+ }
+
+ /**
+ * Max-Message-Size Capability Option. Applicable in CSM Messages.
+ *
+ * @see RFC8323 5.3.1. Max-Message-Size Capability
+ * Option
+ */
+ public static final IntegerOptionDefinition MAX_MESSAGE_SIZE = new IntegerOptionDefinition(Numbers.MAX_MESSAGE_SIZE,
+ Names.Max_Message_Size, true, 0, 4);
+
+ /**
+ * Block-Wise-Transfer Capability Option. Applicable in CSM Messages.
+ *
+ * @see RFC8323 5.3.2. Block-Wise-Transfer Capability
+ * Option
+ */
+ public static final EmptyOptionDefinition BLOCK_WISE_TRANSFER = new EmptyOptionDefinition(
+ Numbers.BLOCK_WISE_TRANSFER, Names.Block_Wise_Transfer);
+
+ /**
+ * Custody Option. Applicable in Ping Messages.
+ *
+ * @see RFC8323 5.4.1. Custody Option
+ */
+ public static final EmptyOptionDefinition CUSTODY = new EmptyOptionDefinition(Numbers.CUSTODY, Names.Custody);
+
+ /**
+ * Alternative-Address Option. Applicable in Release Messages.
+ *
+ * @see RFC8323 5.5. Release Messages
+ */
+ public static final StringOptionDefinition ALTERNATIVE_ADDRESS = new StringOptionDefinition(
+ Numbers.ALTERNATIVE_ADDRESS, Names.Alternative_Address, false, 1, 255);
+
+ /**
+ * Hold-Off Option. Applicable in Release Messages.
+ *
+ * @see RFC8323 5.5. Release Messages
+ */
+ public static final IntegerOptionDefinition HOLD_OFF = new IntegerOptionDefinition(Numbers.HOLD_OFF, Names.Hold_Off,
+ true, 0, 3);
+
+ /**
+ * Bad-CSM-Option Option. Applicable in Abort Messages.
+ *
+ * @see RFC8323 5.6. Abort Messages
+ */
+ public static final IntegerOptionDefinition BAD_CSM_OPTION = new IntegerOptionDefinition(Numbers.BAD_CSM_OPTION,
+ Names.Bad_CSM_Option, true, 0, 2);
+
+ /**
+ * Get definition by number always returns null, because MessageCode is
+ * necessary to discriminate signaling options.
+ */
+ @Override
+ public OptionDefinition getDefinitionByNumber(int optionNumber) {
+ return null;
+ }
+
+ /**
+ * Registry with all signaling options.
+ */
+ public static final SignalingOptionRegistry SIGNALING_OPTIONS = new SignalingOptionRegistry();
+
+ private SignalingOptionRegistry() {
+ super();
+ put(SignalingCode.CSM.value, MAX_MESSAGE_SIZE);
+ put(SignalingCode.CSM.value, BLOCK_WISE_TRANSFER);
+ put(SignalingCode.PING.value, CUSTODY);
+ put(SignalingCode.RELEASE.value, ALTERNATIVE_ADDRESS);
+ put(SignalingCode.RELEASE.value, HOLD_OFF);
+ put(SignalingCode.ABORT.value, BAD_CSM_OPTION);
+ }
+}
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/coap/option/StandardOptionRegistry.java b/californium-core/src/main/java/org/eclipse/californium/core/coap/option/StandardOptionRegistry.java
new file mode 100644
index 0000000000..0c79c20c56
--- /dev/null
+++ b/californium-core/src/main/java/org/eclipse/californium/core/coap/option/StandardOptionRegistry.java
@@ -0,0 +1,221 @@
+/********************************************************************************
+ * Copyright (c) 2023 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * https://www.eclipse.org/legal/epl-2.0, or the Eclipse Distribution License
+ * v1.0 which is available at
+ * https://www.eclipse.org/org/documents/edl-v10.php.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
+ ********************************************************************************/
+package org.eclipse.californium.core.coap.option;
+
+import org.eclipse.californium.core.coap.OptionNumberRegistry;
+import org.eclipse.californium.core.coap.OptionNumberRegistry.Names;
+
+/**
+ * Option registry with supported standard options.
+ *
+ * @see RFC7252 5.10. Option Definitions
+ * @see RFC7641 2. The Observe Option
+ * @see RFC7959 2.1. The Block2 and Block1 Options
+ * @see RFC7959 4. The Size2 and Size1 Options
+ * @see RFC7967 2. Option Definition
+ * @see RFC8613 2. The OSCORE Option
+ *
+ * @since 3.8
+ */
+public class StandardOptionRegistry extends MapBasedOptionRegistry {
+
+ /**
+ * @see RFC7252 5.10. Option Definitions
+ */
+ public static final OpaqueOptionDefinition IF_MATCH = new OpaqueOptionDefinition(OptionNumberRegistry.IF_MATCH,
+ Names.If_Match, false, 0, 8);
+ /**
+ * @see RFC7252 5.10. Option Definitions
+ */
+ public static final StringOptionDefinition URI_HOST = new StringOptionDefinition(OptionNumberRegistry.URI_HOST,
+ Names.Uri_Host, true, 1, 255);
+ /**
+ * @see RFC7252 5.10. Option Definitions
+ */
+ public static final OpaqueOptionDefinition ETAG = new OpaqueOptionDefinition(OptionNumberRegistry.ETAG, Names.ETag,
+ false, 1, 8);
+ /**
+ * @see RFC7252 5.10. Option Definitions
+ */
+ public static final EmptyOptionDefinition IF_NONE_MATCH = new EmptyOptionDefinition(
+ OptionNumberRegistry.IF_NONE_MATCH, Names.If_None_Match);
+ /**
+ * @see RFC7252 5.10. Option Definitions
+ */
+ public static final IntegerOptionDefinition URI_PORT = new IntegerOptionDefinition(OptionNumberRegistry.URI_PORT,
+ Names.Uri_Port, true, 0, 2);
+ /**
+ * @see RFC7252 5.10. Option Definitions
+ */
+ public static final StringOptionDefinition LOCATION_PATH = new StringOptionDefinition(
+ OptionNumberRegistry.LOCATION_PATH, Names.Location_Path, false, 0, 255);
+ /**
+ * @see RFC7252 5.10. Option Definitions
+ */
+ public static final StringOptionDefinition URI_PATH = new StringOptionDefinition(OptionNumberRegistry.URI_PATH,
+ Names.Uri_Path, false, 0, 255);
+ /**
+ * @see RFC7252 5.10. Option Definitions
+ */
+ public static final IntegerOptionDefinition CONTENT_FORMAT = new IntegerOptionDefinition(
+ OptionNumberRegistry.CONTENT_FORMAT, Names.Content_Format, true, 0, 2);
+ /**
+ * @see RFC7252 5.10. Option Definitions
+ */
+ public static final IntegerOptionDefinition MAX_AGE = new IntegerOptionDefinition(OptionNumberRegistry.MAX_AGE,
+ Names.Max_Age, true, 0, 4);
+ /**
+ * @see RFC7252 5.10. Option Definitions
+ */
+ public static final StringOptionDefinition URI_QUERY = new StringOptionDefinition(OptionNumberRegistry.URI_QUERY,
+ Names.Uri_Query, false, 0, 255);
+ /**
+ * @see RFC7252 5.10. Option Definitions
+ */
+ public static final IntegerOptionDefinition ACCEPT = new IntegerOptionDefinition(OptionNumberRegistry.ACCEPT,
+ Names.Accept, true, 0, 2);
+ /**
+ * @see RFC7252 5.10. Option Definitions
+ */
+ public static final StringOptionDefinition LOCATION_QUERY = new StringOptionDefinition(
+ OptionNumberRegistry.LOCATION_QUERY, Names.Location_Query, false, 0, 255);
+ /**
+ * @see RFC7252 5.10. Option Definitions
+ */
+ public static final StringOptionDefinition PROXY_URI = new StringOptionDefinition(OptionNumberRegistry.PROXY_URI,
+ Names.Proxy_Uri, true, 1, 1034);
+ /**
+ * @see RFC7252 5.10. Option Definitions
+ */
+ public static final StringOptionDefinition PROXY_SCHEME = new StringOptionDefinition(
+ OptionNumberRegistry.PROXY_SCHEME, Names.Proxy_Scheme, true, 1, 255);
+ /**
+ * @see RFC7252 5.10. Option Definitions
+ */
+ public static final IntegerOptionDefinition SIZE1 = new IntegerOptionDefinition(OptionNumberRegistry.SIZE1,
+ Names.Size1, true, 0, 4);
+ /**
+ * @see RFC7641 2. The Observe Option
+ */
+ public static final IntegerOptionDefinition OBSERVE = new IntegerOptionDefinition(OptionNumberRegistry.OBSERVE,
+ Names.Observe, true, 0, 3);
+ /**
+ * @see RFC7959 2.1. The Block2 and Block1 Options
+ */
+ public static final IntegerOptionDefinition BLOCK1 = new IntegerOptionDefinition(OptionNumberRegistry.BLOCK1,
+ Names.Block1, true, 0, 3);
+ /**
+ * @see RFC7959 2.1. The Block2 and Block1 Options
+ */
+ public static final IntegerOptionDefinition BLOCK2 = new IntegerOptionDefinition(OptionNumberRegistry.BLOCK2,
+ Names.Block2, true, 0, 3);
+ /**
+ * @see RFC7959 4. The Size2 and Size1 Options
+ */
+ public static final IntegerOptionDefinition SIZE2 = new IntegerOptionDefinition(OptionNumberRegistry.SIZE2,
+ Names.Size2, true, 0, 4);
+ /**
+ * @see RFC8613 2. The OSCORE Option
+ */
+ public static final OpaqueOptionDefinition OSCORE = new OpaqueOptionDefinition(OptionNumberRegistry.OSCORE,
+ Names.Object_Security, true, 0, 255);
+ /**
+ * @see RFC7967 2. Option Definition
+ */
+ public static final IntegerOptionDefinition NO_RESPONSE = new IntegerOptionDefinition(
+ OptionNumberRegistry.NO_RESPONSE, Names.No_Response, true, 0, 1);
+
+ /**
+ * Registry with all standard options.
+ */
+ public static final OptionRegistry STANDARD_OPTIONS = new StandardOptionRegistry();
+
+ private StandardOptionRegistry() {
+ super(IF_MATCH, URI_HOST, ETAG, IF_NONE_MATCH, URI_PORT, LOCATION_PATH, URI_PATH, CONTENT_FORMAT, MAX_AGE,
+ URI_QUERY, ACCEPT, LOCATION_QUERY, PROXY_URI, PROXY_SCHEME, SIZE1, OBSERVE, BLOCK1, BLOCK2, SIZE2,
+ OSCORE, NO_RESPONSE);
+ }
+
+ /**
+ * Default option registry.
+ */
+ private static volatile OptionRegistry defaultRegistry;
+
+ static {
+ setDefaultOptionRegistry(null);
+ }
+
+ /**
+ * Get default option registry.
+ *
+ * @return the default option registry.
+ */
+ public static OptionRegistry getDefaultOptionRegistry() {
+ return defaultRegistry;
+ }
+
+ /**
+ * Set default option registry
+ *
+ * Note: it is not intended to use a mixture of custom
+ * {@link OptionDefinition}s and a
+ * {@link OptionNumberRegistry#setCustomOptionNumberRegistry(CustomOptionNumberRegistry)}
+ * simultaneously! Please migrate your custom option to
+ * {@link OptionDefinition}s.
+ *
+ * @param registry default option registry. If {@code null}, use the
+ * implementation default.
+ * @return previous default option registry.
+ */
+ @SuppressWarnings("deprecation")
+ public static OptionRegistry setDefaultOptionRegistry(OptionRegistry registry) {
+ OptionRegistry previous = defaultRegistry;
+ if (registry == null) {
+ defaultRegistry = new LegacyMapBasedOptionRegistry(true,
+ OptionNumberRegistry.getCustomOptionNumberRegistry(), StandardOptionRegistry.STANDARD_OPTIONS);
+ } else {
+ defaultRegistry = registry;
+ }
+ return previous;
+ }
+
+}
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/coap/option/StringOptionDefinition.java b/californium-core/src/main/java/org/eclipse/californium/core/coap/option/StringOptionDefinition.java
new file mode 100644
index 0000000000..0bec94bd9b
--- /dev/null
+++ b/californium-core/src/main/java/org/eclipse/californium/core/coap/option/StringOptionDefinition.java
@@ -0,0 +1,92 @@
+/********************************************************************************
+ * Copyright (c) 2023 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * https://www.eclipse.org/legal/epl-2.0, or the Eclipse Distribution License
+ * v1.0 which is available at
+ * https://www.eclipse.org/org/documents/edl-v10.php.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
+ ********************************************************************************/
+package org.eclipse.californium.core.coap.option;
+
+import org.eclipse.californium.core.coap.CoAP;
+import org.eclipse.californium.core.coap.Option;
+import org.eclipse.californium.core.coap.OptionNumberRegistry.OptionFormat;
+
+/**
+ * Option definition for string options.
+ *
+ * @see RFC7252 3.2. Option Value Formats
+ *
+ * @since 3.8
+ */
+public class StringOptionDefinition extends BaseOptionDefinition {
+
+ /**
+ * Create option definition for an single value string option.
+ *
+ * @param number option number
+ * @param name option name
+ */
+ public StringOptionDefinition(int number, String name) {
+ this(number, name, true, null);
+ }
+
+ /**
+ * Create option definition for an string option.
+ *
+ * @param number option number
+ * @param name option name
+ * @param singleValue {@code true}, if option supports a single value,
+ * {@code false}, if option supports multiple values.
+ */
+ public StringOptionDefinition(int number, String name, boolean singleValue) {
+ this(number, name, singleValue, null);
+ }
+
+ /**
+ * Create option definition for an string option with provide length range.
+ *
+ * @param number option number
+ * @param name option name
+ * @param singleValue {@code true}, if option supports a single value,
+ * {@code false}, if option supports multiple values.
+ * @param lengths minimum and maximum value lengths. If only one length is
+ * provided, this is used for both, minimum and maximum length.
+ */
+ public StringOptionDefinition(int number, String name, boolean singleValue, int... lengths) {
+ super(number, name, OptionFormat.STRING, singleValue, lengths);
+ }
+
+ @Override
+ public Option create(String value) {
+ return new Option(this, value);
+ }
+
+ /**
+ * Gets the option value as string.
+ *
+ * @param value value as array in UTF-8.
+ * @return the string value
+ */
+ public static String getStringValue(byte[] value) {
+ return new String(value, CoAP.UTF8_CHARSET);
+ }
+
+ /**
+ * Sets the option value from a string.
+ *
+ * @param value the new option value as string
+ * @return the string value array in UTF-8
+ */
+ public static byte[] setStringValue(String value) {
+ return value.getBytes(CoAP.UTF8_CHARSET);
+ }
+
+}
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/config/CoapConfig.java b/californium-core/src/main/java/org/eclipse/californium/core/config/CoapConfig.java
index 3ffaad9f3f..1ac6465fca 100644
--- a/californium-core/src/main/java/org/eclipse/californium/core/config/CoapConfig.java
+++ b/californium-core/src/main/java/org/eclipse/californium/core/config/CoapConfig.java
@@ -32,6 +32,7 @@
import org.eclipse.californium.core.network.deduplication.SweepPerPeerDeduplicator;
import org.eclipse.californium.core.network.stack.KeyUri;
import org.eclipse.californium.core.observe.ObserveRelation;
+import org.eclipse.californium.elements.EndpointIdentityResolver;
import org.eclipse.californium.elements.config.BooleanDefinition;
import org.eclipse.californium.elements.config.Configuration;
import org.eclipse.californium.elements.config.Configuration.ModuleDefinitionsProvider;
@@ -689,6 +690,24 @@ public enum CongestionControlMode {
MODULE + "CONGESTION_CONTROL_ALGORITHM", "Congestion-Control algorithm (still experimental).",
CongestionControlMode.NULL, CongestionControlMode.values());
+ /**
+ * Force congestion control algorithm to use inet-address instead of remote
+ * peer's identity.
+ *
+ * The {@link EndpointIdentityResolver} enables Californium to use a
+ * different remote identity instead of the inet-address to process states.
+ * For congestion control that may result in less good results, if an
+ * inet-address change, maybe caused by a NAT, also causes the quality of
+ * the ip-route.
+ *
+ * @since 3.8
+ */
+ public static final BooleanDefinition CONGESTION_CONTROL_USE_INET_ADDRESS = new BooleanDefinition(
+ MODULE + "CONGESTION_CONTROL_USE_INET_ADDRESS",
+ "Use inet-address for congestion control, even if an other peer identity is used."
+ + " Enable, if NAT changes are also changing the quality of the ip-route.",
+ false);
+
/**
* Number of threads to process coap-exchanges.
*/
@@ -783,6 +802,7 @@ public void applyDefinitions(Configuration config) {
config.set(COAP_SECURE_PORT, CoAP.DEFAULT_COAP_SECURE_PORT);
config.set(ACK_TIMEOUT, 2000, TimeUnit.MILLISECONDS);
+ config.set(MAX_ACK_TIMEOUT, 60000, TimeUnit.MILLISECONDS);
config.set(ACK_INIT_RANDOM, 1.5f);
config.set(ACK_TIMEOUT_SCALE, 2f);
config.set(MAX_RETRANSMIT, 4);
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/network/CoapEndpoint.java b/californium-core/src/main/java/org/eclipse/californium/core/network/CoapEndpoint.java
index 3d7930b560..4273b588ff 100644
--- a/californium-core/src/main/java/org/eclipse/californium/core/network/CoapEndpoint.java
+++ b/californium-core/src/main/java/org/eclipse/californium/core/network/CoapEndpoint.java
@@ -100,6 +100,8 @@
import org.eclipse.californium.core.coap.Response;
import org.eclipse.californium.core.coap.SignalingMessage;
import org.eclipse.californium.core.coap.Token;
+import org.eclipse.californium.core.coap.option.OptionRegistry;
+import org.eclipse.californium.core.coap.option.StandardOptionRegistry;
import org.eclipse.californium.core.network.EndpointManager.ClientMessageDeliverer;
import org.eclipse.californium.core.network.Exchange.Origin;
import org.eclipse.californium.core.network.interceptors.MalformedMessageInterceptor;
@@ -1517,14 +1519,27 @@ public static class Builder {
/**
* Array of critical custom options.
*
- * Only used, if {@link #parser} is not set with
- * {@link #setDataSerializerAndParser(DataSerializer, DataParser)}.
+ * Only used, if {@link CoapEndpoint#parser} is not set with
+ * {@link #setDataSerializerAndParser(DataSerializer, DataParser)} nor a
+ * {@link OptionRegistry} is provided with
+ * {@link #setOptionRegistry(OptionRegistry)}.
* {@code null}, to not check for critical custom options, empty to fail
* on critical custom options. Default empty.
*
* @since 3.4
+ * @deprecated use {@link #optionRegistry} instead.
*/
+ @Deprecated
private int[] criticalCustomOptions = new int[0];
+ /**
+ * Option registry for endpoint parser.
+ *
+ * Only used, if {@link CoapEndpoint#parser} is not set with
+ * {@link #setDataSerializerAndParser(DataSerializer, DataParser)}.
+ *
+ * @since 3.8
+ */
+ private OptionRegistry optionRegistry;
/**
* Logging tag.
*/
@@ -1745,14 +1760,18 @@ public Builder setDataSerializerAndParser(DataSerializer serializer, DataParser
* Set critical custom options.
*
* Only used, if {@link CoapEndpoint#parser} is not set with
- * {@link #setDataSerializerAndParser(DataSerializer, DataParser)}.
+ * {@link #setDataSerializerAndParser(DataSerializer, DataParser)} nor a
+ * {@link OptionRegistry} is provided with
+ * {@link #setOptionRegistry(OptionRegistry)}.
*
* @param criticalCustomOptions Array of critical custom options.
* {@code null}, to not check for critical custom options,
* empty to fail on custom critical options. Default empty.
* @return this
* @since 3.4
+ * @deprecated use {@link #setOptionRegistry(OptionRegistry)} instead
*/
+ @Deprecated
public Builder setCriticalCustomOptions(int[] criticalCustomOptions) {
if (criticalCustomOptions != null) {
this.criticalCustomOptions = criticalCustomOptions.clone();
@@ -1762,6 +1781,22 @@ public Builder setCriticalCustomOptions(int[] criticalCustomOptions) {
return this;
}
+ /**
+ * Set specific option registry for incoming messages.
+ *
+ * Only used, if {@link CoapEndpoint#parser} is not set with
+ * {@link #setDataSerializerAndParser(DataSerializer, DataParser)}.
+ *
+ * @param optionRegistry option registry. Default
+ * {@link StandardOptionRegistry#getDefaultOptionRegistry()}.
+ * @return this
+ * @since 3.8
+ */
+ public Builder setOptionRegistry(OptionRegistry optionRegistry) {
+ this.optionRegistry = optionRegistry;
+ return this;
+ }
+
/**
* Set logging tag.
*
@@ -1793,6 +1828,7 @@ public Builder setCustomCoapStackArgument(Object customStackArgument) {
*
* @return new endpoint
*/
+ @SuppressWarnings("deprecation")
public CoapEndpoint build() {
if (config == null) {
config = Configuration.getStandard();
@@ -1824,10 +1860,18 @@ public CoapEndpoint build() {
}
if (parser == null) {
if (CoAP.isTcpProtocol(connector.getProtocol())) {
- parser = new TcpDataParser(criticalCustomOptions);
+ if (optionRegistry != null) {
+ parser = new TcpDataParser(optionRegistry);
+ } else {
+ parser = new TcpDataParser(criticalCustomOptions);
+ }
} else {
boolean strictEmptyMessageFormat = config.get(CoapConfig.STRICT_EMPTY_MESSAGE_FORMAT);
- parser = new UdpDataParser(strictEmptyMessageFormat, criticalCustomOptions);
+ if (optionRegistry != null) {
+ parser = new UdpDataParser(strictEmptyMessageFormat, optionRegistry);
+ } else {
+ parser = new UdpDataParser(strictEmptyMessageFormat, criticalCustomOptions);
+ }
}
}
return new CoapEndpoint(connector, config, tokenGenerator, observationStore, exchangeStore,
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/network/Exchange.java b/californium-core/src/main/java/org/eclipse/californium/core/network/Exchange.java
index 1a3592c95a..0187ee4105 100644
--- a/californium-core/src/main/java/org/eclipse/californium/core/network/Exchange.java
+++ b/californium-core/src/main/java/org/eclipse/californium/core/network/Exchange.java
@@ -79,6 +79,7 @@
import org.eclipse.californium.core.server.resources.CoapExchange;
import org.eclipse.californium.elements.Connector;
import org.eclipse.californium.elements.EndpointContext;
+import org.eclipse.californium.elements.EndpointIdentityResolver;
import org.eclipse.californium.elements.UdpMulticastConnector;
import org.eclipse.californium.elements.util.ClockUtil;
import org.eclipse.californium.elements.util.SerialExecutor;
@@ -337,10 +338,10 @@ public enum Origin {
* @param peersIdentity peer's identity. Usually that's the peer's
* {@link InetSocketAddress}.
* @param origin the origin of the request (LOCAL or REMOTE)
- * @param executor executor to be used for exchanges. Maybe {@code null} for
- * unit tests.
- * @throws NullPointerException if request is {@code null}
- * @since 3.0 (added peersIdentity)
+ * @param executor executor to be used for exchanges.
+ * @throws NullPointerException if request or executor is {@code null}
+ * @see EndpointIdentityResolver
+ * @since 3.0 (added peersIdentity, executor adapted to mandatory)
*/
public Exchange(Request request, Object peersIdentity, Origin origin, Executor executor) {
this(request, peersIdentity, origin, executor, null, false);
@@ -359,6 +360,7 @@ public Exchange(Request request, Object peersIdentity, Origin origin, Executor e
* @param notification {@code true} for notification exchange, {@code false}
* otherwise
* @throws NullPointerException if request or executor is {@code null}
+ * @see EndpointIdentityResolver
* @since 3.0 (added peersIdentity, executor adapted to mandatory)
*/
public Exchange(Request request, Object peersIdentity, Origin origin, Executor executor, EndpointContext ctx, boolean notification) {
@@ -511,6 +513,32 @@ public boolean isOfLocalOrigin() {
return origin == Origin.LOCAL;
}
+ /**
+ * Get remote socket address.
+ *
+ * Get remote socket address of current request.
+ *
+ * @return current remote socket address
+ * @throws IllegalArgumentException if corresponding endpoint context is
+ * missing
+ * @since 3.8
+ */
+ public InetSocketAddress getRemoteSocketAddress() {
+ EndpointContext remoteEndpoint;
+ if ((origin == Origin.LOCAL)) {
+ remoteEndpoint = currentRequest.getDestinationContext();
+ if (remoteEndpoint == null) {
+ throw new IllegalArgumentException("Outgoing request must have destination context");
+ }
+ } else {
+ remoteEndpoint = currentRequest.getSourceContext();
+ if (remoteEndpoint == null) {
+ throw new IllegalArgumentException("Incoming request must have source context");
+ }
+ }
+ return remoteEndpoint.getPeerAddress();
+ }
+
/**
* Indicate to keep the original request in the exchange store. Intended to
* be used for observe request with blockwise response to be able to react
@@ -783,6 +811,7 @@ public void setEndpoint(Endpoint endpoint) {
* Returns the other peer's identity.
*
* @return the other peer's identity
+ * @see EndpointIdentityResolver
* @since 3.0
*/
public Object getPeersIdentity() {
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/network/TcpMatcher.java b/californium-core/src/main/java/org/eclipse/californium/core/network/TcpMatcher.java
index 8f3de9dff3..16ad68d5db 100644
--- a/californium-core/src/main/java/org/eclipse/californium/core/network/TcpMatcher.java
+++ b/californium-core/src/main/java/org/eclipse/californium/core/network/TcpMatcher.java
@@ -197,7 +197,7 @@ public void run() {
EndpointContext context = exchange.getEndpointContext();
if (context == null) {
// ignore response
- LOGGER.error("ignoring response from [{}]: {}, request pending to sent!",
+ LOGGER.debug("ignoring response from [{}]: {}, request pending to sent!",
response.getSourceContext(), response);
cancel(response, receiver);
return;
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/network/serialization/DataParser.java b/californium-core/src/main/java/org/eclipse/californium/core/network/serialization/DataParser.java
index cb1827def3..003d4f7dc6 100644
--- a/californium-core/src/main/java/org/eclipse/californium/core/network/serialization/DataParser.java
+++ b/californium-core/src/main/java/org/eclipse/californium/core/network/serialization/DataParser.java
@@ -28,10 +28,12 @@
import static org.eclipse.californium.core.coap.CoAP.MessageFormat.PAYLOAD_MARKER;
-import java.util.Arrays;
-
import org.eclipse.californium.core.coap.CoAP;
import org.eclipse.californium.core.coap.CoAP.ResponseCode;
+import org.eclipse.californium.core.coap.option.LegacyMapBasedOptionRegistry;
+import org.eclipse.californium.core.coap.option.OptionDefinition;
+import org.eclipse.californium.core.coap.option.OptionRegistry;
+import org.eclipse.californium.core.coap.option.StandardOptionRegistry;
import org.eclipse.californium.core.coap.CoAPMessageFormatException;
import org.eclipse.californium.core.coap.CoAPOptionException;
import org.eclipse.californium.core.coap.EmptyMessage;
@@ -49,30 +51,19 @@
/**
* A base class for parsing CoAP messages from a byte array.
*/
+@SuppressWarnings("deprecation")
public abstract class DataParser {
- /**
- * Sorted array of critical custom options.
- *
- * {@code null}, to not check for critical custom options, empty to fail on
- * critical custom options.
- *
- * @see OptionNumberRegistry#getCriticalCustomOptions()
- * @since 3.7 the array is sorted
- */
- private final int[] criticalCustomOptions;
+ protected final OptionRegistry optionRegistry;
/**
* Create data parser.
*
- * Use {@link OptionNumberRegistry#getCriticalCustomOptions()} as default to
- * check for critical custom options.
- *
- * @since 3.7 use {@link OptionNumberRegistry#getCriticalCustomOptions()} as
- * default.
+ * @since 3.8 Use {@link StandardOptionRegistry#getDefaultOptionRegistry()}
+ * as default option registry.
*/
protected DataParser() {
- criticalCustomOptions = null;
+ optionRegistry = StandardOptionRegistry.getDefaultOptionRegistry();
}
/**
@@ -83,19 +74,32 @@ protected DataParser() {
* {@link OptionNumberRegistry#getCriticalCustomOptions()} as
* default to check for critical custom options.
* @see OptionNumberRegistry#getCriticalCustomOptions()
- * @since 3.7 use {@link OptionNumberRegistry#getCriticalCustomOptions()} as
- * default.
+ * @since 3.8 Use {@link StandardOptionRegistry#getDefaultOptionRegistry()}
+ * as default option registry.
+ * @deprecated please use {@link OptionRegistry} with
+ * {@link #DataParser(OptionRegistry)}.
*/
+ @Deprecated
protected DataParser(int[] criticalCustomOptions) {
if (criticalCustomOptions == null) {
criticalCustomOptions = OptionNumberRegistry.getCriticalCustomOptions();
}
- if (criticalCustomOptions != null) {
- this.criticalCustomOptions = criticalCustomOptions.clone();
- Arrays.sort(this.criticalCustomOptions);
- } else {
- this.criticalCustomOptions = null;
+ this.optionRegistry = new LegacyMapBasedOptionRegistry(true, criticalCustomOptions,
+ StandardOptionRegistry.getDefaultOptionRegistry());
+ }
+
+ /**
+ * Create data parser with provided option registry.
+ *
+ * @param optionRegistry option registry. {@code null} to use
+ * {@link StandardOptionRegistry#getDefaultOptionRegistry()}
+ * @since 3.8
+ */
+ protected DataParser(OptionRegistry optionRegistry) {
+ if (optionRegistry == null) {
+ optionRegistry = StandardOptionRegistry.getDefaultOptionRegistry();
}
+ this.optionRegistry = optionRegistry;
}
/**
@@ -218,9 +222,11 @@ protected void assertValidOptions(OptionSet options) {
* @return {@code true}, if option number is a critical custom option,
* {@code false}, if not.
* @since 3.4
+ * @deprecated
*/
+ @Deprecated
protected boolean isCiriticalCustomOption(int optionNumber) {
- return Arrays.binarySearch(criticalCustomOptions, optionNumber) >= 0;
+ return false;
}
/**
@@ -241,6 +247,7 @@ public void parseOptionsAndPayload(DatagramReader reader, Message message) {
if (message == null) {
throw new NullPointerException("message must not be null!");
}
+ int code = message.getRawCode();
int currentOptionNumber = 0;
byte nextByte = 0;
OptionSet optionSet = message.getOptions();
@@ -262,7 +269,7 @@ public void parseOptionsAndPayload(DatagramReader reader, Message message) {
// read option
if (reader.bytesAvailable(optionLength)) {
byte[] value = reader.readBytes(optionLength);
- Option option = createOption(message, currentOptionNumber, value);
+ Option option = createOption(code, currentOptionNumber, value);
if (option != null) {
optionSet.addOption(option);
}
@@ -315,6 +322,7 @@ public void parseOptionsAndPayload(DatagramReader reader, Message message) {
* Malformed CON-responses are always rejected and malformed NON-messages
* are always ignored.
*
+ * @param code message code
* @param optionNumber option number
* @param value option value
* @return create option, or {@code null}, to ignore this option. Please
@@ -325,18 +333,19 @@ public void parseOptionsAndPayload(DatagramReader reader, Message message) {
* @throws IllegalArgumentException if the option is a critical custom
* option or the value doesn't match the option's specification.
* @throws NullPointerException if provided value is {@code null}
- * @since 3.7
+ * @see Message#getRawCode()
+ * @see Option#getNumber()
+ * @since 3.8 (add parameter code)
*/
- public Option createOption(Message message, int optionNumber, byte[] value) {
- if (criticalCustomOptions != null && OptionNumberRegistry.isCritical(optionNumber)
- && OptionNumberRegistry.isCustomOption(optionNumber)) {
- if (!isCiriticalCustomOption(optionNumber)) {
- throw new IllegalArgumentException("Unknown critical option " + optionNumber);
- }
+ public Option createOption(int code, int optionNumber, byte[] value) {
+ OptionDefinition definition = optionRegistry.getDefinitionByNumber(code, optionNumber);
+ if (definition != null) {
+ return definition.create(value);
+ } else if (OptionNumberRegistry.isCritical(optionNumber)) {
+ throw new IllegalArgumentException("Unknown critical option " + optionNumber + " is not supported!");
+ } else {
+ return null;
}
- Option option = new Option(optionNumber);
- option.setValue(value);
- return option;
}
/**
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/network/serialization/DataSerializer.java b/californium-core/src/main/java/org/eclipse/californium/core/network/serialization/DataSerializer.java
index 5e35a5bb9b..970dcb89a4 100644
--- a/californium-core/src/main/java/org/eclipse/californium/core/network/serialization/DataSerializer.java
+++ b/californium-core/src/main/java/org/eclipse/californium/core/network/serialization/DataSerializer.java
@@ -204,8 +204,7 @@ public final RawData serializeEmptyMessage(final EmptyMessage emptyMessage, fina
* @since 2.6
*/
protected void serializeEmpytMessage(DatagramWriter writer, Message message) {
- MessageHeader header = new MessageHeader(CoAP.VERSION, message.getType(), message.getToken(), 0,
- message.getMID(), 0);
+ MessageHeader header = new MessageHeader(CoAP.VERSION, message.getType(), Token.EMPTY, 0, message.getMID(), 0);
serializeHeader(writer, header);
writer.writeCurrentByte();
}
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/network/serialization/TcpDataParser.java b/californium-core/src/main/java/org/eclipse/californium/core/network/serialization/TcpDataParser.java
index 50b69b342f..c7df2a3a42 100644
--- a/californium-core/src/main/java/org/eclipse/californium/core/network/serialization/TcpDataParser.java
+++ b/californium-core/src/main/java/org/eclipse/californium/core/network/serialization/TcpDataParser.java
@@ -23,19 +23,20 @@
******************************************************************************/
package org.eclipse.californium.core.network.serialization;
+import static org.eclipse.californium.core.coap.CoAP.MessageFormat.CODE_BITS;
+import static org.eclipse.californium.core.coap.CoAP.MessageFormat.LENGTH_NIBBLE_BITS;
+import static org.eclipse.californium.core.coap.CoAP.MessageFormat.TOKEN_LENGTH_BITS;
+
import org.eclipse.californium.core.coap.CoAP;
-import org.eclipse.californium.core.coap.CoAP.SignalingCode;
import org.eclipse.californium.core.coap.Message;
import org.eclipse.californium.core.coap.MessageFormatException;
-import org.eclipse.californium.core.coap.Option;
import org.eclipse.californium.core.coap.OptionNumberRegistry;
import org.eclipse.californium.core.coap.SignalingMessage;
-import org.eclipse.californium.core.coap.SignalingOption;
import org.eclipse.californium.core.coap.Token;
+import org.eclipse.californium.core.coap.option.OptionRegistry;
+import org.eclipse.californium.core.coap.option.StandardOptionRegistry;
import org.eclipse.californium.elements.util.DatagramReader;
-import static org.eclipse.californium.core.coap.CoAP.MessageFormat.*;
-
/**
* A parser for messages encoded following the encoding defined by the
* RFC7252, Section 4.1 defines:
+ *
+ *
+ * An Empty message has the Code field set to 0.00. The Token Length
+ * field MUST be set to 0 and bytes of data MUST NOT be present after
+ * the Message ID field. If there are any bytes, they MUST be processed
+ * as a message format error.
+ *
+ *
+ * @param strictEmptyMessageFormat {@code true}, to process messages with
+ * code {@code 0} strictly according RFC7252, 4.1.,
+ * {@code false}, to relax the MUST in a not compliant way!
+ * @param optionRegistry option registry. {@code null} to use
+ * {@link StandardOptionRegistry#getDefaultOptionRegistry()}
+ * @since 3.8
+ */
+ public UdpDataParser(boolean strictEmptyMessageFormat, OptionRegistry optionRegistry) {
+ super(optionRegistry);
+ this.strictEmptyMessageFormat = strictEmptyMessageFormat;
+ }
+
@Override
protected MessageHeader parseHeader(final DatagramReader reader) {
if (!reader.bytesAvailable(4)) {
@@ -126,7 +157,7 @@ protected MessageHeader parseHeader(final DatagramReader reader) {
throw new CoAPMessageFormatException("UDP Message too short for token! " + (reader.bitsLeft() / Byte.SIZE)
+ " must be at least " + tokenLength + " bytes!", null, mid, code, confirmable);
}
- Token token = Token.fromProvider(reader.readBytes(tokenLength));
+ Token token = Token.fromProvider(reader.readBytes(tokenLength));
return new MessageHeader(version, type, token, code, mid, 0);
}
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/network/stack/CapabilitiesSettingsLayer.java b/californium-core/src/main/java/org/eclipse/californium/core/network/stack/CapabilitiesSettingsLayer.java
index f67104649f..12e4175386 100644
--- a/californium-core/src/main/java/org/eclipse/californium/core/network/stack/CapabilitiesSettingsLayer.java
+++ b/californium-core/src/main/java/org/eclipse/californium/core/network/stack/CapabilitiesSettingsLayer.java
@@ -1,13 +1,13 @@
package org.eclipse.californium.core.network.stack;
import org.eclipse.californium.core.coap.CoAP.SignalingCode;
-import org.eclipse.californium.core.network.Exchange;
+import org.eclipse.californium.core.coap.option.SignalingOptionRegistry;
+import org.eclipse.californium.core.coap.Option;
import org.eclipse.californium.core.coap.OptionSet;
import org.eclipse.californium.core.coap.Request;
import org.eclipse.californium.core.coap.Response;
import org.eclipse.californium.core.coap.SignalingMessage;
-import org.eclipse.californium.core.coap.SignalingOption;
-import org.eclipse.californium.core.coap.SignalingOptionNumberRegistry;
+import org.eclipse.californium.core.network.Exchange;
import org.eclipse.californium.elements.EndpointContext;
import org.eclipse.californium.elements.util.Bytes;
import org.slf4j.Logger;
@@ -46,12 +46,10 @@ public void sendResponse(Exchange exchange, Response response) {
public void connected(EndpointContext context) {
SignalingMessage cms = new SignalingMessage(SignalingCode.CSM);
- SignalingOption max_message_size = new SignalingOption(SignalingCode.CSM, SignalingOptionNumberRegistry.MAX_MESSAGE_SIZE);
// TODO use max message size from config ?
- max_message_size.setIntegerValue(1152);
+ Option max_message_size = SignalingOptionRegistry.MAX_MESSAGE_SIZE.create(1152);
+ Option block_wise_transfer = SignalingOptionRegistry.BLOCK_WISE_TRANSFER.create(Bytes.EMPTY);
- SignalingOption block_wise_transfer = new SignalingOption(SignalingCode.CSM, SignalingOptionNumberRegistry.BLOCK_WISE_TRANSFER);
- block_wise_transfer.setValue(Bytes.EMPTY);
cms.setOptions(new OptionSet().addOptions(max_message_size, block_wise_transfer));
cms.setDestinationContext(context);
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/network/stack/CongestionControlLayer.java b/californium-core/src/main/java/org/eclipse/californium/core/network/stack/CongestionControlLayer.java
index fa154ed44f..a37c080e50 100644
--- a/californium-core/src/main/java/org/eclipse/californium/core/network/stack/CongestionControlLayer.java
+++ b/californium-core/src/main/java/org/eclipse/californium/core/network/stack/CongestionControlLayer.java
@@ -44,6 +44,7 @@
import org.eclipse.californium.core.network.stack.congestioncontrol.LinuxRto;
import org.eclipse.californium.core.network.stack.congestioncontrol.PeakhopperRto;
import org.eclipse.californium.core.observe.ObserveRelation;
+import org.eclipse.californium.elements.EndpointIdentityResolver;
import org.eclipse.californium.elements.config.Configuration;
import org.eclipse.californium.elements.util.LeastRecentlyUsedCache;
@@ -124,7 +125,7 @@ public abstract class CongestionControlLayer extends ReliabilityLayer {
private final static int MAX_RTO = 60000;
/** The map of remote endpoints */
- private LeastRecentlyUsedCache remoteEndpoints;
+ private LeastRecentlyUsedCache remoteEndpoints;
/** The configuration */
protected final Configuration config;
@@ -134,6 +135,14 @@ public abstract class CongestionControlLayer extends ReliabilityLayer {
*/
protected final String tag;
+ /**
+ * Use inet-address for congestion control.
+ *
+ * @see CoapConfig#CONGESTION_CONTROL_USE_INET_ADDRESS
+ * @since 3.8
+ */
+ private final boolean useInetSocketAddress;
+
// In CoAP, dithering is applied to the initial RTO of a transmission;
// set to true to apply dithering
private boolean appliesDithering;
@@ -156,6 +165,7 @@ public CongestionControlLayer(String tag, Configuration config) {
this.remoteEndpoints = new LeastRecentlyUsedCache<>(config.get(CoapConfig.MAX_ACTIVE_PEERS),
config.get(CoapConfig.MAX_PEER_INACTIVITY_PERIOD, TimeUnit.SECONDS));
this.remoteEndpoints.setEvictingOnReadAccess(false);
+ this.useInetSocketAddress = config.get(CoapConfig.CONGESTION_CONTROL_USE_INET_ADDRESS);
setDithering(false);
}
@@ -181,10 +191,13 @@ public void destroy() {
/**
* Create new, algorithm specific remote endpoint.
*
- * @param remoteSocketAddress peer to create the endpoint for.
+ * @param peersIdentity peer's identity. Usually that's the peer's
+ * {@link InetSocketAddress}.
* @return create endpoint.
+ * @see EndpointIdentityResolver
+ * @since 3.8 (exchanged InetSocketAddress to Object)
*/
- protected abstract RemoteEndpoint createRemoteEndpoint(InetSocketAddress remoteSocketAddress);
+ protected abstract RemoteEndpoint createRemoteEndpoint(Object peersIdentity);
/**
* Get remote endpoint.
@@ -193,21 +206,21 @@ public void destroy() {
*
* @param exchange to get the endpoint for
* @return endpoint for exchange.
- * @see #createRemoteEndpoint(InetSocketAddress)
+ * @see #createRemoteEndpoint(Object)
+ * @see #useInetSocketAddress
*/
protected RemoteEndpoint getRemoteEndpoint(Exchange exchange) {
- Message message;
- if (exchange.isOfLocalOrigin()) {
- message = exchange.getCurrentRequest();
+ Object peersIdentity;
+ if (useInetSocketAddress) {
+ peersIdentity = exchange.getRemoteSocketAddress();
} else {
- message = exchange.getCurrentResponse();
+ peersIdentity = exchange.getPeersIdentity();
}
- InetSocketAddress remoteSocketAddress = message.getDestinationContext().getPeerAddress();
synchronized (remoteEndpoints) {
- RemoteEndpoint remoteEndpoint = remoteEndpoints.get(remoteSocketAddress);
+ RemoteEndpoint remoteEndpoint = remoteEndpoints.get(peersIdentity);
if (remoteEndpoint == null) {
- remoteEndpoint = createRemoteEndpoint(remoteSocketAddress);
- remoteEndpoints.put(remoteSocketAddress, remoteEndpoint);
+ remoteEndpoint = createRemoteEndpoint(peersIdentity);
+ remoteEndpoints.put(peersIdentity, remoteEndpoint);
}
return remoteEndpoint;
}
@@ -262,14 +275,16 @@ public RtoType getExchangeEstimatorState(Exchange exchange) {
* response is postponed and put into a queue.
*/
private boolean processResponse(RemoteEndpoint endpoint, Exchange exchange, Response response) {
- Type messageType = response.getType();
+
+ exchange.setCurrentResponse(response);
if (!response.isNotification()) {
- if (messageType == Type.CON) {
+ if (response.isConfirmable()) {
return checkNSTART(endpoint, exchange);
} else {
return true;
}
}
+
// Check, if there's space in the notifies queue
int size;
boolean start = false;
@@ -306,16 +321,16 @@ private boolean processResponse(RemoteEndpoint endpoint, Exchange exchange, Resp
private boolean checkNSTART(RemoteEndpoint endpoint, Exchange exchange) {
boolean send = false;
boolean queued = false;
- Type type;
+ Message message;
String messageType;
Queue queue;
if (exchange.isOfLocalOrigin()) {
messageType = "req.-";
- type = exchange.getCurrentRequest().getType();
+ message = exchange.getCurrentRequest();
queue = endpoint.getRequestQueue();
} else {
messageType = "resp.-";
- type = exchange.getCurrentResponse().getType();
+ message = exchange.getCurrentResponse();
queue = endpoint.getResponseQueue();
}
int size;
@@ -333,16 +348,8 @@ private boolean checkNSTART(RemoteEndpoint endpoint, Exchange exchange) {
}
}
if (send) {
- Message message;
- if (exchange.isOfLocalOrigin()) {
- // it's a request
- message = exchange.getCurrentRequest();
- } else {
- // it's a response
- message = exchange.getCurrentResponse();
- }
message.addMessageObserver(new TimeoutTask(endpoint, exchange));
- LOGGER.trace("{}send {}{}", tag, messageType, type);
+ LOGGER.trace("{}send {}{}", tag, messageType, message.getType());
if (statistic != null) {
statistic.sendRequest();
}
@@ -352,7 +359,7 @@ private boolean checkNSTART(RemoteEndpoint endpoint, Exchange exchange) {
statistic.queueRequest();
}
} else {
- LOGGER.debug("{}drop {}{}, queue full {}", tag, messageType, type, size);
+ LOGGER.debug("{}drop {}{}, queue full {}", tag, messageType, message.getType(), size);
}
return false;
}
@@ -465,6 +472,7 @@ public void sendRequest(Exchange exchange, Request request) {
// process ReliabilityLayer
prepareRequest(exchange, request);
RemoteEndpoint endpoint = getRemoteEndpoint(exchange);
+ exchange.setCurrentRequest(request);
if (checkNSTART(endpoint, exchange)) {
endpoint.checkAging();
LOGGER.debug("{}send request", tag);
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/network/stack/RemoteEndpoint.java b/californium-core/src/main/java/org/eclipse/californium/core/network/stack/RemoteEndpoint.java
index 0ecfdba02c..8be5200411 100644
--- a/californium-core/src/main/java/org/eclipse/californium/core/network/stack/RemoteEndpoint.java
+++ b/californium-core/src/main/java/org/eclipse/californium/core/network/stack/RemoteEndpoint.java
@@ -26,6 +26,7 @@
import org.eclipse.californium.core.network.Exchange;
import org.eclipse.californium.core.network.stack.CongestionControlLayer.PostponedExchange;
import org.eclipse.californium.core.network.stack.congestioncontrol.Cocoa;
+import org.eclipse.californium.elements.EndpointIdentityResolver;
/**
* An abstract class representing the current transmissions and parameters for a
@@ -59,9 +60,12 @@ public enum RtoType {
}
/**
- * Inet socket address of remote endpoint.
+ * The identity of the remote endpoint.
+ *
+ * @see EndpointIdentityResolver
+ * @since 3.8
*/
- private final InetSocketAddress remoteAddress;
+ private final Object peersIdentity;
/**
* Maximum number of concurrent transmissions.
*/
@@ -105,8 +109,21 @@ public enum RtoType {
*/
protected long meanOverallRTO;
- public RemoteEndpoint(InetSocketAddress remoteAddress, int ackTimeout, int nstart, boolean usesBlindEstimator) {
- this.remoteAddress = remoteAddress;
+ /**
+ * Create a remote endpoint.
+ *
+ * @param peersIdentity peer's identity. Usually that's the peer's
+ * {@link InetSocketAddress}.
+ * @param ackTimeout ACK timeout
+ * @param nstart NSTARt
+ * @param usesBlindEstimator {@code true}, if blind estimator is used. A
+ * blind estimation is based on pending exchanges until these
+ * changes are completed.
+ * @see EndpointIdentityResolver
+ * @since 3.8 (exchanged InetSocketAddress to Object)
+ */
+ public RemoteEndpoint(Object peersIdentity, int ackTimeout, int nstart, boolean usesBlindEstimator) {
+ this.peersIdentity = peersIdentity;
this.nstart = nstart;
this.usesBlindEstimator = usesBlindEstimator;
// Fill Array with initial values
@@ -128,12 +145,14 @@ public RemoteEndpoint(InetSocketAddress remoteAddress, int ackTimeout, int nstar
}
/**
- * Get address of remote endpoint.
+ * Get identity of the remote endpoint.
*
- * @return address of remote endpoint
+ * @return identity of the remote endpoint
+ * @see EndpointIdentityResolver
+ * @since 3.8
*/
- public InetSocketAddress getRemoteAddress() {
- return remoteAddress;
+ public Object getPeersIdentity() {
+ return peersIdentity;
}
/**
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/network/stack/congestioncontrol/BasicRto.java b/californium-core/src/main/java/org/eclipse/californium/core/network/stack/congestioncontrol/BasicRto.java
index 03a0dd69f6..96d9d24eed 100644
--- a/californium-core/src/main/java/org/eclipse/californium/core/network/stack/congestioncontrol/BasicRto.java
+++ b/californium-core/src/main/java/org/eclipse/californium/core/network/stack/congestioncontrol/BasicRto.java
@@ -17,8 +17,6 @@
package org.eclipse.californium.core.network.stack.congestioncontrol;
-import java.net.InetSocketAddress;
-
import org.eclipse.californium.core.network.stack.CongestionControlLayer;
import org.eclipse.californium.core.network.stack.RemoteEndpoint;
import org.eclipse.californium.elements.config.Configuration;
@@ -29,8 +27,9 @@ public BasicRto(String tag, Configuration config) {
super(tag, config);
}
- protected RemoteEndpoint createRemoteEndpoint(InetSocketAddress remoteSocketAddress) {
- return new RemoteEndpoint(remoteSocketAddress, defaultReliabilityLayerParameters.getAckTimeout(),
+ @Override
+ protected RemoteEndpoint createRemoteEndpoint(Object peersIdentity) {
+ return new RemoteEndpoint(peersIdentity, defaultReliabilityLayerParameters.getAckTimeout(),
defaultReliabilityLayerParameters.getNstart(), false) {
@Override
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/network/stack/congestioncontrol/Cocoa.java b/californium-core/src/main/java/org/eclipse/californium/core/network/stack/congestioncontrol/Cocoa.java
index 541551847e..497233151a 100644
--- a/californium-core/src/main/java/org/eclipse/californium/core/network/stack/congestioncontrol/Cocoa.java
+++ b/californium-core/src/main/java/org/eclipse/californium/core/network/stack/congestioncontrol/Cocoa.java
@@ -17,7 +17,6 @@
package org.eclipse.californium.core.network.stack.congestioncontrol;
-import java.net.InetSocketAddress;
import java.util.concurrent.TimeUnit;
import org.eclipse.californium.core.network.stack.CongestionControlLayer;
@@ -53,8 +52,8 @@ public Cocoa(String tag, Configuration config, boolean strong) {
}
@Override
- protected RemoteEndpoint createRemoteEndpoint(InetSocketAddress remoteSocketAddress) {
- return new CocoaRemoteEndpoint(remoteSocketAddress, defaultReliabilityLayerParameters.getAckTimeout(),
+ protected RemoteEndpoint createRemoteEndpoint(Object peersIdentity) {
+ return new CocoaRemoteEndpoint(peersIdentity, defaultReliabilityLayerParameters.getAckTimeout(),
defaultReliabilityLayerParameters.getNstart(), strong);
}
@@ -82,8 +81,8 @@ private static class CocoaRemoteEndpoint extends RemoteEndpoint {
private Rto strongRto;
private long nanoTimestamp;
- private CocoaRemoteEndpoint(InetSocketAddress remoteAddress, int ackTimeout, int nstart, boolean strong) {
- super(remoteAddress, ackTimeout, nstart, true);
+ private CocoaRemoteEndpoint(Object peersIdentity, int ackTimeout, int nstart, boolean strong) {
+ super(peersIdentity, ackTimeout, nstart, true);
this.onlyStrong = strong;
this.weakRto = new Rto(KWEAK, ackTimeout);
this.strongRto = new Rto(KSTRONG, ackTimeout);
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/network/stack/congestioncontrol/LinuxRto.java b/californium-core/src/main/java/org/eclipse/californium/core/network/stack/congestioncontrol/LinuxRto.java
index 423f9143ec..6fa4b681ae 100644
--- a/californium-core/src/main/java/org/eclipse/californium/core/network/stack/congestioncontrol/LinuxRto.java
+++ b/californium-core/src/main/java/org/eclipse/californium/core/network/stack/congestioncontrol/LinuxRto.java
@@ -17,8 +17,6 @@
package org.eclipse.californium.core.network.stack.congestioncontrol;
-import java.net.InetSocketAddress;
-
import org.eclipse.californium.core.network.stack.CongestionControlLayer;
import org.eclipse.californium.core.network.stack.RemoteEndpoint;
import org.eclipse.californium.elements.config.Configuration;
@@ -30,8 +28,8 @@ public LinuxRto(String tag, Configuration config) {
}
@Override
- protected RemoteEndpoint createRemoteEndpoint(InetSocketAddress remoteSocketAddress) {
- return new LinuxRemoteEndpoint(remoteSocketAddress, defaultReliabilityLayerParameters.getAckTimeout(),
+ protected RemoteEndpoint createRemoteEndpoint(Object peersIdentity) {
+ return new LinuxRemoteEndpoint(peersIdentity, defaultReliabilityLayerParameters.getAckTimeout(),
defaultReliabilityLayerParameters.getNstart());
}
@@ -43,8 +41,8 @@ private static class LinuxRemoteEndpoint extends RemoteEndpoint {
private long mdev;
private long mdev_max;
- private LinuxRemoteEndpoint(InetSocketAddress remoteAddress, int ackTimeout, int nstart) {
- super(remoteAddress, ackTimeout, nstart, true);
+ private LinuxRemoteEndpoint(Object peersIdentity, int ackTimeout, int nstart) {
+ super(peersIdentity, ackTimeout, nstart, true);
}
private void initializeRTOEstimators(long measuredRTT) {
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/network/stack/congestioncontrol/PeakhopperRto.java b/californium-core/src/main/java/org/eclipse/californium/core/network/stack/congestioncontrol/PeakhopperRto.java
index 90c2db0826..233f83913c 100644
--- a/californium-core/src/main/java/org/eclipse/californium/core/network/stack/congestioncontrol/PeakhopperRto.java
+++ b/californium-core/src/main/java/org/eclipse/californium/core/network/stack/congestioncontrol/PeakhopperRto.java
@@ -17,8 +17,6 @@
package org.eclipse.californium.core.network.stack.congestioncontrol;
-import java.net.InetSocketAddress;
-
import org.eclipse.californium.core.network.stack.CongestionControlLayer;
import org.eclipse.californium.core.network.stack.RemoteEndpoint;
import org.eclipse.californium.elements.config.Configuration;
@@ -30,8 +28,8 @@ public PeakhopperRto(String tag, Configuration config) {
}
@Override
- protected RemoteEndpoint createRemoteEndpoint(InetSocketAddress remoteSocketAddress) {
- return new PeakhopperRemoteEndoint(remoteSocketAddress, defaultReliabilityLayerParameters.getAckTimeout(),
+ protected RemoteEndpoint createRemoteEndpoint(Object peersIdentity) {
+ return new PeakhopperRemoteEndoint(peersIdentity, defaultReliabilityLayerParameters.getAckTimeout(),
defaultReliabilityLayerParameters.getNstart());
}
@@ -50,8 +48,8 @@ private static class PeakhopperRemoteEndoint extends RemoteEndpoint {
private long[] RTT_sample = new long[RTT_HISTORY_SIZE];
private int currentRtt;
- private PeakhopperRemoteEndoint(InetSocketAddress remoteAddress, int ackTimeout, int nstart) {
- super(remoteAddress, ackTimeout, nstart, true);
+ private PeakhopperRemoteEndoint(Object peersIdentity, int ackTimeout, int nstart) {
+ super(peersIdentity, ackTimeout, nstart, true);
}
private void initializeRTOEstimators(long measuredRTT) {
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/observe/ObserveNotificationOrderer.java b/californium-core/src/main/java/org/eclipse/californium/core/observe/ObserveNotificationOrderer.java
index ee885316a4..05a2bff6e3 100644
--- a/californium-core/src/main/java/org/eclipse/californium/core/observe/ObserveNotificationOrderer.java
+++ b/californium-core/src/main/java/org/eclipse/californium/core/observe/ObserveNotificationOrderer.java
@@ -111,4 +111,15 @@ public synchronized boolean isNew(Response response) {
return false;
}
}
+
+ /**
+ * Reset state.
+ *
+ * @since 3.8
+ */
+ public synchronized void reset() {
+ number.set(0);
+ nanoTimestamp = 0;
+ }
+
}
diff --git a/californium-core/src/main/java/org/eclipse/californium/core/observe/ObserveStatisticLogger.java b/californium-core/src/main/java/org/eclipse/californium/core/observe/ObserveStatisticLogger.java
index a80b64cbf0..dbc34f31d1 100644
--- a/californium-core/src/main/java/org/eclipse/californium/core/observe/ObserveStatisticLogger.java
+++ b/californium-core/src/main/java/org/eclipse/californium/core/observe/ObserveStatisticLogger.java
@@ -65,7 +65,7 @@ public void dump() {
try {
if (isEnabled()) {
if (LOGGER.isDebugEnabled()) {
- if (observes.isUsed()) {
+ if (observeRequests.isUsed()) {
StringBuilder log = new StringBuilder();
String eol = StringUtil.lineSeparator();
String head = " " + tag;
@@ -74,7 +74,7 @@ public void dump() {
log.append(head).append(endpoints).append(eol);
log.append(head).append(observeRequests).append(eol);
log.append(head).append(cancelRequests).append(eol);
- log.append(tag).append(rejectedNotifies);
+ log.append(head).append(rejectedNotifies);
LOGGER.debug("{}", log);
}
}
diff --git a/californium-core/src/test/java/org/eclipse/californium/core/coap/CoapTest.java b/californium-core/src/test/java/org/eclipse/californium/core/coap/CoapTest.java
index d5c160d941..230d3a10ce 100644
--- a/californium-core/src/test/java/org/eclipse/californium/core/coap/CoapTest.java
+++ b/californium-core/src/test/java/org/eclipse/californium/core/coap/CoapTest.java
@@ -17,6 +17,7 @@
* Daniel Pauli - parsers and initial implementation
* Kai Hudalla - logging
* Achim Kraus (Bosch Software Innovations GmbH) - add more tests
+ * Rogier Cobben - add signaling code
******************************************************************************/
package org.eclipse.californium.core.coap;
@@ -30,6 +31,7 @@
import org.eclipse.californium.core.coap.CoAP.CodeClass;
import org.eclipse.californium.core.coap.CoAP.MessageFormat;
import org.eclipse.californium.core.coap.CoAP.ResponseCode;
+import org.eclipse.californium.core.coap.CoAP.SignalingCode;
import org.eclipse.californium.core.coap.CoAP.Type;
import org.eclipse.californium.elements.category.Small;
import org.eclipse.californium.elements.rule.TestNameLoggerRule;
@@ -42,6 +44,7 @@
*/
@Category(Small.class)
public class CoapTest {
+
@Rule
public TestNameLoggerRule name = new TestNameLoggerRule();
@@ -77,6 +80,15 @@ public void testResponseCode() {
}
}
+ @Test
+ public void testSignalingCode() {
+ for (SignalingCode code : SignalingCode.values()) {
+ assertEquals(code, SignalingCode.valueOf(code.value));
+ assertTrue(MessageFormat.SIGNALING_MESSAGE_CODE_LOWER_BOUND <= code.value);
+ assertTrue(code.value <= MessageFormat.SIGNALING_MESSAGE_CODE_UPPER_BOUND);
+ }
+ }
+
@Test
public void testGetCodeClass() {
for (Code code : Code.values()) {
@@ -89,13 +101,19 @@ public void testGetCodeClass() {
// errors
assertThat(CoAP.getCodeClass(ResponseCode.BAD_REQUEST.value), is(CodeClass.ERROR_RESPONSE.value));
assertThat(CoAP.getCodeClass(ResponseCode.CONFLICT.value), is(CodeClass.ERROR_RESPONSE.value));
- assertThat(CoAP.getCodeClass(ResponseCode.UNSUPPORTED_CONTENT_FORMAT.value), is(CodeClass.ERROR_RESPONSE.value));
+ assertThat(CoAP.getCodeClass(ResponseCode.UNSUPPORTED_CONTENT_FORMAT.value),
+ is(CodeClass.ERROR_RESPONSE.value));
assertThat(CoAP.getCodeClass(ResponseCode.UNPROCESSABLE_ENTITY.value), is(CodeClass.ERROR_RESPONSE.value));
// server errors
assertThat(CoAP.getCodeClass(ResponseCode.INTERNAL_SERVER_ERROR.value),
is(CodeClass.SERVER_ERROR_RESPONSE.value));
assertThat(CoAP.getCodeClass(ResponseCode.NOT_IMPLEMENTED.value), is(CodeClass.SERVER_ERROR_RESPONSE.value));
- assertThat(CoAP.getCodeClass(ResponseCode.SERVICE_UNAVAILABLE.value), is(CodeClass.SERVER_ERROR_RESPONSE.value));
+ assertThat(CoAP.getCodeClass(ResponseCode.SERVICE_UNAVAILABLE.value),
+ is(CodeClass.SERVER_ERROR_RESPONSE.value));
+ // signaling
+ for (SignalingCode code : SignalingCode.values()) {
+ assertThat(CoAP.getCodeClass(code.value), is(CodeClass.SIGNAL.value));
+ }
}
@Test
@@ -118,6 +136,12 @@ public void testGetCodeDetail() {
assertThat(CoAP.getCodeDetail(ResponseCode.INTERNAL_SERVER_ERROR.value), is(0));
assertThat(CoAP.getCodeDetail(ResponseCode.NOT_IMPLEMENTED.value), is(1));
assertThat(CoAP.getCodeDetail(ResponseCode.SERVICE_UNAVAILABLE.value), is(3));
+ // signaling
+ assertThat(CoAP.getCodeDetail(SignalingCode.CSM.value), is(1));
+ assertThat(CoAP.getCodeDetail(SignalingCode.PING.value), is(2));
+ assertThat(CoAP.getCodeDetail(SignalingCode.PONG.value), is(3));
+ assertThat(CoAP.getCodeDetail(SignalingCode.RELEASE.value), is(4));
+ assertThat(CoAP.getCodeDetail(SignalingCode.ABORT.value), is(5));
}
@Test
@@ -142,6 +166,12 @@ public void testFormatCode() {
assertThat(CoAP.formatCode(ResponseCode.INTERNAL_SERVER_ERROR.value), is("5.00"));
assertThat(CoAP.formatCode(ResponseCode.NOT_IMPLEMENTED.value), is("5.01"));
assertThat(CoAP.formatCode(ResponseCode.SERVICE_UNAVAILABLE.value), is("5.03"));
+ // signaling
+ assertThat(CoAP.formatCode(SignalingCode.CSM.value), is("7.01"));
+ assertThat(CoAP.formatCode(SignalingCode.PING.value), is("7.02"));
+ assertThat(CoAP.formatCode(SignalingCode.PONG.value), is("7.03"));
+ assertThat(CoAP.formatCode(SignalingCode.RELEASE.value), is("7.04"));
+ assertThat(CoAP.formatCode(SignalingCode.ABORT.value), is("7.05"));
}
@Test
diff --git a/californium-core/src/test/java/org/eclipse/californium/core/coap/TestOption.java b/californium-core/src/test/java/org/eclipse/californium/core/coap/TestOption.java
index 9ebcaa3cea..fc73bb463a 100644
--- a/californium-core/src/test/java/org/eclipse/californium/core/coap/TestOption.java
+++ b/californium-core/src/test/java/org/eclipse/californium/core/coap/TestOption.java
@@ -24,6 +24,7 @@
import java.util.Arrays;
+import org.eclipse.californium.core.coap.option.OptionDefinition;
import org.eclipse.californium.core.network.serialization.DataSerializer;
import org.eclipse.californium.core.network.serialization.MessageHeader;
import org.eclipse.californium.elements.util.DatagramWriter;
@@ -41,13 +42,29 @@ public final class TestOption {
* @param number option number
* @param length value length
* @return created option
+ * @deprecated use {@link #newOption(OptionDefinition, int)} instead
*/
+ @Deprecated
public static Option newOption(int number, int length) {
byte[] value = new byte[length];
Arrays.fill(value, (byte) 'p');
return new Option(number).setValueUnchecked(value);
}
+ /**
+ * Create option with unchecked value.
+ *
+ * @param defintion option definition.
+ * @param length value length
+ * @return created option
+ * @since 3.8
+ */
+ public static Option newOption(OptionDefinition definition, int length) {
+ byte[] value = new byte[length];
+ Arrays.fill(value, (byte) 'p');
+ return new Option(definition).setValueUnchecked(value);
+ }
+
/**
* Test {@link DataSerializer} to serialize malformed messages for tests.
*/
diff --git a/californium-core/src/test/java/org/eclipse/californium/core/network/serialization/DataParserTest.java b/californium-core/src/test/java/org/eclipse/californium/core/network/serialization/DataParserTest.java
index 66929b55b7..fead3fe3b6 100644
--- a/californium-core/src/test/java/org/eclipse/californium/core/network/serialization/DataParserTest.java
+++ b/californium-core/src/test/java/org/eclipse/californium/core/network/serialization/DataParserTest.java
@@ -43,6 +43,11 @@
import org.eclipse.californium.core.coap.OptionNumberRegistry;
import org.eclipse.californium.core.coap.OptionNumberRegistry.CustomOptionNumberRegistry;
import org.eclipse.californium.core.coap.OptionNumberRegistry.OptionFormat;
+import org.eclipse.californium.core.coap.option.IntegerOptionDefinition;
+import org.eclipse.californium.core.coap.option.MapBasedOptionRegistry;
+import org.eclipse.californium.core.coap.option.OptionRegistry;
+import org.eclipse.californium.core.coap.option.StandardOptionRegistry;
+import org.eclipse.californium.core.coap.option.StringOptionDefinition;
import org.eclipse.californium.core.coap.Request;
import org.eclipse.californium.core.coap.Response;
import org.eclipse.californium.core.coap.Token;
@@ -64,6 +69,7 @@
*/
@Category(Small.class)
@RunWith(Parameterized.class)
+@SuppressWarnings("deprecation")
public class DataParserTest {
private static final InetSocketAddress CONNECTOR = new InetSocketAddress(InetAddress.getLoopbackAddress(), 3000);
@@ -72,93 +78,111 @@ public class DataParserTest {
private static final int CUSTOM_OPTION_1 = 57453;
private static final int CUSTOM_OPTION_2 = 19205;
private static final int[] CRITICAL_CUSTOM_OPTIONS = { CUSTOM_OPTION_1, CUSTOM_OPTION_2 };
+ private static final CustomOptionNumberRegistry CUSTOM = new CustomOptionNumberRegistry() {
+
+ @Override
+ public String toString(int optionNumber) {
+ switch (optionNumber) {
+ case CUSTOM_OPTION_1 :
+ return "custom1";
+ case CUSTOM_OPTION_2 :
+ return "custom2";
+ }
+ return null;
+ }
+
+ @Override
+ public int toNumber(String name) {
+ if ("custom1".equals(name)) {
+ return CUSTOM_OPTION_1;
+ } else if ("custom2".equals(name)) {
+ return CUSTOM_OPTION_2;
+ }
+ return OptionNumberRegistry.UNKNOWN;
+ }
+
+ @Override
+ public boolean isSingleValue(int optionNumber) {
+ return optionNumber != CUSTOM_OPTION_2;
+ }
+
+ @Override
+ public OptionFormat getFormatByNr(int optionNumber) {
+ switch (optionNumber) {
+ case CUSTOM_OPTION_1 :
+ return OptionFormat.INTEGER;
+ case CUSTOM_OPTION_2 :
+ return OptionFormat.STRING;
+ }
+ return null;
+ }
+
+ @Override
+ public int[] getCriticalCustomOptions() {
+ return CRITICAL_CUSTOM_OPTIONS;
+ }
+
+ @Override
+ public int[] getValueLengths(int optionNumber) {
+ switch (optionNumber) {
+ case CUSTOM_OPTION_1 :
+ return new int[] {0, 4};
+ case CUSTOM_OPTION_2 :
+ return new int[] {0, 64};
+ }
+ return null;
+ }
+
+ @Override
+ public void assertValue(int optionNumber, long value) {
+ }
+ };
+
+ private static final IntegerOptionDefinition CUSTOM_1 = new IntegerOptionDefinition(CUSTOM_OPTION_1, "custom1", true, 0, 4);
+ private static final StringOptionDefinition CUSTOM_2 = new StringOptionDefinition(CUSTOM_OPTION_2, "custom2", false, 0, 64);
+
@Rule
public CoapThreadsRule cleanup = new CoapThreadsRule();
private final DataSerializer serializer;
private final DataParser parser;
+ private final OptionRegistry registry;
private final boolean tcp;
private final int expectedMid;
- public DataParserTest(DataSerializer serializer, DataParser parser, boolean tcp) {
+ public DataParserTest(DataSerializer serializer, DataParser parser, OptionRegistry registry, boolean tcp) {
this.serializer = serializer;
this.parser = parser;
+ this.registry = registry;
this.tcp = tcp;
this.expectedMid = tcp ? Message.NONE : 13 ;
+ if (registry == null) {
+ OptionNumberRegistry.setCustomOptionNumberRegistry(CUSTOM);
+ }
}
-
+
@After
public void tearDown() {
((CustomDataParser)parser).setIgnoreOptionError(false);
((CustomDataParser)parser).setOptionException(null);
+ OptionNumberRegistry.setCustomOptionNumberRegistry(null);
+ StandardOptionRegistry.setDefaultOptionRegistry(null);
}
@Parameterized.Parameters public static List parameters() {
- CustomOptionNumberRegistry custom = new CustomOptionNumberRegistry() {
-
- @Override
- public String toString(int optionNumber) {
- switch (optionNumber) {
- case CUSTOM_OPTION_1 :
- return "custom1";
- case CUSTOM_OPTION_2 :
- return "custom2";
- }
- return null;
- }
-
- @Override
- public int toNumber(String name) {
- if ("custom1".equals(name)) {
- return CUSTOM_OPTION_1;
- } else if ("custom2".equals(name)) {
- return CUSTOM_OPTION_2;
- }
- return OptionNumberRegistry.UNKNOWN;
- }
-
- @Override
- public boolean isSingleValue(int optionNumber) {
- return optionNumber == CUSTOM_OPTION_1;
- }
-
- @Override
- public OptionFormat getFormatByNr(int optionNumber) {
- switch (optionNumber) {
- case CUSTOM_OPTION_1 :
- return OptionFormat.INTEGER;
- case CUSTOM_OPTION_2 :
- return OptionFormat.STRING;
- }
- return null;
- }
-
- @Override
- public int[] getCriticalCustomOptions() {
- return CRITICAL_CUSTOM_OPTIONS;
- }
-
- @Override
- public int[] getValueLengths(int optionNumber) {
- switch (optionNumber) {
- case CUSTOM_OPTION_1 :
- return new int[] {0, 4};
- case CUSTOM_OPTION_2 :
- return new int[] {0, 64};
- }
- return null;
- }
-
- @Override
- public void assertValue(int optionNumber, long value) {
- }
- };
- OptionNumberRegistry.setCustomOptionNumberRegistry(custom);
+
+ // Default, if "criticalCustomOptions" is "null"
+ OptionNumberRegistry.setCustomOptionNumberRegistry(CUSTOM);
+
List parameters = new ArrayList<>();
- parameters.add(new Object[] { new UdpDataSerializer(), new CustomUdpDataParser(true, CRITICAL_CUSTOM_OPTIONS), false });
- parameters.add(new Object[] { new TcpDataSerializer(), new CustomTcpDataParser(CRITICAL_CUSTOM_OPTIONS), true });
- parameters.add(new Object[] { new UdpDataSerializer(), new CustomUdpDataParser(true, null), false });
+ parameters.add(new Object[] { new UdpDataSerializer(), new CustomUdpDataParser(true, CRITICAL_CUSTOM_OPTIONS), null, false });
+ parameters.add(new Object[] { new TcpDataSerializer(), new CustomTcpDataParser(CRITICAL_CUSTOM_OPTIONS), null, true });
+ parameters.add(new Object[] { new UdpDataSerializer(), new CustomUdpDataParser(true), null, false });
+ OptionNumberRegistry.setCustomOptionNumberRegistry(null);
+ MapBasedOptionRegistry registry = new MapBasedOptionRegistry(StandardOptionRegistry.getDefaultOptionRegistry(),
+ CUSTOM_1, CUSTOM_2);
+ parameters.add(new Object[] { new UdpDataSerializer(), new CustomUdpDataParser(true, registry), registry, false });
return parameters;
}
@@ -363,10 +387,17 @@ public void assertValue(int optionNumber, long value) {
response.setType(Type.NON);
response.setMID(expectedMid);
response.setToken(new byte[] { 22, -1, 0, 78, 100, 22 });
- response.getOptions().addETag(new byte[] { 1, 0, 0, 0, 0, 1 })
+ if (registry != null) {
+ response.getOptions().addETag(new byte[] { 1, 0, 0, 0, 0, 1 })
.addLocationPath("/one/two/three/four/five/six/seven/eight/nine/ten")
- .addOption(new Option(57453, "Arbitrary".hashCode())).addOption(new Option(19205, "Arbitrary1"))
- .addOption(new Option(19205, "Arbitrary2")).addOption(new Option(19205, "Arbitrary3"));
+ .addOption(new Option(CUSTOM_1, 1234567)).addOption(new Option(CUSTOM_2, "Arbitrary1"))
+ .addOption(new Option(CUSTOM_2, "Arbitrary2")).addOption(new Option(CUSTOM_2, "Arbitrary3"));
+ } else {
+ response.getOptions().addETag(new byte[] { 1, 0, 0, 0, 0, 1 })
+ .addLocationPath("/one/two/three/four/five/six/seven/eight/nine/ten")
+ .addOption(new Option(CUSTOM_OPTION_1, 1234567)).addOption(new Option(CUSTOM_OPTION_2, "Arbitrary1"))
+ .addOption(new Option(CUSTOM_OPTION_2, "Arbitrary2")).addOption(new Option(CUSTOM_OPTION_2, "Arbitrary3"));
+ }
RawData rawData = serializer.serializeResponse(response);
rawData = receive(rawData, CONNECTOR);
@@ -374,6 +405,8 @@ public void assertValue(int optionNumber, long value) {
Response result = (Response) parser.parseMessage(rawData);
assertEquals(response.getMID(), result.getMID());
assertEquals(response.getToken(), result.getToken());
+ response.getOptions().asSortedList();
+ result.getOptions().asSortedList();
assertEquals(response.getOptions().asSortedList(), result.getOptions().asSortedList());
}
@@ -409,9 +442,19 @@ public interface CustomDataParser {
public static class CustomUdpDataParser extends UdpDataParser implements CustomDataParser {
private boolean ignoreOptionError;
private RuntimeException optionError;
+
+ public CustomUdpDataParser(boolean strictEmptyMessageFormat) {
+ super(strictEmptyMessageFormat, (OptionRegistry) null);
+ }
+
public CustomUdpDataParser(boolean strictEmptyMessageFormat, int[] criticalCustomOptions) {
super(strictEmptyMessageFormat, criticalCustomOptions);
}
+
+ public CustomUdpDataParser(boolean strictEmptyMessageFormat, OptionRegistry optionRegistry) {
+ super(strictEmptyMessageFormat, optionRegistry);
+ }
+
@Override
public void setIgnoreOptionError(boolean ignore) {
this.ignoreOptionError = ignore;
@@ -420,14 +463,14 @@ public void setIgnoreOptionError(boolean ignore) {
public void setOptionException(RuntimeException optionError) {
this.optionError = optionError;
}
-
+
@Override
- public Option createOption(Message message, int optionNumber, byte[] value) {
+ public Option createOption(int code, int optionNumber, byte[] value) {
if (optionError != null) {
throw optionError;
}
try {
- return super.createOption(message, optionNumber, value);
+ return super.createOption(code, optionNumber, value);
} catch (RuntimeException ex) {
if (ignoreOptionError) {
return null;
@@ -454,12 +497,13 @@ public void setOptionException(RuntimeException optionError) {
this.optionError = optionError;
}
- public Option createOption(Message message, int optionNumber, byte[] value) {
+ @Override
+ public Option createOption(int code, int optionNumber, byte[] value) {
if (optionError != null) {
throw optionError;
}
try {
- return super.createOption(message, optionNumber, value);
+ return super.createOption(code, optionNumber, value);
} catch (RuntimeException ex) {
if (ignoreOptionError) {
return null;
diff --git a/californium-core/src/test/java/org/eclipse/californium/core/server/ServerMessageDelivererTest.java b/californium-core/src/test/java/org/eclipse/californium/core/server/ServerMessageDelivererTest.java
index 5d10c9f37c..f375106f80 100644
--- a/californium-core/src/test/java/org/eclipse/californium/core/server/ServerMessageDelivererTest.java
+++ b/californium-core/src/test/java/org/eclipse/californium/core/server/ServerMessageDelivererTest.java
@@ -33,6 +33,7 @@
import org.eclipse.californium.core.coap.Option;
import org.eclipse.californium.core.coap.Request;
import org.eclipse.californium.core.coap.Response;
+import org.eclipse.californium.core.coap.option.EmptyOptionDefinition;
import org.eclipse.californium.core.network.Exchange;
import org.eclipse.californium.core.network.Exchange.Origin;
import org.eclipse.californium.core.server.resources.Resource;
@@ -51,6 +52,8 @@
*/
@Category(Small.class)
public class ServerMessageDelivererTest {
+ public final EmptyOptionDefinition CUSTOM = new EmptyOptionDefinition(200, "Test");
+
@Rule
public CoapThreadsRule cleanup = new CoapThreadsRule();
@@ -115,7 +118,7 @@ public void testDeliverRequestProcessesRequestAfterPreDeliverRequest() {
// GIVEN a message deliverer subclass that adds a custom option to incoming
// requests
- final Option customOption = new Option(200);
+ final Option customOption = new Option(CUSTOM);
ServerMessageDeliverer deliverer = new ServerMessageDeliverer(rootResource, null) {
@Override
protected boolean preDeliverRequest(Exchange exchange) {
@@ -131,7 +134,7 @@ protected boolean preDeliverRequest(Exchange exchange) {
ArgumentCaptor exchangeCaptor = ArgumentCaptor.forClass(Exchange.class);
verify(rootResource).handleRequest(exchangeCaptor.capture());
// and the request contains the custom option
- assertTrue(exchangeCaptor.getValue().getRequest().getOptions().hasOption(200));
+ assertTrue(exchangeCaptor.getValue().getRequest().getOptions().hasOption(CUSTOM));
}
/**
@@ -170,7 +173,7 @@ public void testDeliverResponseProcessesResponseAfterPreDeliverResponse() {
@Override
protected boolean preDeliverResponse(Exchange exchange, Response response) {
- response.getOptions().addOption(new Option(200));
+ response.getOptions().addOption(new Option(CUSTOM));
return false;
}
};
@@ -181,6 +184,6 @@ protected boolean preDeliverResponse(Exchange exchange, Response response) {
// THEN the response is delivered to the request
assertNotNull(outboundRequest.getRequest().getResponse());
// and the response contains the custom option
- assertTrue(outboundRequest.getRequest().getResponse().getOptions().hasOption(200));
+ assertTrue(outboundRequest.getRequest().getResponse().getOptions().hasOption(CUSTOM));
}
}
diff --git a/californium-core/src/test/java/org/eclipse/californium/core/test/MaliciousClientTest.java b/californium-core/src/test/java/org/eclipse/californium/core/test/MaliciousClientTest.java
index 6c01aca029..8bea0fa052 100644
--- a/californium-core/src/test/java/org/eclipse/californium/core/test/MaliciousClientTest.java
+++ b/californium-core/src/test/java/org/eclipse/californium/core/test/MaliciousClientTest.java
@@ -33,10 +33,10 @@
import org.eclipse.californium.core.coap.CoAP.Type;
import org.eclipse.californium.core.coap.CoAPOptionException;
import org.eclipse.californium.core.coap.Message;
-import org.eclipse.californium.core.coap.OptionNumberRegistry;
import org.eclipse.californium.core.coap.Request;
import org.eclipse.californium.core.coap.Response;
import org.eclipse.californium.core.coap.TestOption;
+import org.eclipse.californium.core.coap.option.StandardOptionRegistry;
import org.eclipse.californium.core.network.CoapEndpoint;
import org.eclipse.californium.core.network.Endpoint;
import org.eclipse.californium.core.network.interceptors.HealthStatisticLogger;
@@ -110,7 +110,7 @@ public void cleanup() throws IOException {
@Test
public void testConRequestWithTooLongUri() throws Exception {
Request get = newGet();
- get.getOptions().addOtherOption(newOption(OptionNumberRegistry.URI_PATH, 256));
+ get.getOptions().addOtherOption(newOption(StandardOptionRegistry.URI_PATH, 256));
DataSerializer serializer = new UdpDataSerializer();
RawData rawData = serializer.serializeRequest(get);
@@ -133,7 +133,7 @@ public void testConRequestWithTooLongUri() throws Exception {
public void testConRequestWithTooLongUriIgnored() throws Exception {
serverParser.setIgnoreOptionError(true);
Request get = newGet();
- get.getOptions().addOtherOption(newOption(OptionNumberRegistry.URI_PATH, 256));
+ get.getOptions().addOtherOption(newOption(StandardOptionRegistry.URI_PATH, 256));
DataSerializer serializer = new UdpDataSerializer();
RawData rawData = serializer.serializeRequest(get);
@@ -156,7 +156,7 @@ public void testConRequestWithTooLongUriIgnored() throws Exception {
public void testConRequestWithTooLongUriNotFound() throws Exception {
serverParser.setOptionException(new CoAPOptionException("too long uri", ResponseCode.NOT_FOUND));
Request get = newGet();
- get.getOptions().addOtherOption(newOption(OptionNumberRegistry.URI_PATH, 256));
+ get.getOptions().addOtherOption(newOption(StandardOptionRegistry.URI_PATH, 256));
DataSerializer serializer = new UdpDataSerializer();
RawData rawData = serializer.serializeRequest(get);
@@ -179,7 +179,7 @@ public void testConRequestWithTooLongUriNotFound() throws Exception {
public void testConRequestWithTooLongUriRejected() throws Exception {
serverParser.setOptionException(new CoAPOptionException("too long uri, reject", null));
Request get = newGet();
- get.getOptions().addOtherOption(newOption(OptionNumberRegistry.URI_PATH, 256));
+ get.getOptions().addOtherOption(newOption(StandardOptionRegistry.URI_PATH, 256));
DataSerializer serializer = new UdpDataSerializer();
RawData rawData = serializer.serializeRequest(get);
@@ -202,7 +202,7 @@ public void testConRequestWithTooLongUriRejected() throws Exception {
public void testNonRequestWithTooLongUri() throws Exception {
Request get = newGet();
get.setConfirmable(false);
- get.getOptions().addOtherOption(newOption(OptionNumberRegistry.URI_PATH, 256));
+ get.getOptions().addOtherOption(newOption(StandardOptionRegistry.URI_PATH, 256));
DataSerializer serializer = new UdpDataSerializer();
RawData rawData = serializer.serializeRequest(get);
@@ -225,7 +225,7 @@ public void testNonRequestWithTooLongUriIgnored() throws Exception {
serverParser.setIgnoreOptionError(true);
Request get = newGet();
get.setConfirmable(false);
- get.getOptions().addOtherOption(newOption(OptionNumberRegistry.URI_PATH, 256));
+ get.getOptions().addOtherOption(newOption(StandardOptionRegistry.URI_PATH, 256));
DataSerializer serializer = new UdpDataSerializer();
RawData rawData = serializer.serializeRequest(get);
@@ -249,7 +249,7 @@ public void testNonRequestWithTooLongUriNotFoundDiscarded() throws Exception {
serverParser.setOptionException(new CoAPOptionException("too long uri", ResponseCode.NOT_FOUND));
Request get = newGet();
get.setConfirmable(false);
- get.getOptions().addOtherOption(newOption(OptionNumberRegistry.URI_PATH, 256));
+ get.getOptions().addOtherOption(newOption(StandardOptionRegistry.URI_PATH, 256));
DataSerializer serializer = new UdpDataSerializer();
RawData rawData = serializer.serializeRequest(get);
@@ -272,7 +272,7 @@ public void testNonRequestWithTooLongUriRejectDiscarded() throws Exception {
serverParser.setOptionException(new CoAPOptionException("too long uri", null));
Request get = newGet();
get.setConfirmable(false);
- get.getOptions().addOtherOption(newOption(OptionNumberRegistry.URI_PATH, 256));
+ get.getOptions().addOtherOption(newOption(StandardOptionRegistry.URI_PATH, 256));
DataSerializer serializer = new UdpDataSerializer();
RawData rawData = serializer.serializeRequest(get);
@@ -318,7 +318,7 @@ public void testBertRequest() throws Exception {
public void testConResponseWithTooLongLocation() throws Exception {
Response response = newResponse(ResponseCode.CONTENT);
response.setConfirmable(true);
- response.getOptions().addOtherOption(newOption(OptionNumberRegistry.LOCATION_PATH, 256));
+ response.getOptions().addOtherOption(newOption(StandardOptionRegistry.LOCATION_PATH, 256));
DataSerializer serializer = new UdpDataSerializer();
RawData rawData = serializer.serializeResponse(response);
@@ -341,7 +341,7 @@ public void testConResponseWithTooLongLocation() throws Exception {
public void testNonResponseWithTooLongLocation() throws Exception {
Response response = newResponse(ResponseCode.CONTENT);
response.setConfirmable(false);
- response.getOptions().addOtherOption(newOption(OptionNumberRegistry.LOCATION_PATH, 256));
+ response.getOptions().addOtherOption(newOption(StandardOptionRegistry.LOCATION_PATH, 256));
DataSerializer serializer = new UdpDataSerializer();
RawData rawData = serializer.serializeResponse(response);
@@ -363,7 +363,7 @@ public void testNonResponseWithTooLongLocation() throws Exception {
public void testPiggyBackedResponseWithTooLongLocation() throws Exception {
Response response = newResponse(ResponseCode.CONTENT);
response.setType(Type.ACK);
- response.getOptions().addOtherOption(newOption(OptionNumberRegistry.LOCATION_PATH, 256));
+ response.getOptions().addOtherOption(newOption(StandardOptionRegistry.LOCATION_PATH, 256));
DataSerializer serializer = new UdpDataSerializer();
RawData rawData = serializer.serializeResponse(response);
@@ -413,7 +413,7 @@ private static Message waitForMessage(long timeoutMillis) throws InterruptedExce
private static CoapServer createServer() throws IOException {
Configuration config = network.getStandardTestConfig();
- CustomUdpDataParser parser = new CustomUdpDataParser(true, null);
+ CustomUdpDataParser parser = new CustomUdpDataParser(true);
serverParser = parser;
diff --git a/californium-core/src/test/java/org/eclipse/californium/core/test/ObserveTest.java b/californium-core/src/test/java/org/eclipse/californium/core/test/ObserveTest.java
index b0a169296c..ba0b80eeb0 100644
--- a/californium-core/src/test/java/org/eclipse/californium/core/test/ObserveTest.java
+++ b/californium-core/src/test/java/org/eclipse/californium/core/test/ObserveTest.java
@@ -25,6 +25,7 @@
* use expected= annotation for
* expected exceptions
* Achim Kraus (Bosch Software Innovations GmbH) - use MessageInterceptorAdapter
+ * Rogier Cobben - non and con observe (re)register and cancel tests
******************************************************************************/
package org.eclipse.californium.core.test;
@@ -119,6 +120,7 @@
*/
@Category(Medium.class)
public class ObserveTest {
+
private static final Logger LOGGER = LoggerFactory.getLogger(ObserveTest.class);
@ClassRule
@@ -326,6 +328,166 @@ public void testConObserveDefaultMessageType() throws Exception {
assertEquals(Type.CON, rel.getCurrent().advanced().getType());
}
+ @Test
+ public void testConObserveCancelMessageType() throws Exception {
+
+ serverEndpoint.addInterceptor(new ServerMessageInterceptor());
+ resourceX.setObserveType(null);
+
+ CoapClient client = new CoapClient(uriX);
+ cleanup.add(client);
+ CountingCoapHandler handler = new CountingCoapHandler();
+ CoapObserveRelation rel = client.observeAndWait(handler);
+
+ // onLoad is called asynchronous to returning the response
+ // therefore wait for one onLoad
+ assertTrue(handler.waitOnLoadCalls(1, 1000, TimeUnit.MILLISECONDS));
+
+ assertFalse("Relation canceled", rel.isCanceled());
+ assertNotNull("Response not received", rel.getCurrent());
+ assertEquals("\"resX says hi for the 1 time\"", rel.getCurrent().getResponseText());
+ assertEquals(Type.ACK, rel.getCurrent().advanced().getType());
+
+ resourceX.changed("new");
+
+ assertTrue(handler.waitOnLoadCalls(2, 1000, TimeUnit.MILLISECONDS));
+
+ assertNotNull("Response not received", rel.getCurrent());
+ assertEquals("\"resX says new for the 2 time\"", rel.getCurrent().getResponseText());
+ assertEquals(Type.CON, rel.getCurrent().advanced().getType());
+
+ rel.proactiveCancel();
+
+ assertTrue(handler.waitOnLoadCalls(3, 1000, TimeUnit.MILLISECONDS));
+
+ assertTrue("Relation not canceled", rel.isCanceled());
+ assertNotNull("Response not received", rel.getCurrent());
+ assertEquals("\"resX says new for the 2 time\"", rel.getCurrent().getResponseText());
+ assertEquals(Type.ACK, rel.getCurrent().advanced().getType());
+ assertFalse(rel.getCurrent().advanced().isNotification());
+ }
+
+ @Test
+ public void testConObserveNonCancelMessageType() throws Exception {
+
+ serverEndpoint.addInterceptor(new ServerMessageInterceptor());
+ resourceX.setObserveType(null);
+
+ CoapClient client = new CoapClient(uriX);
+ cleanup.add(client);
+ CountingCoapHandler handler = new CountingCoapHandler();
+ CoapObserveRelation rel = client.observeAndWait(handler);
+
+ // onLoad is called asynchronous to returning the response
+ // therefore wait for one onLoad
+ assertTrue(handler.waitOnLoadCalls(1, 1000, TimeUnit.MILLISECONDS));
+
+ assertFalse("Relation canceled", rel.isCanceled());
+ assertNotNull("Response not received", rel.getCurrent());
+ assertEquals("\"resX says hi for the 1 time\"", rel.getCurrent().getResponseText());
+ assertEquals(Type.ACK, rel.getCurrent().advanced().getType());
+
+ resourceX.changed("new");
+
+ assertTrue(handler.waitOnLoadCalls(2, 1000, TimeUnit.MILLISECONDS));
+
+ assertNotNull("Response not received", rel.getCurrent());
+ assertEquals("\"resX says new for the 2 time\"", rel.getCurrent().getResponseText());
+ assertEquals(Type.CON, rel.getCurrent().advanced().getType());
+
+ rel.setConfirmable(false);
+ rel.proactiveCancel();
+
+ assertTrue(handler.waitOnLoadCalls(3, 1000, TimeUnit.MILLISECONDS));
+
+ assertTrue("Relation not canceled", rel.isCanceled());
+ assertNotNull("Response not received", rel.getCurrent());
+ assertEquals("\"resX says new for the 2 time\"", rel.getCurrent().getResponseText());
+ assertEquals(Type.NON, rel.getCurrent().advanced().getType());
+ assertFalse(rel.getCurrent().advanced().isNotification());
+ }
+
+ @Test
+ public void testNonObserveCancelMessageType() throws Exception {
+
+ serverEndpoint.addInterceptor(new ServerMessageInterceptor());
+ resourceX.setObserveType(null);
+
+ CoapClient client = new CoapClient(uriX);
+ client.useNONs();
+ cleanup.add(client);
+ CountingCoapHandler handler = new CountingCoapHandler();
+ CoapObserveRelation rel = client.observeAndWait(handler);
+
+ // onLoad is called asynchronous to returning the response
+ // therefore wait for one onLoad
+ assertTrue(handler.waitOnLoadCalls(1, 1000, TimeUnit.MILLISECONDS));
+
+ assertFalse("Relation canceled", rel.isCanceled());
+ assertNotNull("Response not received", rel.getCurrent());
+ assertEquals("\"resX says hi for the 1 time\"", rel.getCurrent().getResponseText());
+ assertEquals(Type.NON, rel.getCurrent().advanced().getType());
+
+ resourceX.changed("new");
+
+ assertTrue(handler.waitOnLoadCalls(2, 1000, TimeUnit.MILLISECONDS));
+
+ assertNotNull("Response not received", rel.getCurrent());
+ assertEquals("\"resX says new for the 2 time\"", rel.getCurrent().getResponseText());
+ assertEquals(Type.NON, rel.getCurrent().advanced().getType());
+
+ rel.proactiveCancel();
+
+ assertTrue(handler.waitOnLoadCalls(3, 1000, TimeUnit.MILLISECONDS));
+
+ assertTrue("Relation not canceled", rel.isCanceled());
+ assertNotNull("Response not received", rel.getCurrent());
+ assertEquals("\"resX says new for the 2 time\"", rel.getCurrent().getResponseText());
+ assertEquals(Type.NON, rel.getCurrent().advanced().getType());
+ assertFalse(rel.getCurrent().advanced().isNotification());
+ }
+
+ @Test
+ public void testNonObserveConCancelMessageType() throws Exception {
+
+ serverEndpoint.addInterceptor(new ServerMessageInterceptor());
+ resourceX.setObserveType(null);
+
+ CoapClient client = new CoapClient(uriX);
+ client.useNONs();
+ cleanup.add(client);
+ CountingCoapHandler handler = new CountingCoapHandler();
+ CoapObserveRelation rel = client.observeAndWait(handler);
+
+ // onLoad is called asynchronous to returning the response
+ // therefore wait for one onLoad
+ assertTrue(handler.waitOnLoadCalls(1, 1000, TimeUnit.MILLISECONDS));
+
+ assertFalse("Relation canceled", rel.isCanceled());
+ assertNotNull("Response not received", rel.getCurrent());
+ assertEquals("\"resX says hi for the 1 time\"", rel.getCurrent().getResponseText());
+ assertEquals(Type.NON, rel.getCurrent().advanced().getType());
+
+ resourceX.changed("new");
+
+ assertTrue(handler.waitOnLoadCalls(2, 1000, TimeUnit.MILLISECONDS));
+
+ assertNotNull("Response not received", rel.getCurrent());
+ assertEquals("\"resX says new for the 2 time\"", rel.getCurrent().getResponseText());
+ assertEquals(Type.NON, rel.getCurrent().advanced().getType());
+
+ rel.setConfirmable(true);
+ rel.proactiveCancel();
+
+ assertTrue(handler.waitOnLoadCalls(3, 1000, TimeUnit.MILLISECONDS));
+
+ assertTrue("Relation not canceled", rel.isCanceled());
+ assertNotNull("Response not received", rel.getCurrent());
+ assertEquals("\"resX says new for the 2 time\"", rel.getCurrent().getResponseText());
+ assertEquals(Type.ACK, rel.getCurrent().advanced().getType());
+ assertFalse(rel.getCurrent().advanced().isNotification());
+ }
+
@Test
public void testNonObserveDefaultMessageType() throws Exception {
@@ -468,7 +630,7 @@ public void testObserveClearWithSuccessResponse() throws Exception {
}
@Test
- public void testObserveClientReregister() throws Exception {
+ public void testConObserveClientReregister() throws Exception {
resourceX.setObserveType(Type.NON);
MessageObserverCounterMessageInterceptor interceptor = new MessageObserverCounterMessageInterceptor();
EndpointManager.getEndpointManager().getDefaultEndpoint().addInterceptor(interceptor);
@@ -511,6 +673,187 @@ public void testObserveClientReregister() throws Exception {
assertEquals("message observer leak", counter, interceptor.getMessageObserverCounter());
}
+ @Test
+ public void testNonObserveClientReregister() throws Exception {
+ resourceX.setObserveType(Type.NON);
+ MessageObserverCounterMessageInterceptor interceptor = new MessageObserverCounterMessageInterceptor();
+ EndpointManager.getEndpointManager().getDefaultEndpoint().addInterceptor(interceptor);
+
+ CoapClient client = new CoapClient(uriX);
+ client.useNONs();
+ cleanup.add(client);
+ CountingCoapHandler handler = new CountingCoapHandler();
+ CoapObserveRelation rel = client.observeAndWait(handler);
+
+ assertTrue(handler.waitOnLoadCalls(1, 1000, TimeUnit.MILLISECONDS));
+
+ assertFalse("Response not received", rel.isCanceled());
+ assertNotNull("Response not received", rel.getCurrent());
+ assertEquals("\"resX says hi for the 1 time\"", rel.getCurrent().getResponseText());
+ int counter = interceptor.getMessageObserverCounter();
+
+ resourceX.changed("client");
+ // assert notify received
+ assertTrue(handler.waitOnLoadCalls(2, 1000, TimeUnit.MILLISECONDS));
+ assertFalse(rel.isCanceled());
+ assertEquals("\"resX says client for the 2 time\"", rel.getCurrent().getResponseText());
+
+ rel.reregister();
+ assertFalse(rel.isCanceled());
+ // assert reregister succeeded
+ assertTrue(handler.waitOnLoadCalls(3, 1000, TimeUnit.MILLISECONDS));
+
+ LOGGER.info("{} reregistered", uriX);
+
+ assertFalse(rel.isCanceled());
+ // resource not changed
+ assertEquals("\"resX says client for the 2 time\"", rel.getCurrent().getResponseText());
+
+ resourceX.changed("new client");
+ // assert notify received after reregister
+ assertTrue(handler.waitOnLoadCalls(4, 1000, TimeUnit.MILLISECONDS));
+ assertEquals("\"resX says new client for the 3 time\"", rel.getCurrent().getResponseText());
+ assertEquals(1, resourceX.getObserverCount());
+
+ assertEquals("message observer leak", counter, interceptor.getMessageObserverCounter());
+ }
+
+ @Test
+ public void testConObserveClientNonReregister() throws Exception {
+ resourceX.setObserveType(Type.NON);
+ MessageObserverCounterMessageInterceptor interceptor = new MessageObserverCounterMessageInterceptor();
+ EndpointManager.getEndpointManager().getDefaultEndpoint().addInterceptor(interceptor);
+
+ CoapClient client = new CoapClient(uriX);
+ cleanup.add(client);
+ CountingCoapHandler handler = new CountingCoapHandler();
+ CoapObserveRelation rel = client.observeAndWait(handler);
+
+ assertTrue(handler.waitOnLoadCalls(1, 1000, TimeUnit.MILLISECONDS));
+
+ assertFalse("Response not received", rel.isCanceled());
+ assertNotNull("Response not received", rel.getCurrent());
+ assertEquals("\"resX says hi for the 1 time\"", rel.getCurrent().getResponseText());
+ assertEquals(Type.ACK, rel.getCurrent().advanced().getType());
+ int counter = interceptor.getMessageObserverCounter();
+
+ resourceX.changed("client");
+ // assert notify received
+ assertTrue(handler.waitOnLoadCalls(2, 1000, TimeUnit.MILLISECONDS));
+ assertFalse(rel.isCanceled());
+ assertEquals("\"resX says client for the 2 time\"", rel.getCurrent().getResponseText());
+ assertEquals(Type.NON, rel.getCurrent().advanced().getType());
+
+ rel.setConfirmable(false);
+ rel.reregister();
+ assertFalse(rel.isCanceled());
+ // assert reregister succeeded
+ assertTrue(handler.waitOnLoadCalls(3, 1000, TimeUnit.MILLISECONDS));
+
+ LOGGER.info("{} reregistered non-confirmable", uriX);
+
+ assertFalse(rel.isCanceled());
+ // resource not changed
+ assertEquals("\"resX says client for the 2 time\"", rel.getCurrent().getResponseText());
+ assertEquals(Type.NON, rel.getCurrent().advanced().getType());
+
+ resourceX.changed("new client");
+ // assert notify received after reregister
+ assertTrue(handler.waitOnLoadCalls(4, 1000, TimeUnit.MILLISECONDS));
+ assertEquals("\"resX says new client for the 3 time\"", rel.getCurrent().getResponseText());
+ assertEquals(Type.NON, rel.getCurrent().advanced().getType());
+ assertEquals(1, resourceX.getObserverCount());
+
+ rel.reregister();
+ assertFalse(rel.isCanceled());
+ // assert reregister succeeded
+ assertTrue(handler.waitOnLoadCalls(5, 1000, TimeUnit.MILLISECONDS));
+
+ LOGGER.info("{} reregistered confirmable", uriX);
+
+ assertFalse(rel.isCanceled());
+ // resource not changed
+ assertEquals("\"resX says new client for the 3 time\"", rel.getCurrent().getResponseText());
+ assertEquals(Type.NON, rel.getCurrent().advanced().getType());
+
+ resourceX.changed("new client");
+ // assert notify received after reregister
+ assertTrue(handler.waitOnLoadCalls(6, 1000, TimeUnit.MILLISECONDS));
+ assertEquals("\"resX says new client for the 4 time\"", rel.getCurrent().getResponseText());
+ assertEquals(Type.NON, rel.getCurrent().advanced().getType());
+ assertEquals(1, resourceX.getObserverCount());
+
+ // NON request results in one message-observer less (missing reliability
+ // layer observer).
+ assertEquals("message observer leak", counter - 1, interceptor.getMessageObserverCounter());
+ }
+
+ @Test
+ public void testNonObserveClientConReregister() throws Exception {
+ resourceX.setObserveType(Type.NON);
+ MessageObserverCounterMessageInterceptor interceptor = new MessageObserverCounterMessageInterceptor();
+ EndpointManager.getEndpointManager().getDefaultEndpoint().addInterceptor(interceptor);
+
+ CoapClient client = new CoapClient(uriX);
+ client.useNONs();
+ cleanup.add(client);
+ CountingCoapHandler handler = new CountingCoapHandler();
+ CoapObserveRelation rel = client.observeAndWait(handler);
+
+ assertTrue(handler.waitOnLoadCalls(1, 1000, TimeUnit.MILLISECONDS));
+
+ assertFalse("Response not received", rel.isCanceled());
+ assertNotNull("Response not received", rel.getCurrent());
+ assertEquals("\"resX says hi for the 1 time\"", rel.getCurrent().getResponseText());
+ int counter = interceptor.getMessageObserverCounter();
+
+ resourceX.changed("client");
+ // assert notify received
+ assertTrue(handler.waitOnLoadCalls(2, 1000, TimeUnit.MILLISECONDS));
+ assertFalse(rel.isCanceled());
+ assertEquals("\"resX says client for the 2 time\"", rel.getCurrent().getResponseText());
+
+ rel.setConfirmable(true);
+ rel.reregister();
+ assertFalse(rel.isCanceled());
+ // assert reregister succeeded
+ assertTrue(handler.waitOnLoadCalls(3, 1000, TimeUnit.MILLISECONDS));
+
+ LOGGER.info("{} reregistered", uriX);
+
+ assertFalse(rel.isCanceled());
+ // resource not changed
+ assertEquals("\"resX says client for the 2 time\"", rel.getCurrent().getResponseText());
+
+ resourceX.changed("new client");
+ // assert notify received after reregister
+ assertTrue(handler.waitOnLoadCalls(4, 1000, TimeUnit.MILLISECONDS));
+ assertEquals("\"resX says new client for the 3 time\"", rel.getCurrent().getResponseText());
+ assertEquals(1, resourceX.getObserverCount());
+
+ rel.reregister();
+ assertFalse(rel.isCanceled());
+ // assert reregister succeeded
+ assertTrue(handler.waitOnLoadCalls(5, 1000, TimeUnit.MILLISECONDS));
+
+ LOGGER.info("{} reregistered confirmable", uriX);
+
+ assertFalse(rel.isCanceled());
+ // resource not changed
+ assertEquals("\"resX says new client for the 3 time\"", rel.getCurrent().getResponseText());
+ assertEquals(Type.ACK, rel.getCurrent().advanced().getType());
+
+ resourceX.changed("new client");
+ // assert notify received after reregister
+ assertTrue(handler.waitOnLoadCalls(6, 1000, TimeUnit.MILLISECONDS));
+ assertEquals("\"resX says new client for the 4 time\"", rel.getCurrent().getResponseText());
+ assertEquals(Type.NON, rel.getCurrent().advanced().getType());
+ assertEquals(1, resourceX.getObserverCount());
+
+ // CON request results in extra message-observer from reliability layer.
+ assertEquals("message observer leak", counter + 1, interceptor.getMessageObserverCounter());
+ }
+
@Test(expected = IllegalStateException.class)
public void testObserveClientReregisterAfterReject() throws Exception {
resourceX.setObserveType(Type.NON);
@@ -549,7 +892,7 @@ public void testObserveClientReregisterBeforeTimeout() throws Exception {
CountingCoapHandler handler = new CountingCoapHandler();
CoapObserveRelation rel = client.observe(handler);
assertFalse("Timeout", rel.isCanceled());
- assertFalse("reregister not ignored", rel.reregister());
+ assertFalse("reregister not ignored", rel.reregister());
assertTrue(handler.waitOnLoadCalls(1, 1000, TimeUnit.MILLISECONDS));
resourceX.changed("client");
@@ -570,9 +913,9 @@ public void testObserveClientReregisterAfterReregister() throws Exception {
assertTrue(handler.waitOnLoadCalls(1, 1000, TimeUnit.MILLISECONDS));
resourceX.delayNextGet(100);
// one more onLoad call
- assertTrue("reregister not triggered", rel.reregister());
+ assertTrue("reregister not triggered", rel.reregister());
// one more onLoad call
- assertFalse("reregister not ignored", rel.reregister());
+ assertFalse("reregister not ignored", rel.reregister());
assertTrue(handler.waitOnLoadCalls(2, 1000, TimeUnit.MILLISECONDS));
// one more onLoad call
resourceX.changed("client");
@@ -616,10 +959,8 @@ public void testObserveExceptionHandling() throws Exception {
private CoapServer createServer() {
// retransmit constantly all 200 milliseconds
- Configuration config = network.createTestConfig()
- .set(CoapConfig.ACK_TIMEOUT, 200, TimeUnit.MILLISECONDS)
- .set(CoapConfig.ACK_INIT_RANDOM, 1f)
- .set(CoapConfig.ACK_TIMEOUT_SCALE, 1f);
+ Configuration config = network.createTestConfig().set(CoapConfig.ACK_TIMEOUT, 200, TimeUnit.MILLISECONDS)
+ .set(CoapConfig.ACK_INIT_RANDOM, 1f).set(CoapConfig.ACK_TIMEOUT_SCALE, 1f);
CoapEndpoint.Builder builder = new CoapEndpoint.Builder();
builder.setInetSocketAddress(TestTools.LOCALHOST_EPHEMERAL);
@@ -824,7 +1165,7 @@ public void prepareResponse(boolean init) {
}
}
-
+
/**
* An observation store that keeps all observations in-memory.
*/
@@ -832,7 +1173,7 @@ private static class MyObservationStore implements ObservationStore {
private final ConcurrentMap map = new ConcurrentHashMap<>();
private volatile AtomicReference exception = new AtomicReference();
-
+
public MyObservationStore() {
}
diff --git a/californium-core/src/test/java/org/eclipse/californium/core/test/OptionTest.java b/californium-core/src/test/java/org/eclipse/californium/core/test/OptionTest.java
index 4405557d00..0e45b9e0f8 100644
--- a/californium-core/src/test/java/org/eclipse/californium/core/test/OptionTest.java
+++ b/californium-core/src/test/java/org/eclipse/californium/core/test/OptionTest.java
@@ -32,14 +32,21 @@
import java.util.List;
import org.eclipse.californium.core.coap.CoAP.ResponseCode;
+import org.eclipse.californium.core.coap.OptionNumberRegistry.CustomOptionNumberRegistry;
+import org.eclipse.californium.core.coap.OptionNumberRegistry.OptionFormat;
import org.eclipse.californium.core.coap.MediaTypeRegistry;
import org.eclipse.californium.core.coap.NoResponseOption;
import org.eclipse.californium.core.coap.Option;
import org.eclipse.californium.core.coap.OptionNumberRegistry;
import org.eclipse.californium.core.coap.OptionSet;
+import org.eclipse.californium.core.coap.option.MapBasedOptionRegistry;
+import org.eclipse.californium.core.coap.option.SignalingOptionRegistry;
+import org.eclipse.californium.core.coap.option.StandardOptionRegistry;
+import org.eclipse.californium.core.coap.option.StringOptionDefinition;
import org.eclipse.californium.elements.category.Small;
import org.eclipse.californium.elements.rule.TestNameLoggerRule;
import org.eclipse.californium.elements.util.Bytes;
+import org.junit.After;
import org.junit.Rule;
import org.junit.Test;
import org.junit.experimental.categories.Category;
@@ -49,7 +56,10 @@
* integer and long values to byte arrays work properly.
*/
@Category(Small.class)
+@SuppressWarnings("deprecation")
public class OptionTest {
+ private static final int CUSTOM_OPTION_1 = 0xff1c;
+ private static final int CUSTOM_OPTION_2 = 0xff9c;
@Rule
public TestNameLoggerRule name = new TestNameLoggerRule();
@@ -77,6 +87,12 @@ public void testIsCritical() {
assertFalse(OptionNumberRegistry.isCritical(OptionNumberRegistry.SIZE1));
assertTrue(OptionNumberRegistry.isCritical(OptionNumberRegistry.OSCORE));
assertFalse(OptionNumberRegistry.isCritical(OptionNumberRegistry.NO_RESPONSE));
+ assertFalse(OptionNumberRegistry.isCritical(SignalingOptionRegistry.MAX_MESSAGE_SIZE.getNumber()));
+ assertFalse(OptionNumberRegistry.isCritical(SignalingOptionRegistry.BLOCK_WISE_TRANSFER.getNumber()));
+ assertFalse(OptionNumberRegistry.isCritical(SignalingOptionRegistry.CUSTODY.getNumber()));
+ assertFalse(OptionNumberRegistry.isCritical(SignalingOptionRegistry.ALTERNATIVE_ADDRESS.getNumber()));
+ assertFalse(OptionNumberRegistry.isCritical(SignalingOptionRegistry.HOLD_OFF.getNumber()));
+ assertFalse(OptionNumberRegistry.isCritical(SignalingOptionRegistry.BAD_CSM_OPTION.getNumber()));
}
@Test
@@ -102,6 +118,12 @@ public void testIsElective() {
assertTrue(OptionNumberRegistry.isElective(OptionNumberRegistry.SIZE1));
assertFalse(OptionNumberRegistry.isElective(OptionNumberRegistry.OSCORE));
assertTrue(OptionNumberRegistry.isElective(OptionNumberRegistry.NO_RESPONSE));
+ assertTrue(OptionNumberRegistry.isElective(SignalingOptionRegistry.MAX_MESSAGE_SIZE.getNumber()));
+ assertTrue(OptionNumberRegistry.isElective(SignalingOptionRegistry.BLOCK_WISE_TRANSFER.getNumber()));
+ assertTrue(OptionNumberRegistry.isElective(SignalingOptionRegistry.CUSTODY.getNumber()));
+ assertTrue(OptionNumberRegistry.isElective(SignalingOptionRegistry.ALTERNATIVE_ADDRESS.getNumber()));
+ assertTrue(OptionNumberRegistry.isElective(SignalingOptionRegistry.HOLD_OFF.getNumber()));
+ assertTrue(OptionNumberRegistry.isElective(SignalingOptionRegistry.BAD_CSM_OPTION.getNumber()));
}
@Test
@@ -496,13 +518,88 @@ public void testToString() {
}
@Test
+ public void testOthersCustomOptionNumberRegistry() {
+ final int[] CRITICAL_CUSTOM_OPTIONS = { CUSTOM_OPTION_1, CUSTOM_OPTION_2 };
+ final CustomOptionNumberRegistry CUSTOM = new CustomOptionNumberRegistry() {
+
+ @Override
+ public String toString(int optionNumber) {
+ switch (optionNumber) {
+ case CUSTOM_OPTION_1 :
+ return "custom1";
+ case CUSTOM_OPTION_2 :
+ return "custom2";
+ }
+ return null;
+ }
+
+ @Override
+ public int toNumber(String name) {
+ if ("custom1".equals(name)) {
+ return CUSTOM_OPTION_1;
+ } else if ("custom2".equals(name)) {
+ return CUSTOM_OPTION_2;
+ }
+ return OptionNumberRegistry.UNKNOWN;
+ }
+
+ @Override
+ public boolean isSingleValue(int optionNumber) {
+ return optionNumber != CUSTOM_OPTION_2;
+ }
+
+ @Override
+ public OptionFormat getFormatByNr(int optionNumber) {
+ switch (optionNumber) {
+ case CUSTOM_OPTION_1 :
+ case CUSTOM_OPTION_2 :
+ return OptionFormat.STRING;
+ }
+ return null;
+ }
+
+ @Override
+ public int[] getCriticalCustomOptions() {
+ return CRITICAL_CUSTOM_OPTIONS;
+ }
+
+ @Override
+ public int[] getValueLengths(int optionNumber) {
+ switch (optionNumber) {
+ case CUSTOM_OPTION_1 :
+ case CUSTOM_OPTION_2 :
+ return new int[] {0, 64};
+ }
+ return null;
+ }
+
+ @Override
+ public void assertValue(int optionNumber, long value) {
+ }
+ };
+
+ OptionNumberRegistry.setCustomOptionNumberRegistry(CUSTOM);
+ testOthers();
+ }
+
+ @Test
+ public void testOthersCustomOptionRegistry() {
+ StringOptionDefinition CUSTOM_1 = new StringOptionDefinition(CUSTOM_OPTION_1, "custom1", true, 0, 64);
+ StringOptionDefinition CUSTOM_2 = new StringOptionDefinition(CUSTOM_OPTION_2, "custom2", false, 0, 64);
+ MapBasedOptionRegistry registry = new MapBasedOptionRegistry(StandardOptionRegistry.getDefaultOptionRegistry(),
+ CUSTOM_1, CUSTOM_2);
+ StandardOptionRegistry.setDefaultOptionRegistry(registry);
+ testOthers();
+ }
+
public void testOthers() {
+
OptionSet options = new OptionSet();
- Option other1 = new Option(0xff1c, "other1");
+ Option other1 = new Option(CUSTOM_OPTION_1, "other1");
options.addOtherOption(other1);
- Option other2 = new Option(0xff9c, "other2");
+ Option other2 = new Option(CUSTOM_OPTION_2, "other2");
options.addOtherOption(other2);
- Option other3 = new Option(0xff9c, "other3");
+ Option other3 = new Option(CUSTOM_OPTION_2, "other3");
options.addOtherOption(other3);
Option port = new Option(OptionNumberRegistry.URI_PORT, 5684);
options.addOption(port);
@@ -525,7 +622,7 @@ public void testOthers() {
assertThat(list, not(hasItem(port)));
assertThat(list, not(hasItem(no)));
- list = options.getOthers(0xff1c);
+ list = options.getOthers(CUSTOM_OPTION_1);
assertThat(list.size(), is(1));
assertThat(list, hasItem(other1));
assertThat(list, not(hasItem(other2)));
@@ -533,8 +630,8 @@ public void testOthers() {
assertThat(list, not(hasItem(port)));
assertThat(list, not(hasItem(no)));
- assertThat(options.getOtherOption(0xff1c), is(other1));
- assertThat(options.getOtherOption(0xff9c), is(other2));
+ assertThat(options.getOtherOption(CUSTOM_OPTION_1), is(other1));
+ assertThat(options.getOtherOption(CUSTOM_OPTION_2), is(other2));
options.addOtherOption(other2);
options.clearOtherOption(other2);
@@ -555,4 +652,10 @@ public void testOthers() {
assertThat(list, not(hasItem(other3)));
}
+ @After
+ public void tearDown() {
+ OptionNumberRegistry.setCustomOptionNumberRegistry(null);
+ StandardOptionRegistry.setDefaultOptionRegistry(null);
+ }
+
}
diff --git a/californium-core/src/test/java/org/eclipse/californium/core/test/lockstep/BlockwiseClientSideTest.java b/californium-core/src/test/java/org/eclipse/californium/core/test/lockstep/BlockwiseClientSideTest.java
index a261a641a1..401057e1d2 100644
--- a/californium-core/src/test/java/org/eclipse/californium/core/test/lockstep/BlockwiseClientSideTest.java
+++ b/californium-core/src/test/java/org/eclipse/californium/core/test/lockstep/BlockwiseClientSideTest.java
@@ -43,7 +43,7 @@
import static org.eclipse.californium.core.coap.CoAP.ResponseCode.REQUEST_ENTITY_TOO_LARGE;
import static org.eclipse.californium.core.coap.CoAP.Type.ACK;
import static org.eclipse.californium.core.coap.CoAP.Type.CON;
-import static org.eclipse.californium.core.coap.OptionNumberRegistry.OBSERVE;
+import static org.eclipse.californium.core.coap.option.StandardOptionRegistry.OBSERVE;
import static org.eclipse.californium.core.test.MessageExchangeStoreTool.assertAllExchangesAreCompleted;
import static org.eclipse.californium.core.test.lockstep.IntegrationTestTools.assertNumberOfReceivedNotifications;
import static org.eclipse.californium.core.test.lockstep.IntegrationTestTools.assertResponseContainsExpectedPayload;
diff --git a/californium-core/src/test/java/org/eclipse/californium/core/test/lockstep/BlockwiseServerSideTest.java b/californium-core/src/test/java/org/eclipse/californium/core/test/lockstep/BlockwiseServerSideTest.java
index 38b52cd624..f235502321 100644
--- a/californium-core/src/test/java/org/eclipse/californium/core/test/lockstep/BlockwiseServerSideTest.java
+++ b/californium-core/src/test/java/org/eclipse/californium/core/test/lockstep/BlockwiseServerSideTest.java
@@ -43,7 +43,7 @@
import static org.eclipse.californium.core.coap.CoAP.Type.ACK;
import static org.eclipse.californium.core.coap.CoAP.Type.CON;
import static org.eclipse.californium.core.coap.CoAP.Type.NON;
-import static org.eclipse.californium.core.coap.OptionNumberRegistry.OBSERVE;
+import static org.eclipse.californium.core.coap.option.StandardOptionRegistry.OBSERVE;
import static org.eclipse.californium.core.test.MessageExchangeStoreTool.assertAllExchangesAreCompleted;
import static org.eclipse.californium.core.test.lockstep.IntegrationTestTools.createLockstepEndpoint;
import static org.eclipse.californium.core.test.lockstep.IntegrationTestTools.generateNextToken;
@@ -61,7 +61,6 @@
import org.eclipse.californium.core.CoapResource;
import org.eclipse.californium.core.CoapServer;
import org.eclipse.californium.core.coap.CoAP.ResponseCode;
-import org.eclipse.californium.core.coap.OptionNumberRegistry;
import org.eclipse.californium.core.coap.Request;
import org.eclipse.californium.core.coap.Response;
import org.eclipse.californium.core.config.CoapConfig;
@@ -69,6 +68,7 @@
import org.eclipse.californium.core.network.interceptors.MessageInterceptorAdapter;
import org.eclipse.californium.core.network.stack.BlockwiseLayer;
import org.eclipse.californium.core.coap.Token;
+import org.eclipse.californium.core.coap.option.StandardOptionRegistry;
import org.eclipse.californium.core.server.resources.CoapExchange;
import org.eclipse.californium.core.test.MessageExchangeStoreTool.CoapTestEndpoint;
import org.eclipse.californium.elements.EndpointContext;
@@ -945,7 +945,7 @@ public void testRandomAccessPUTAttemp() throws Exception {
Token tok = generateNextToken();
client.sendRequest(CON, PUT, tok, ++mid).path(RESOURCE_PATH).block1(2, true, 64).payload(reqtPayload.substring(2*64, 3*64)).go();
- client.expectResponse(ACK, REQUEST_ENTITY_INCOMPLETE, tok, mid).noOption(OptionNumberRegistry.BLOCK1).go();
+ client.expectResponse(ACK, REQUEST_ENTITY_INCOMPLETE, tok, mid).noOption(StandardOptionRegistry.BLOCK1).go();
Response response = serverInterceptor.getLastSentResponse();
assertThat(response, is(notNullValue()));
assertThat(response.isInternal(), is(true));
diff --git a/californium-core/src/test/java/org/eclipse/californium/core/test/lockstep/CongestionControlTest.java b/californium-core/src/test/java/org/eclipse/californium/core/test/lockstep/CongestionControlClientSideTest.java
similarity index 89%
rename from californium-core/src/test/java/org/eclipse/californium/core/test/lockstep/CongestionControlTest.java
rename to californium-core/src/test/java/org/eclipse/californium/core/test/lockstep/CongestionControlClientSideTest.java
index fa7d11961a..0e7a166c11 100644
--- a/californium-core/src/test/java/org/eclipse/californium/core/test/lockstep/CongestionControlTest.java
+++ b/californium-core/src/test/java/org/eclipse/californium/core/test/lockstep/CongestionControlClientSideTest.java
@@ -52,13 +52,9 @@
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/**
- * Test cases verifying the client side behavior of the examples from
- * RFC 7958, Section 3.
- */
@Category(Medium.class)
-public class CongestionControlTest {
- private static final Logger LOGGER = LoggerFactory.getLogger(CongestionControlTest.class);
+public class CongestionControlClientSideTest {
+ private static final Logger LOGGER = LoggerFactory.getLogger(CongestionControlClientSideTest.class);
@ClassRule
public static CoapNetworkRule network = new CoapNetworkRule(CoapNetworkRule.Mode.DIRECT, CoapNetworkRule.Mode.NATIVE);
@@ -73,10 +69,7 @@ public class CongestionControlTest {
private static final int TEST_EXCHANGE_LIFETIME = 247; // milliseconds
private static final int TEST_SWEEP_DEDUPLICATOR_INTERVAL = 100; // milliseconds
- private static final int TEST_BLOCKWISE_STATUS_INTERVAL = 50;
- private static final int TEST_BLOCKWISE_STATUS_LIFETIME = 300;
- private static final int MAX_RESOURCE_BODY_SIZE = 1024;
private static final int RESPONSE_TIMEOUT_IN_MS = 1000;
private static final int ERROR_TIMEOUT_IN_MS = 500;
// client retransmits after 200 ms
@@ -92,17 +85,12 @@ public class CongestionControlTest {
@Before
public void setup() throws Exception {
config = network.createStandardTestConfig()
- .set(CoapConfig.MAX_MESSAGE_SIZE, 128)
- .set(CoapConfig.PREFERRED_BLOCK_SIZE, 128)
- .set(CoapConfig.MAX_RESOURCE_BODY_SIZE, MAX_RESOURCE_BODY_SIZE)
.set(CoapConfig.MARK_AND_SWEEP_INTERVAL, TEST_SWEEP_DEDUPLICATOR_INTERVAL, TimeUnit.MILLISECONDS)
.set(CoapConfig.EXCHANGE_LIFETIME, TEST_EXCHANGE_LIFETIME, TimeUnit.MILLISECONDS)
.set(CoapConfig.ACK_TIMEOUT, ACK_TIMEOUT_IN_MS, TimeUnit.MILLISECONDS)
.set(CoapConfig.ACK_INIT_RANDOM, 1F)
.set(CoapConfig.MAX_RETRANSMIT, 2)
.set(CoapConfig.ACK_TIMEOUT_SCALE, 1F)
- .set(CoapConfig.BLOCKWISE_STATUS_INTERVAL, TEST_BLOCKWISE_STATUS_INTERVAL, TimeUnit.MILLISECONDS)
- .set(CoapConfig.BLOCKWISE_STATUS_LIFETIME, TEST_BLOCKWISE_STATUS_LIFETIME, TimeUnit.MILLISECONDS)
.set(CoapConfig.CONGESTION_CONTROL_ALGORITHM, CongestionControlMode.BASIC_RTO)
.set(CoapConfig.NSTART, 3);
@@ -144,6 +132,7 @@ public void testNstartLimit() throws Exception {
client.sendRequest(request3);
server.expectRequest(NON, GET, path).storeToken("C").go();
+ // NSTART 3 will postpone request 4
Request request4 = createRequest(GET, path, server);
request4.setType(NON);
client.sendRequest(request4);
diff --git a/californium-core/src/test/java/org/eclipse/californium/core/test/lockstep/CongestionControlServerSideTest.java b/californium-core/src/test/java/org/eclipse/californium/core/test/lockstep/CongestionControlServerSideTest.java
new file mode 100644
index 0000000000..8d5558e2d6
--- /dev/null
+++ b/californium-core/src/test/java/org/eclipse/californium/core/test/lockstep/CongestionControlServerSideTest.java
@@ -0,0 +1,246 @@
+/*******************************************************************************
+ * Copyright (c) 2022 Contributors to the Eclipse Foundation.
+ *
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * and Eclipse Distribution License v1.0 which accompany this distribution.
+ *
+ * The Eclipse Public License is available at
+ * http://www.eclipse.org/legal/epl-v20.html
+ * and the Eclipse Distribution License is available at
+ * http://www.eclipse.org/org/documents/edl-v10.html.
+ *
+ ******************************************************************************/
+package org.eclipse.californium.core.test.lockstep;
+
+import static org.eclipse.californium.TestTools.generateRandomPayload;
+import static org.eclipse.californium.core.coap.CoAP.Code.GET;
+import static org.eclipse.californium.core.coap.CoAP.ResponseCode.CONTENT;
+import static org.eclipse.californium.core.coap.CoAP.Type.ACK;
+import static org.eclipse.californium.core.coap.CoAP.Type.CON;
+import static org.eclipse.californium.core.test.MessageExchangeStoreTool.assertAllExchangesAreCompleted;
+import static org.eclipse.californium.core.test.lockstep.IntegrationTestTools.createLockstepEndpoint;
+import static org.eclipse.californium.core.test.lockstep.IntegrationTestTools.generateNextToken;
+import static org.eclipse.californium.core.test.lockstep.IntegrationTestTools.printServerLog;
+import static org.junit.Assert.assertNull;
+
+import java.net.InetSocketAddress;
+import java.util.concurrent.TimeUnit;
+
+import org.eclipse.californium.TestTools;
+import org.eclipse.californium.core.CoapResource;
+import org.eclipse.californium.core.CoapServer;
+import org.eclipse.californium.core.coap.Token;
+import org.eclipse.californium.core.coap.CoAP.ResponseCode;
+import org.eclipse.californium.core.config.CoapConfig;
+import org.eclipse.californium.core.config.CoapConfig.CongestionControlMode;
+import org.eclipse.californium.core.server.resources.CoapExchange;
+import org.eclipse.californium.core.test.MessageExchangeStoreTool.CoapTestEndpoint;
+import org.eclipse.californium.elements.category.Medium;
+import org.eclipse.californium.elements.config.Configuration;
+import org.eclipse.californium.elements.rule.TestNameLoggerRule;
+import org.eclipse.californium.elements.rule.TestTimeRule;
+import org.eclipse.californium.rule.CoapNetworkRule;
+import org.eclipse.californium.rule.CoapThreadsRule;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.ClassRule;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.experimental.categories.Category;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+@Category(Medium.class)
+public class CongestionControlServerSideTest {
+
+ private static final Logger LOGGER = LoggerFactory.getLogger(CongestionControlServerSideTest.class);
+ @ClassRule
+ public static CoapNetworkRule network = new CoapNetworkRule(CoapNetworkRule.Mode.DIRECT,
+ CoapNetworkRule.Mode.NATIVE);
+
+ @Rule
+ public CoapThreadsRule cleanup = new CoapThreadsRule();
+
+ @Rule
+ public TestTimeRule time = new TestTimeRule();
+
+ @Rule
+ public TestNameLoggerRule name = new TestNameLoggerRule();
+
+ private static final int TEST_EXCHANGE_LIFETIME = 247; // milliseconds
+ private static final int TEST_SWEEP_DEDUPLICATOR_INTERVAL = 100; // milliseconds
+
+ private static final int RESPONSE_TIMEOUT_IN_MS = 1000;
+ // client retransmits after 200 ms
+ private static final int ACK_TIMEOUT_IN_MS = 20000;
+
+ private static final String RESOURCE_PATH = "test";
+
+ private Configuration config;
+
+ private CoapServer server;
+ private CoapTestEndpoint serverEndpoint;
+ private LockstepEndpoint client;
+
+ private TestResource testResource;
+
+ private ServerBlockwiseInterceptor serverInterceptor = new ServerBlockwiseInterceptor();
+
+ @Before
+ public void setup() throws Exception {
+ config = network.createStandardTestConfig()
+ .set(CoapConfig.MARK_AND_SWEEP_INTERVAL, TEST_SWEEP_DEDUPLICATOR_INTERVAL, TimeUnit.MILLISECONDS)
+ .set(CoapConfig.EXCHANGE_LIFETIME, TEST_EXCHANGE_LIFETIME, TimeUnit.MILLISECONDS)
+ .set(CoapConfig.ACK_TIMEOUT, ACK_TIMEOUT_IN_MS, TimeUnit.MILLISECONDS)
+ .set(CoapConfig.ACK_INIT_RANDOM, 1F)
+ .set(CoapConfig.MAX_RETRANSMIT, 2)
+ .set(CoapConfig.ACK_TIMEOUT_SCALE, 1F)
+ .set(CoapConfig.CONGESTION_CONTROL_ALGORITHM, CongestionControlMode.BASIC_RTO)
+ .set(CoapConfig.NSTART, 3);
+
+ testResource = new TestResource(RESOURCE_PATH);
+
+ serverEndpoint = new CoapTestEndpoint(TestTools.LOCALHOST_EPHEMERAL, config);
+ serverEndpoint.addInterceptor(serverInterceptor);
+ server = new CoapServer(config);
+ server.addEndpoint(serverEndpoint);
+ server.add(testResource);
+ server.start();
+ cleanup.add(server);
+
+ InetSocketAddress serverAddress = serverEndpoint.getAddress();
+ LOGGER.info("Server binds to port {}", serverAddress.getPort());
+ client = createLockstepEndpoint(serverAddress, config);
+ cleanup.add(client);
+ }
+
+ @After
+ public void shutdown() {
+ try {
+ assertAllExchangesAreCompleted(serverEndpoint, time);
+ } finally {
+ printServerLog(serverInterceptor);
+ }
+ }
+
+ @Test
+ public void testNstartLimitSeparateResponse() throws Exception {
+ int mid = 1000;
+ String payload = generateRandomPayload(16);
+ Token tok = generateNextToken();
+
+ testResource.setSeparateResponse(true);
+ testResource.setPayload(payload);
+
+ // request 1
+ client.sendRequest(CON, GET, tok, ++mid).path(RESOURCE_PATH).go();
+ client.startMultiExpectation();
+ client.expectEmpty(ACK, mid).go();
+ client.expectSeparateResponse(CON, CONTENT, tok).storeMID("A").payload(payload).go();
+ client.goMultiExpectation();
+
+ payload = generateRandomPayload(16);
+ tok = generateNextToken();
+ testResource.setPayload(payload);
+
+ // request 2
+ client.sendRequest(CON, GET, tok, ++mid).path(RESOURCE_PATH).go();
+ client.startMultiExpectation();
+ client.expectEmpty(ACK, mid).go();
+ client.expectSeparateResponse(CON, CONTENT, tok).storeMID("B").payload(payload).go();
+ client.goMultiExpectation();
+
+ payload = generateRandomPayload(16);
+ tok = generateNextToken();
+ testResource.setPayload(payload);
+
+ // request 3
+ client.sendRequest(CON, GET, tok, ++mid).path(RESOURCE_PATH).go();
+ client.startMultiExpectation();
+ client.expectEmpty(ACK, mid).go();
+ client.expectSeparateResponse(CON, CONTENT, tok).storeMID("C").payload(payload).go();
+ client.goMultiExpectation();
+
+ payload = generateRandomPayload(16);
+ tok = generateNextToken();
+ testResource.setPayload(payload);
+
+ // request 4, NSTART 3 postpone response
+ client.sendRequest(CON, GET, tok, ++mid).path(RESOURCE_PATH).go();
+ client.expectEmpty(ACK, mid).go();
+
+ assertNull("send response exceeds nstart", client.receiveNextMessage(RESPONSE_TIMEOUT_IN_MS, TimeUnit.MILLISECONDS));
+
+ String payload2 = generateRandomPayload(16);
+ Token tok2 = generateNextToken();
+ testResource.setSeparateResponse(false);
+ testResource.setPayload(payload2);
+
+ // piggybacked response still send
+ client.sendRequest(CON, GET, tok2, ++mid).path(RESOURCE_PATH).go();
+ client.expectResponse(ACK, CONTENT, tok2, mid).payload(payload2).go();
+
+ // ACK for first response
+ client.sendEmpty(ACK).loadMID("A").go();
+
+ // delayed response for 4. request is sent
+ client.expectSeparateResponse(CON, CONTENT, tok).storeMID("D").payload(payload).go();
+
+ client.sendEmpty(ACK).loadMID("B").go();
+ client.sendEmpty(ACK).loadMID("C").go();
+ client.sendEmpty(ACK).loadMID("D").go();
+ }
+
+ @Test
+ public void testNstartLimitPiggyBacked() throws Exception {
+ int mid = 2000;
+ testResource.setSeparateResponse(false);
+ String payload = generateRandomPayload(16);
+ Token tok = generateNextToken();
+
+ testResource.setPayload(payload);
+
+ client.sendRequest(CON, GET, tok, ++mid).path(RESOURCE_PATH).go();
+ client.expectResponse(ACK, CONTENT, tok, mid).payload(payload).go();
+
+ payload = generateRandomPayload(16);
+ tok = generateNextToken();
+
+ testResource.setPayload(payload);
+
+ client.sendRequest(CON, GET, tok, ++mid).path(RESOURCE_PATH).go();
+ client.expectResponse(ACK, CONTENT, tok, mid).payload(payload).go();
+ }
+
+ // All tests are made with this resource
+ private class TestResource extends CoapResource {
+
+ private volatile boolean separateResponse;
+ private volatile String payload;
+
+ public TestResource(String name) {
+ super(name);
+ }
+
+ public void setSeparateResponse(boolean enable) {
+ this.separateResponse = enable;
+ }
+
+ public void setPayload(String payload) {
+ this.payload = payload;
+ }
+
+ public void handleGET(final CoapExchange exchange) {
+ respond(exchange, ResponseCode.CONTENT, payload);
+ }
+
+ private void respond(final CoapExchange exchange, final ResponseCode code, final String payload) {
+ if (separateResponse) {
+ exchange.accept();
+ }
+ exchange.respond(code, payload);
+ }
+ }
+
+}
diff --git a/californium-core/src/test/java/org/eclipse/californium/core/test/lockstep/LockstepEndpoint.java b/californium-core/src/test/java/org/eclipse/californium/core/test/lockstep/LockstepEndpoint.java
index d0dd7cf561..2d19e2f93f 100644
--- a/californium-core/src/test/java/org/eclipse/californium/core/test/lockstep/LockstepEndpoint.java
+++ b/californium-core/src/test/java/org/eclipse/californium/core/test/lockstep/LockstepEndpoint.java
@@ -79,10 +79,11 @@
import org.eclipse.californium.core.coap.EmptyMessage;
import org.eclipse.californium.core.coap.Message;
import org.eclipse.californium.core.coap.Option;
-import org.eclipse.californium.core.coap.OptionNumberRegistry;
import org.eclipse.californium.core.coap.Request;
import org.eclipse.californium.core.coap.Response;
import org.eclipse.californium.core.coap.Token;
+import org.eclipse.californium.core.coap.option.OptionDefinition;
+import org.eclipse.californium.core.coap.option.StandardOptionRegistry;
import org.eclipse.californium.core.network.serialization.DataParser;
import org.eclipse.californium.core.network.serialization.DataSerializer;
import org.eclipse.californium.core.network.serialization.UdpDataParser;
@@ -713,6 +714,7 @@ public String toString() {
return this;
}
+ @Deprecated
public MessageExpectation noOption(final int... numbers) {
expectations.add(new Expectation() {
@@ -733,9 +735,49 @@ public String toString() {
final int end = numbers.length - 1;
int index = 0;
for (; index < end; ++index) {
- result.append(OptionNumberRegistry.toString(numbers[index])).append(",");
+ result.append(getOption(numbers[index])).append(",");
}
- result.append(OptionNumberRegistry.toString(numbers[index]));
+ result.append(getOption(numbers[index]));
+ }
+ result.append(']');
+ return result.toString();
+ }
+
+ private String getOption(int optionNumber) {
+ OptionDefinition definition = StandardOptionRegistry.getDefaultOptionRegistry().getDefinitionByNumber(optionNumber);
+ if (definition != null) {
+ return definition.toString();
+ } else {
+ return String.format("Unknown (%d)", optionNumber);
+ }
+ }
+ });
+ return this;
+ }
+
+ public MessageExpectation noOption(final OptionDefinition... definitions) {
+ expectations.add(new Expectation() {
+
+ public void check(Message message) {
+ List options = message.getOptions().asSortedList();
+ for (Option option : options) {
+ for (OptionDefinition definition : definitions) {
+ if (definition.equals(option.getDefinition())) {
+ fail("Must not have option " + definition + " but has " + option);
+ }
+ }
+ }
+ }
+
+ public String toString() {
+ StringBuilder result = new StringBuilder("Expected no options: [");
+ if (0 < definitions.length) {
+ final int end = definitions.length - 1;
+ int index = 0;
+ for (; index < end; ++index) {
+ result.append(definitions[index]).append(",");
+ }
+ result.append(definitions[index]);
}
result.append(']');
return result.toString();
@@ -956,12 +998,19 @@ public RequestExpectation hasEtag(final byte[] etag) {
return this;
}
+ @Deprecated
@Override
public RequestExpectation noOption(final int... numbers) {
super.noOption(numbers);
return this;
}
+ @Override
+ public RequestExpectation noOption(final OptionDefinition... definitions) {
+ super.noOption(definitions);
+ return this;
+ }
+
@Override
public RequestExpectation storeMID(final String var) {
super.storeMID(var);
@@ -1134,12 +1183,19 @@ public String toString() {
return this;
}
+ @Deprecated
@Override
public ResponseExpectation noOption(final int... numbers) {
super.noOption(numbers);
return this;
}
+ @Override
+ public ResponseExpectation noOption(final OptionDefinition... definitions) {
+ super.noOption(definitions);
+ return this;
+ }
+
@Override
public ResponseExpectation storeMID(final String var) {
super.storeMID(var);
diff --git a/californium-core/src/test/java/org/eclipse/californium/core/test/lockstep/ObserveServerSideTest.java b/californium-core/src/test/java/org/eclipse/californium/core/test/lockstep/ObserveServerSideTest.java
index f89a64a5af..30703e2697 100644
--- a/californium-core/src/test/java/org/eclipse/californium/core/test/lockstep/ObserveServerSideTest.java
+++ b/californium-core/src/test/java/org/eclipse/californium/core/test/lockstep/ObserveServerSideTest.java
@@ -58,9 +58,9 @@
import org.eclipse.californium.core.CoapServer;
import org.eclipse.californium.core.coap.MessageObserver;
import org.eclipse.californium.core.coap.MessageObserverAdapter;
-import org.eclipse.californium.core.coap.OptionNumberRegistry;
import org.eclipse.californium.core.coap.Response;
import org.eclipse.californium.core.coap.Token;
+import org.eclipse.californium.core.coap.option.StandardOptionRegistry;
import org.eclipse.californium.core.config.CoapConfig;
import org.eclipse.californium.core.server.resources.CoapExchange;
import org.eclipse.californium.core.test.ErrorInjector;
@@ -320,7 +320,7 @@ public void testEstablishmentWithRestransmissionAndSeparateResponse() throws Exc
client.sendRequest(CON, GET, tok, ++mid).path(RESOURCE_PATH).observe(1).go();
client.startMultiExpectation();
client.expectEmpty(ACK, mid).go();
- client.expectSeparateResponse(CON, CONTENT, tok).storeMID("M2").noOption(OptionNumberRegistry.OBSERVE).payload(respPayload).go();
+ client.expectSeparateResponse(CON, CONTENT, tok).storeMID("M2").noOption(StandardOptionRegistry.OBSERVE).payload(respPayload).go();
client.goMultiExpectation();
client.sendEmpty(ACK).loadMID("M2").go();
diff --git a/californium-osgi/pom.xml b/californium-osgi/pom.xml
index 2866f616db..befccd2d78 100755
--- a/californium-osgi/pom.xml
+++ b/californium-osgi/pom.xml
@@ -8,7 +8,7 @@
org.eclipse.californium
cf-bom
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
../bom
californium-osgi
diff --git a/californium-proxy2/pom.xml b/californium-proxy2/pom.xml
index 700b8f01e8..502216ce15 100644
--- a/californium-proxy2/pom.xml
+++ b/californium-proxy2/pom.xml
@@ -8,7 +8,7 @@
org.eclipse.californium
cf-bom
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
../bom
californium-proxy2
@@ -40,7 +40,8 @@
com.google.guava
guava
- 30.0-android
+
+ 30.1-android
com.google.code.findbugs
diff --git a/californium-proxy2/src/main/java/org/eclipse/californium/proxy2/http/CrossProtocolTranslator.java b/californium-proxy2/src/main/java/org/eclipse/californium/proxy2/http/CrossProtocolTranslator.java
index 2130b73efd..8bae103438 100644
--- a/californium-proxy2/src/main/java/org/eclipse/californium/proxy2/http/CrossProtocolTranslator.java
+++ b/californium-proxy2/src/main/java/org/eclipse/californium/proxy2/http/CrossProtocolTranslator.java
@@ -51,6 +51,8 @@
import org.eclipse.californium.core.coap.OptionNumberRegistry.OptionFormat;
import org.eclipse.californium.core.coap.OptionSet;
import org.eclipse.californium.core.coap.Response;
+import org.eclipse.californium.core.coap.option.OptionDefinition;
+import org.eclipse.californium.core.coap.option.StandardOptionRegistry;
import org.eclipse.californium.elements.util.Bytes;
import org.eclipse.californium.elements.util.StringUtil;
import org.eclipse.californium.proxy2.InvalidMethodException;
@@ -256,24 +258,22 @@ public List getCoapOptions(Header[] headers, EtagTranslator etagTranslat
String headerName = header.getName().toLowerCase();
// get the mapping from the property file
- Integer coapOption = translationMapping.getCoapOption(headerName);
+ OptionDefinition optionDefinition = translationMapping.getCoapOptionDefinition(headerName);
// ignore the header if not found in the properties file
- if (coapOption == null) {
+ if (optionDefinition == null) {
continue;
}
- int optionNumber = coapOption;
- // ignore the content-type because it will be handled within the
- // payload
- if (optionNumber == OptionNumberRegistry.CONTENT_FORMAT) {
+// int optionNumber = coapOption;
+ // ignore the content-type, it will be handled within the payload
+ if (optionDefinition.equals(StandardOptionRegistry.CONTENT_FORMAT)) {
continue;
}
// get the value of the current header
String headerValue = header.getValue().trim();
- // if the option is accept, it needs to translate the
- // values
- if (optionNumber == OptionNumberRegistry.ACCEPT) {
+ // if the option is accept, it needs to translate the values
+ if (optionDefinition.equals(StandardOptionRegistry.ACCEPT)) {
final ParserCursor cursor = new ParserCursor(0, headerValue.length());
HeaderElement[] headerElements = parser.parseElements(headerValue, cursor);
for (HeaderElement element : headerElements) {
@@ -298,12 +298,12 @@ public List getCoapOptions(Header[] headers, EtagTranslator etagTranslat
coapContentType = getCoapMediaType(headerFragment, MediaTypeRegistry.UNDEFINED);
}
if (coapContentType != MediaTypeRegistry.UNDEFINED) {
- accept = new Option(optionNumber, coapContentType);
+ accept = new Option(StandardOptionRegistry.ACCEPT, coapContentType);
acceptQualifier = qualifier;
}
}
}
- } else if (optionNumber == OptionNumberRegistry.MAX_AGE) {
+ } else if (optionDefinition.equals(StandardOptionRegistry.MAX_AGE)) {
int maxAge = -1;
final ParserCursor cursor = new ParserCursor(0, headerValue.length());
HeaderElement[] headerElements = parser.parseElements(headerValue, cursor);
@@ -323,25 +323,25 @@ public List getCoapOptions(Header[] headers, EtagTranslator etagTranslat
}
if (maxAge >= 0) {
// create the option
- Option option = new Option(optionNumber, maxAge);
+ Option option = new Option(StandardOptionRegistry.MAX_AGE, maxAge);
optionList.add(option);
}
- } else if (optionNumber == OptionNumberRegistry.ETAG) {
+ } else if (optionDefinition.equals(StandardOptionRegistry.ETAG)) {
byte[] etag = etagTranslator.getCoapEtag(headerValue);
- Option option = new Option(optionNumber, etag);
+ Option option = new Option(StandardOptionRegistry.ETAG, etag);
optionList.add(option);
- } else if (optionNumber == OptionNumberRegistry.IF_MATCH) {
+ } else if (optionDefinition.equals(StandardOptionRegistry.IF_MATCH)) {
byte[] etag = etagTranslator.getCoapEtag(headerValue);
- Option option = new Option(optionNumber, etag);
+ Option option = new Option(StandardOptionRegistry.IF_MATCH, etag);
optionList.add(option);
- } else if (optionNumber == OptionNumberRegistry.IF_NONE_MATCH) {
+ } else if (optionDefinition.equals(StandardOptionRegistry.IF_NONE_MATCH)) {
if (headerValue.equals("*")) {
- Option option = new Option(optionNumber, Bytes.EMPTY);
+ Option option = new Option(StandardOptionRegistry.IF_NONE_MATCH, Bytes.EMPTY);
optionList.add(option);
} else {
LOGGER.debug("'if-none-match' with etag '{}' is not supported!", headerValue);
}
- } else if (optionNumber == OptionNumberRegistry.LOCATION_PATH) {
+ } else if (optionDefinition.equals(StandardOptionRegistry.LOCATION_PATH)) {
try {
URI uri = new URI(headerValue);
OptionSet set = new OptionSet();
@@ -361,8 +361,8 @@ public List getCoapOptions(Header[] headers, EtagTranslator etagTranslat
}
} else {
// create the option
- Option option = new Option(optionNumber);
- switch (OptionNumberRegistry.getFormatByNr(optionNumber)) {
+ Option option = new Option(optionDefinition);
+ switch (optionDefinition.getFormat()) {
case INTEGER:
option.setIntegerValue(Integer.parseInt(headerValue));
break;
@@ -558,31 +558,31 @@ public Header[] getHttpHeaders(List optionList, EtagTranslator etagTrans
for (Option option : optionList) {
// skip content-type because it should be translated while handling
// the payload;
- int optionNumber = option.getNumber();
- if (optionNumber == OptionNumberRegistry.CONTENT_FORMAT) {
+ OptionDefinition definition = option.getDefinition();
+ if (StandardOptionRegistry.CONTENT_FORMAT.equals(definition)) {
continue;
}
- if (optionNumber == OptionNumberRegistry.LOCATION_PATH
- || optionNumber == OptionNumberRegistry.LOCATION_QUERY) {
+ if (StandardOptionRegistry.LOCATION_PATH.equals(definition)
+ || StandardOptionRegistry.LOCATION_QUERY.equals(definition)) {
hasLocation = true;
continue;
}
// get the mapping from the property file
- String headerName = translationMapping.getHttpHeader(optionNumber);
+ String headerName = translationMapping.getHttpHeader(option.getNumber());
// set the header
if (headerName != null && !headerName.isEmpty()) {
- OptionFormat optionFormat = OptionNumberRegistry.getFormatByNr(optionNumber);
+ OptionFormat optionFormat = definition.getFormat();
// format the value
String stringOptionValue = null;
- if (optionNumber == OptionNumberRegistry.ETAG) {
+ if (StandardOptionRegistry.ETAG.equals(definition)) {
stringOptionValue = etagTranslator.getHttpEtag(option.getValue());
- } else if (optionNumber == OptionNumberRegistry.IF_MATCH) {
+ } else if (StandardOptionRegistry.IF_MATCH.equals(definition)) {
stringOptionValue = etagTranslator.getHttpEtag(option.getValue());
- } else if (optionNumber == OptionNumberRegistry.IF_NONE_MATCH) {
+ } else if (StandardOptionRegistry.IF_NONE_MATCH.equals(definition)) {
stringOptionValue = "*";
- } else if (optionNumber == OptionNumberRegistry.ACCEPT) {
+ } else if (StandardOptionRegistry.ACCEPT.equals(definition)) {
try {
stringOptionValue = getHttpContentType(option.getIntegerValue()).toString();
} catch (TranslationException e) {
@@ -603,7 +603,7 @@ public Header[] getHttpHeaders(List optionList, EtagTranslator etagTrans
// custom handling for max-age
// format: cache-control: max-age=60
- if (optionNumber == OptionNumberRegistry.MAX_AGE) {
+ if (StandardOptionRegistry.MAX_AGE.equals(definition)) {
stringOptionValue = "max-age=" + stringOptionValue;
}
@@ -615,9 +615,10 @@ public Header[] getHttpHeaders(List optionList, EtagTranslator etagTrans
StringBuilder locationPath = new StringBuilder();
StringBuilder locationQuery = new StringBuilder();
for (Option option : optionList) {
- if (option.getNumber() == OptionNumberRegistry.LOCATION_PATH) {
+ OptionDefinition definition = option.getDefinition();
+ if (StandardOptionRegistry.LOCATION_PATH.equals(definition)) {
locationPath.append("/").append(option.getStringValue());
- } else if (option.getNumber() == OptionNumberRegistry.LOCATION_QUERY) {
+ } else if (StandardOptionRegistry.LOCATION_QUERY.equals(definition)) {
locationQuery.append("&").append(option.getStringValue());
}
}
@@ -783,7 +784,7 @@ public static class CoapServerEtagTranslator implements EtagTranslator {
@Override
public byte[] getCoapEtag(String value) {
byte[] etag = StringUtil.hex2ByteArray(value);
- OptionNumberRegistry.assertValueLength(OptionNumberRegistry.ETAG, etag.length);
+ StandardOptionRegistry.ETAG.assertValue(etag);
return etag;
}
@@ -807,7 +808,7 @@ public static class HttpServerEtagTranslator implements EtagTranslator {
@Override
public byte[] getCoapEtag(String value) {
byte[] etag = value.getBytes(ISO_8859_1);
- OptionNumberRegistry.assertValueLength(OptionNumberRegistry.ETAG, etag.length);
+ StandardOptionRegistry.ETAG.assertValue(etag);
return etag;
}
diff --git a/californium-proxy2/src/main/java/org/eclipse/californium/proxy2/http/MappingProperties.java b/californium-proxy2/src/main/java/org/eclipse/californium/proxy2/http/MappingProperties.java
index 8ce7d3d59e..864f33b8d5 100644
--- a/californium-proxy2/src/main/java/org/eclipse/californium/proxy2/http/MappingProperties.java
+++ b/californium-proxy2/src/main/java/org/eclipse/californium/proxy2/http/MappingProperties.java
@@ -38,6 +38,8 @@
import org.eclipse.californium.elements.util.StringUtil;
import org.eclipse.californium.core.coap.MediaTypeRegistry;
import org.eclipse.californium.core.coap.OptionNumberRegistry;
+import org.eclipse.californium.core.coap.option.OptionDefinition;
+import org.eclipse.californium.core.coap.option.StandardOptionRegistry;
import org.eclipse.californium.proxy2.InvalidMethodException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -412,6 +414,21 @@ public Integer getCoapOption(String httpHeader) {
return httpHeaders.get(httpHeader);
}
+ /**
+ * Get CoAP option definition for http header name.
+ *
+ * @param httpHeader http header name
+ * @return CoAP option definition, or {@code null}, if not available.
+ * @since 3.8
+ */
+ public OptionDefinition getCoapOptionDefinition(String httpHeader) {
+ Integer number = getCoapOption(httpHeader);
+ if (number != null) {
+ return StandardOptionRegistry.getDefaultOptionRegistry().getDefinitionByNumber(number);
+ }
+ return null;
+ }
+
/**
* Get http header name for CoAP option number.
*
diff --git a/californium-tests/californium-integration-tests/pom.xml b/californium-tests/californium-integration-tests/pom.xml
index 405e8a373d..6975b198e2 100644
--- a/californium-tests/californium-integration-tests/pom.xml
+++ b/californium-tests/californium-integration-tests/pom.xml
@@ -8,7 +8,7 @@
org.eclipse.californium
californium-tests
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
californium-integration-tests
diff --git a/californium-tests/californium-interoperability-tests/pom.xml b/californium-tests/californium-interoperability-tests/pom.xml
index 3c0445606a..2525edd664 100644
--- a/californium-tests/californium-interoperability-tests/pom.xml
+++ b/californium-tests/californium-interoperability-tests/pom.xml
@@ -8,7 +8,7 @@
org.eclipse.californium
californium-tests
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
californium-interoperability-tests
diff --git a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/CaliforniumUtil.java b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/CaliforniumUtil.java
index c4b0c23ba8..2129b63c06 100644
--- a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/CaliforniumUtil.java
+++ b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/CaliforniumUtil.java
@@ -38,6 +38,9 @@
import org.eclipse.californium.core.coap.Option;
import org.eclipse.californium.core.coap.Request;
import org.eclipse.californium.core.coap.Response;
+import org.eclipse.californium.core.coap.option.MapBasedOptionRegistry;
+import org.eclipse.californium.core.coap.option.OpaqueOptionDefinition;
+import org.eclipse.californium.core.coap.option.StandardOptionRegistry;
import org.eclipse.californium.core.network.CoapEndpoint;
import org.eclipse.californium.core.server.resources.CoapExchange;
import org.eclipse.californium.elements.DtlsEndpointContext;
@@ -60,6 +63,10 @@ public class CaliforniumUtil extends ConnectorUtil {
CoapConfig.register();
}
+ public static final int OPTION_TRACE_CONTEXT_NO = 0b1111110111111110; // 65022
+
+ public static final OpaqueOptionDefinition OPTION_TRACE_CONTEXT = new OpaqueOptionDefinition(OPTION_TRACE_CONTEXT_NO, "Trace_Context", true, 1, 128);
+
/**
* {@code true}, if used as client, {@code false}, otherwise.
*/
@@ -145,9 +152,11 @@ public void start(InetSocketAddress bind, DtlsConnectorConfig.Builder dtlsBuilde
private void start() throws IOException {
Configuration config = Configuration.createStandardWithoutFile();
+ MapBasedOptionRegistry registry = new MapBasedOptionRegistry(StandardOptionRegistry.STANDARD_OPTIONS, OPTION_TRACE_CONTEXT);
CoapEndpoint.Builder builder = new CoapEndpoint.Builder();
builder.setConfiguration(config);
builder.setConnector(getConnector());
+ builder.setOptionRegistry(registry);
CoapEndpoint endpoint = builder.build();
if (asClient) {
client = new CoapClient();
@@ -188,8 +197,7 @@ public void handlePOST(CoapExchange exchange) {
Response response = new Response(ResponseCode.CHANGED);
response.setPayload("Custom Greetings!");
response.getOptions().setContentFormat(MediaTypeRegistry.MAX_TYPE - 10);
- int OPTION_TRACE_CONTEXT = 0b1111110111111110; // 65022
- Option custom = new Option(OPTION_TRACE_CONTEXT);
+ Option custom = OPTION_TRACE_CONTEXT.create(new byte[] { 0x1 });
custom.setStringValue("test");
response.getOptions().addOption(custom);
response.getOptions().setContentFormat(MediaTypeRegistry.MAX_TYPE - 10);
diff --git a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/ConnectorUtil.java b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/ConnectorUtil.java
index c86ef334f7..d1b479d9c0 100644
--- a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/ConnectorUtil.java
+++ b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/ConnectorUtil.java
@@ -34,6 +34,7 @@
import org.eclipse.californium.scandium.ConnectorHelper;
import org.eclipse.californium.scandium.DTLSConnector;
import org.eclipse.californium.scandium.config.DtlsConfig;
+import org.eclipse.californium.scandium.config.DtlsConfig.DtlsRole;
import org.eclipse.californium.scandium.config.DtlsConnectorConfig;
import org.eclipse.californium.scandium.dtls.AlertMessage;
import org.eclipse.californium.scandium.dtls.AlertMessage.AlertDescription;
@@ -59,12 +60,15 @@ public class ConnectorUtil {
private static final char[] KEY_STORE_PASSWORD = "endPass".toCharArray();
private static final String KEY_STORE_LOCATION = "certs/keyStore.jks";
+ private static final String EDDSA_KEY_STORE_LOCATION = "certs/eddsaKeyStore.jks";
private static final char[] TRUST_STORE_PASSWORD = "rootPass".toCharArray();
private static final String TRUST_STORE_LOCATION = "certs/trustStore.jks";
private static final String CLIENT_NAME = "client";
private static final String SERVER_NAME = "server";
public static final String CLIENT_RSA_NAME = "clientrsa";
public static final String SERVER_RSA_NAME = "serverrsa";
+ public static final String CLIENT_EDDSA_NAME = "clienteddsa";
+ public static final String SERVER_EDDSA_NAME = "servereddsa";
public static final String SERVER_CA_RSA_NAME = "servercarsa";
public static final String TRUST_CA = "ca";
public static final String TRUST_ROOT = "root";
@@ -89,6 +93,14 @@ public class ConnectorUtil {
* Specific credentials for ECDSA base cipher suites to be used by the next test.
*/
private Credentials nextCredentials;
+ /**
+ * Next test uses anonymous peer.
+ */
+ private boolean nextAnonymous;
+ /**
+ * Specific certificate types to be used by the next test.
+ */
+ private CertificateType[] nextCertificateTypes;
private Certificate[] trustCa;
private Certificate[] trustRoot;
@@ -115,6 +127,7 @@ public ConnectorUtil(boolean client) {
public void loadCredentials(String alias) {
try {
+ nextAnonymous = false;
nextCredentials = SslContextUtil.loadCredentials(SslContextUtil.CLASSPATH_SCHEME + KEY_STORE_LOCATION, alias,
KEY_STORE_PASSWORD, KEY_STORE_PASSWORD);
} catch (GeneralSecurityException e) {
@@ -126,6 +139,28 @@ public void loadCredentials(String alias) {
}
}
+ public void loadEdDsaCredentials(String alias) {
+ try {
+ nextAnonymous = false;
+ nextCredentials = SslContextUtil.loadCredentials(SslContextUtil.CLASSPATH_SCHEME + EDDSA_KEY_STORE_LOCATION,
+ alias, KEY_STORE_PASSWORD, KEY_STORE_PASSWORD);
+ } catch (GeneralSecurityException e) {
+ e.printStackTrace();
+ fail(alias + ": " + e.getMessage());
+ } catch (IOException e) {
+ e.printStackTrace();
+ fail(alias + ": " + e.getMessage());
+ }
+ }
+
+ public void setAnonymous() {
+ nextAnonymous = true;
+ }
+
+ public void setCertificateTypes(CertificateType... types) {
+ nextCertificateTypes = types;
+ }
+
/**
* Shutdown the connector.
*/
@@ -175,10 +210,22 @@ public void build(InetSocketAddress bind, DtlsConnectorConfig.Builder dtlsBuilde
new AdvancedSinglePskStore(CredentialslUtil.OPENSSL_PSK_IDENTITY, CredentialslUtil.OPENSSL_PSK_SECRET));
}
if (CipherSuite.containsCipherSuiteRequiringCertExchange(suites)) {
- if (credentials != null && dtlsBuilder.getIncompleteConfig().getCertificateIdentityProvider() == null) {
+ if (nextAnonymous) {
+ nextAnonymous = false;
+ dtlsBuilder.set(DtlsConfig.DTLS_ROLE, DtlsRole.CLIENT_ONLY);
+ } else if ((credentials != null || nextCredentials != null)
+ && dtlsBuilder.getIncompleteConfig().getCertificateIdentityProvider() == null) {
Credentials credentials = nextCredentials != null ? nextCredentials : this.credentials;
- dtlsBuilder.setCertificateIdentityProvider(new SingleCertificateProvider(credentials.getPrivateKey(),
- credentials.getCertificateChain(), CertificateType.X_509, CertificateType.RAW_PUBLIC_KEY));
+ SingleCertificateProvider provider;
+ if (nextCertificateTypes == null) {
+ provider = new SingleCertificateProvider(credentials.getPrivateKey(),
+ credentials.getCertificateChain(), CertificateType.X_509, CertificateType.RAW_PUBLIC_KEY);
+ } else {
+ provider = new SingleCertificateProvider(credentials.getPrivateKey(),
+ credentials.getCertificateChain(), nextCertificateTypes);
+ nextCertificateTypes = null;
+ }
+ dtlsBuilder.setCertificateIdentityProvider(provider);
}
if (dtlsBuilder.getIncompleteConfig().getAdvancedCertificateVerifier() == null) {
Builder builder = StaticNewAdvancedCertificateVerifier.builder();
diff --git a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/CredentialslUtil.java b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/CredentialslUtil.java
index f9511aa642..3fe40f0667 100644
--- a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/CredentialslUtil.java
+++ b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/CredentialslUtil.java
@@ -24,13 +24,16 @@ public class CredentialslUtil {
public static final String SERVER_CERTIFICATE = "server.pem";
public static final String SERVER_RSA_CERTIFICATE = "serverRsa.pem";
+ public static final String SERVER_EDDSA_CERTIFICATE = "serverEdDsa.pem";
public static final String SERVER_CA_RSA_CERTIFICATE = "serverCaRsa.pem";
public static final String CLIENT_CERTIFICATE = "client.pem";
public static final String CLIENT_RSA_CERTIFICATE = "clientRsa.pem";
+ public static final String CLIENT_EDDSA_CERTIFICATE = "clientEdDsa.pem";
public static final String ROOT_CERTIFICATE = "rootTrustStore.pem";
public static final String CA_CERTIFICATES = "caTrustStore.pem";
public static final String CA_RSA_CERTIFICATES = "caRsaTrustStore.pem";
+ public static final String CA_EDDSA_CERTIFICATES = "caEdDsaTrustStore.pem";
public static final String TRUSTSTORE = "trustStore.pem";
public static final String OPENSSL_PSK_IDENTITY = "Client_identity";
diff --git a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/ProcessUtil.java b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/ProcessUtil.java
index fb524c9f08..8609c06abc 100644
--- a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/ProcessUtil.java
+++ b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/ProcessUtil.java
@@ -17,10 +17,13 @@
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
+import static org.junit.Assume.assumeNotNull;
+import static org.junit.Assume.assumeTrue;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.Reader;
+import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.concurrent.TimeUnit;
@@ -29,6 +32,7 @@
import org.eclipse.californium.elements.util.ClockUtil;
import org.eclipse.californium.elements.util.StringUtil;
+import org.junit.AssumptionViolatedException;
/**
* Utility to start external tools.
@@ -36,6 +40,7 @@
public class ProcessUtil {
public static final long TIMEOUT_MILLIS = 2000;
+ public static final long FOLLOW_UP_TIMEOUT_MILLIS = 100;
/**
* Process of external tool.
@@ -60,6 +65,24 @@ public class ProcessUtil {
* Result of external tool. RC and console output.
*/
private ProcessResult result;
+ /**
+ * Result of version request of external tool. RC and console output.
+ *
+ * @since 3.8
+ */
+ protected ProcessResult versionResult;
+ /**
+ * Version of external tool.
+ *
+ * @since 3.8
+ */
+ protected String version;
+ /**
+ * List with extra arguments.
+ *
+ * @since 3.8
+ */
+ protected List extraArgs = new ArrayList<>();
private boolean stopped;
@@ -117,6 +140,27 @@ public void setTag(String tag) {
this.tag = tag;
}
+ /**
+ * Clear current extra arguments.
+ *
+ * @since 3.8
+ */
+ public void clearExtraArgs() {
+ extraArgs.clear();
+ }
+
+ /**
+ * Add extra argument.
+ *
+ * @param args extra arguments
+ * @since 3.8
+ */
+ public void addExtraArgs(String... args) {
+ for (String arg : args) {
+ extraArgs.add(arg);
+ }
+ }
+
/**
* Start external tool.
*
@@ -214,6 +258,93 @@ public void assertConsole(String regex) throws InterruptedException {
assertTrue("\"" + regex + "\" missing in console output!", result.contains(regex));
}
+ /**
+ * Get external tool's version.
+ *
+ * @param timeMillis timeout in milliseconds
+ * @return result of version command. {@code null}, if not available.
+ * @since 3.8
+ */
+ public ProcessResult getToolVersion(long timeMillis) {
+ return null;
+ }
+
+ /**
+ * Get version of external tool.
+ *
+ * @return version of external tool, or {@code null}, if not available.
+ * @see #getToolVersion(long)
+ * @since 3.8 (moved from LibCoapProcessUtil)
+ */
+ public String getVersion() {
+ if (versionResult == null) {
+ getToolVersion(TIMEOUT_MILLIS);
+ }
+ return version;
+ }
+
+ /**
+ * Compare version with version of external tool.
+ *
+ * @param version version to compare
+ * @return {@code <0}, if the provided version is newer, {@code 0}, if the
+ * versions are matching, {@code >0}, if provided version is older.
+ * @see #getToolVersion(long)
+ * @since 3.8 (moved from LibCoapProcessUtil)
+ */
+ public int compareVersion(String version) {
+ if (versionResult == null) {
+ getToolVersion(TIMEOUT_MILLIS);
+ }
+ assumeNotNull(this.version);
+ return compareVersion(this.version, version);
+ }
+
+ /**
+ * Assume a minimum version of the external tool.
+ *
+ * @param version assumed minimum version
+ * @throws AssumptionViolatedException if the external tool's version is
+ * older than the provided one.
+ * @see #getToolVersion(long)
+ * @since 3.8 (moved from LibCoapProcessUtil)
+ */
+ public void assumeMinVersion(String version) {
+ if (versionResult == null) {
+ getToolVersion(TIMEOUT_MILLIS);
+ }
+ assumeNotNull(this.version);
+ assumeTrue(this.version + " > " + version, compareVersion(this.version, version) >= 0);
+ }
+
+ /**
+ * Compare versions.
+ *
+ * Split the provided arguments at the {@code '.'}s.
+ *
+ * @param version1 version 1
+ * @param version2 version 2
+ * @return {@code <0}, if version 1 is older than version 2, {@code 0}, if the
+ * versions are matching, {@code >0}, if version 1 is newer than
+ * version2.
+ * @since 3.8 (moved from LibCoapProcessUtil)
+ */
+ public static int compareVersion(String version1, String version2) {
+ String[] versionPath1 = version1.split("\\.");
+ String[] versionPath2 = version2.split("\\.");
+ int length = versionPath1.length;
+ if (versionPath2.length < length) {
+ length = versionPath2.length;
+ }
+ for (int index = 0; index < length; ++index) {
+ int cmp = versionPath1[index].compareTo(versionPath2[index]);
+ if (cmp != 0) {
+ return cmp;
+ }
+ }
+ return versionPath1.length - versionPath2.length;
+ }
+
/**
* Get console quiet period in milliseconds.
*
@@ -269,6 +400,7 @@ public synchronized ProcessResult waitResult(long timeoutMillis) throws Interrup
* @since 3.0 (add return value)
*/
public boolean stop() {
+ clearExtraArgs();
Process process = getProcess();
if (process != null) {
try {
diff --git a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/ScandiumUtil.java b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/ScandiumUtil.java
index b1d120dc98..9b7c206f04 100644
--- a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/ScandiumUtil.java
+++ b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/ScandiumUtil.java
@@ -17,6 +17,7 @@
import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.CoreMatchers.containsString;
+import static org.hamcrest.CoreMatchers.instanceOf;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
@@ -26,6 +27,7 @@
import java.io.IOException;
import java.net.BindException;
import java.net.InetSocketAddress;
+import java.security.Principal;
import java.util.concurrent.TimeUnit;
import org.eclipse.californium.elements.AddressEndpointContext;
@@ -175,6 +177,62 @@ public void assertContainsReceivedData(String message, long timeoutMillis) throw
assertThat(new String(receivedData.getBytes()), containsString(message));
}
+ /**
+ * Get remote's principal.
+ *
+ * @param timeoutMillis timeout of message, if not already received
+ * @return remote's principal, or {@code null}, if missing.
+ * @throws InterruptedException if interrupted during wait
+ * @since 3.8
+ */
+ public Principal getPrincipal(long timeoutMillis) throws InterruptedException {
+ if (receivedData == null) {
+ receivedData = channel.poll(timeoutMillis, TimeUnit.MILLISECONDS);
+ }
+ return receivedData != null ? receivedData.getSenderIdentity() : null;
+ }
+
+ /**
+ * Get endpoint context.
+ *
+ * @param timeoutMillis timeout of message, if not already received
+ * @return endpoint context, or {@code null}, if missing.
+ * @throws InterruptedException if interrupted during wait
+ * @since 3.8
+ */
+ public EndpointContext getContext(long timeoutMillis) throws InterruptedException {
+ if (receivedData == null) {
+ receivedData = channel.poll(timeoutMillis, TimeUnit.MILLISECONDS);
+ }
+ return receivedData != null ? receivedData.getEndpointContext() : null;
+ }
+
+ /**
+ * Assert, that the peer's principal is of expected type.
+ *
+ * @param timeoutMillis timeout of message, if not already received
+ * @param expectedPrincipalType expected principal type. {@code null}, for
+ * no principal.
+ * @throws InterruptedException if interrupted during wait
+ * @since 3.8
+ */
+ public void assertPrincipalType(long timeoutMillis, final Class expectedPrincipalType)
+ throws InterruptedException {
+ if (receivedData == null) {
+ receivedData = channel.poll(timeoutMillis, TimeUnit.MILLISECONDS);
+ }
+ assertNotNull("scandium missing received message!", receivedData);
+ Principal principal = receivedData.getSenderIdentity();
+ // assert that peer identity is of given type
+ if (principal != null && expectedPrincipalType != null) {
+ assertThat(principal, instanceOf(expectedPrincipalType));
+ } else if (expectedPrincipalType != null) {
+ fail("scandium missing principal, expected " + expectedPrincipalType.getSimpleName() + "!");
+ } else if (principal != null) {
+ fail("scandium unexpected principal " + principal + "!");
+ }
+ }
+
/**
* Send message as response to the last received message.
*
diff --git a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/libcoap/LibCoapProcessUtil.java b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/libcoap/LibCoapProcessUtil.java
index f265d0cf12..4d7639afc4 100644
--- a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/libcoap/LibCoapProcessUtil.java
+++ b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/libcoap/LibCoapProcessUtil.java
@@ -138,12 +138,12 @@ public enum LibCoapAuthenticationMode {
private String client = LIBCOAP_CLIENT_OPENSSL;
private String server = LIBCOAP_SERVER_OPENSSL;
- private String version;
private String dtlsVersion;
private String valgrindVersion;
private boolean valgrindActive;
private String verboseLevel = DEFAULT_VERBOSE_LEVEL;
+ private boolean dtlsVerboseLevel;
private String certificate;
private String privateKey;
private String ca;
@@ -289,6 +289,7 @@ public ProcessResult prepareLibCoapApplication(String application, String dtlsLi
execute(application, "-h");
ProcessResult result = waitResult(timeMillis);
assumeNotNull(result);
+ versionResult = result;
Matcher matcher = result.match(application + " v(\\S+) ");
assumeNotNull(matcher);
version = matcher.group(1);
@@ -297,6 +298,8 @@ public ProcessResult prepareLibCoapApplication(String application, String dtlsLi
assumeNotNull(matcher);
dtlsVersion = matcher.group(1);
+ dtlsVerboseLevel = result.contains("\\[-V num\\]");
+
return result;
} catch (InterruptedException ex) {
return null;
@@ -336,48 +339,19 @@ public ProcessResult prepareValgrind(long timeMillis) {
}
}
- public void assumeMinVersion(String version) {
- assumeNotNull(version);
- assumeTrue(this.version + " > " + version, compareVersion(this.version, version) >= 0);
- }
-
public void assumeMinDtlsVersion(String version) {
- assumeNotNull(version);
+ assumeNotNull(this.dtlsVersion);
assumeTrue(this.dtlsVersion + " > " + version, compareVersion(this.dtlsVersion, version) >= 0);
}
- public String getVersion() {
- return version;
- }
-
public String getDtlsVersion() {
return dtlsVersion;
}
- public int compareVersion(String version2) {
- return compareVersion(version, version2);
- }
-
public int compareDtlsVersion(String version2) {
return compareVersion(dtlsVersion, version2);
}
- public static int compareVersion(String version1, String version2) {
- String[] versionPath1 = version1.split("\\.");
- String[] versionPath2 = version2.split("\\.");
- int length = versionPath1.length;
- if (versionPath2.length < length) {
- length = versionPath2.length;
- }
- for (int index = 0; index < length; ++index) {
- int cmp = versionPath1[index].compareTo(versionPath2[index]);
- if (cmp != 0) {
- return cmp;
- }
- }
- return versionPath1.length - versionPath2.length;
- }
-
public void setVerboseLevel(String level) {
this.verboseLevel = level;
}
@@ -418,8 +392,12 @@ public void startupClient(String destination, LibCoapAuthenticationMode authMode
addValgrind(args);
args.add(client);
if (verboseLevel != null) {
- args.add("-v");
+ args.add("-v"); // coap
args.add(verboseLevel);
+ if (dtlsVerboseLevel) {
+ args.add("-V"); // dtls
+ args.add(verboseLevel);
+ }
}
if (message != null) {
message = message.replace(" ", "%20");
@@ -462,6 +440,7 @@ public void startupClient(String destination, LibCoapAuthenticationMode authMode
args.add("-N");
}
args.add(destination);
+ args.addAll(extraArgs);
print(args);
execute(args);
}
@@ -474,8 +453,12 @@ public void startupServer(String accept, LibCoapAuthenticationMode authMode, Cip
// provide coap port, coaps will be +1
args.addAll(Arrays.asList(server, "-p", "5683"));
if (verboseLevel != null) {
- args.add("-v");
+ args.add("-v"); // coap
args.add(verboseLevel);
+ if (dtlsVerboseLevel) {
+ args.add("-V"); // dtls
+ args.add(verboseLevel);
+ }
}
if (CipherSuite.containsPskBasedCipherSuite(list)) {
args.add("-k");
@@ -495,6 +478,7 @@ public void startupServer(String accept, LibCoapAuthenticationMode authMode, Cip
add(args, authMode);
}
}
+ args.addAll(extraArgs);
print(args);
execute(args);
// wait for DEBG created DTLS endpoint [::]:5684
diff --git a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/libcoap/mbedtls/LibCoapServerMbedTlsInteroperabilityTest.java b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/libcoap/mbedtls/LibCoapServerMbedTlsInteroperabilityTest.java
index a418f822b1..eb078bb8b6 100644
--- a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/libcoap/mbedtls/LibCoapServerMbedTlsInteroperabilityTest.java
+++ b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/libcoap/mbedtls/LibCoapServerMbedTlsInteroperabilityTest.java
@@ -24,7 +24,6 @@
import static org.eclipse.californium.interoperability.test.libcoap.LibCoapProcessUtil.LibCoapAuthenticationMode.CHAIN;
import static org.eclipse.californium.interoperability.test.libcoap.LibCoapProcessUtil.LibCoapAuthenticationMode.TRUST;
import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
@@ -159,9 +158,7 @@ public void testLibCoapServerEcdsaGCM() throws Exception {
processUtil.startupServer(ACCEPT, CHAIN, cipherSuite);
californiumUtil.start(BIND, null, cipherSuite);
- ProcessResult result = connect(true);
- assertFalse(result.contains("write certificate request"));
- assertFalse(result.contains("'cf-client'"));
+ connect(true);
californiumUtil.assertPrincipalType(X509CertPath.class);
}
@@ -171,9 +168,7 @@ public void testLibCoapServerEcdsa() throws Exception {
processUtil.startupServer(ACCEPT, CHAIN, cipherSuite);
californiumUtil.start(BIND, null, cipherSuite);
- ProcessResult result = connect(true);
- assertFalse(result.contains("write certificate request"));
- assertFalse(result.contains("'cf-client'"));
+ connect(true);
californiumUtil.assertPrincipalType(X509CertPath.class);
}
diff --git a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/libcoap/openssl/LibCoapClientOpensslInteroperabilityTest.java b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/libcoap/openssl/LibCoapClientOpensslInteroperabilityTest.java
index acd2799973..27a2385e0a 100644
--- a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/libcoap/openssl/LibCoapClientOpensslInteroperabilityTest.java
+++ b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/libcoap/openssl/LibCoapClientOpensslInteroperabilityTest.java
@@ -39,7 +39,7 @@
import org.eclipse.californium.core.coap.BlockOption;
import org.eclipse.californium.core.coap.CoAP;
import org.eclipse.californium.core.coap.NoResponseOption;
-import org.eclipse.californium.core.coap.OptionNumberRegistry;
+import org.eclipse.californium.core.coap.option.StandardOptionRegistry;
import org.eclipse.californium.elements.auth.PreSharedKeyIdentity;
import org.eclipse.californium.elements.auth.X509CertPath;
import org.eclipse.californium.elements.config.Configuration;
@@ -202,7 +202,7 @@ public void testLibCoapClientPsk4k4kSmallBlocks() throws Exception {
String message = "Hello, CoAP! " + californiumUtil.createTextPayload(4096);
processUtil.setClientBlocksize(128);
int szx = BlockOption.size2Szx(128);
- processUtil.setClientOption(new BlockOption(szx, false, 0).toOption(OptionNumberRegistry.BLOCK2));
+ processUtil.setClientOption(StandardOptionRegistry.BLOCK2.create(new BlockOption(szx, false, 0).getValue()));
processUtil.startupClient(DESTINATION_URL + "large?size=4096", PSK, message, cipherSuite);
ProcessResult result = connect(message,
"3f#############################################################");
diff --git a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/libcoap/tinydtls/LibCoapClientTinyDtlsInteroperabilityTest.java b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/libcoap/tinydtls/LibCoapClientTinyDtlsInteroperabilityTest.java
index b83e8babd1..27d8405eee 100644
--- a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/libcoap/tinydtls/LibCoapClientTinyDtlsInteroperabilityTest.java
+++ b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/libcoap/tinydtls/LibCoapClientTinyDtlsInteroperabilityTest.java
@@ -133,7 +133,7 @@ public void testLibCoapClientTinyDtlsRpk() throws Exception {
californiumUtil.start(BIND, null, cipherSuite);
processUtil.startupClient(DESTINATION_URL + "test", RPK, "Hello, CoAP!", cipherSuite);
- connect("Hello, CoAP!", "Greetings!", "certificate \\(11\\)", "certificate_verify \\(15\\)");
+ connect("Hello, CoAP!", "Greetings!", "certificate \\(11\\)", "certificate_verify \\(15\\)", "CN 'RPK' presented by server \\(Certificate\\)");
californiumUtil.assertPrincipalType(RawPublicKeyIdentity.class);
}
@@ -147,7 +147,7 @@ public void testLibCoapClientTinyDtlsRpkAnonymousClient() throws Exception {
californiumUtil.start(BIND, builder, null, cipherSuite);
processUtil.startupClient(DESTINATION_URL + "test", RPK, "Hello, CoAP!", cipherSuite);
- connect("Hello, CoAP!", "Greetings!", "certificate \\(11\\)");
+ connect("Hello, CoAP!", "Greetings!", "certificate \\(11\\)", "CN 'RPK' presented by server \\(Certificate\\)");
assertNull(californiumUtil.getPrincipal());
}
diff --git a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/libcoap/tinydtls/LibCoapServerTinyDtlsInteroperabilityTest.java b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/libcoap/tinydtls/LibCoapServerTinyDtlsInteroperabilityTest.java
index 3d459df487..592acadcac 100644
--- a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/libcoap/tinydtls/LibCoapServerTinyDtlsInteroperabilityTest.java
+++ b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/libcoap/tinydtls/LibCoapServerTinyDtlsInteroperabilityTest.java
@@ -139,6 +139,7 @@ public void testLibCoapServerRpk() throws Exception {
assertTrue(result.contains("certificate \\(11\\)"));
assertTrue(result.contains("certificate_request \\(13\\)"));
assertTrue(result.contains("certificate_verify \\(15\\)"));
+ assertTrue(result.contains("CN 'RPK' presented by client \\(Certificate\\)"));
californiumUtil.assertPrincipalType(RawPublicKeyIdentity.class);
}
diff --git a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/mbedtls/MbedTlsClientAuthenticationInteroperabilityTest.java b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/mbedtls/MbedTlsClientAuthenticationInteroperabilityTest.java
index 2f41e8881c..85c7cf9600 100644
--- a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/mbedtls/MbedTlsClientAuthenticationInteroperabilityTest.java
+++ b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/mbedtls/MbedTlsClientAuthenticationInteroperabilityTest.java
@@ -21,7 +21,6 @@
import static org.eclipse.californium.interoperability.test.mbedtls.MbedTlsProcessUtil.AuthenticationMode.CHAIN;
import static org.eclipse.californium.interoperability.test.mbedtls.MbedTlsProcessUtil.AuthenticationMode.TRUST;
import static org.junit.Assert.assertTrue;
-import static org.junit.Assume.assumeNotNull;
import static org.junit.Assume.assumeTrue;
import java.io.File;
@@ -37,7 +36,6 @@
import org.eclipse.californium.elements.util.JceNames;
import org.eclipse.californium.elements.util.JceProviderUtil;
import org.eclipse.californium.interoperability.test.ConnectorUtil;
-import org.eclipse.californium.interoperability.test.ProcessUtil.ProcessResult;
import org.eclipse.californium.interoperability.test.ScandiumUtil;
import org.eclipse.californium.interoperability.test.ShutdownUtil;
import org.eclipse.californium.scandium.config.DtlsConfig;
@@ -77,8 +75,7 @@ public class MbedTlsClientAuthenticationInteroperabilityTest {
@BeforeClass
public static void init() throws IOException, InterruptedException {
processUtil = new MbedTlsProcessUtil();
- ProcessResult result = processUtil.getMbedTlsVersion(TIMEOUT_MILLIS);
- assumeNotNull(result);
+ processUtil.assumeMinVersion("3.2.");
scandiumUtil = new ScandiumUtil(false);
cipherSuite = CipherSuite.TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8;
}
diff --git a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/mbedtls/MbedTlsClientInteroperabilityTest.java b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/mbedtls/MbedTlsClientInteroperabilityTest.java
index 341b9308c8..b8659eebbb 100644
--- a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/mbedtls/MbedTlsClientInteroperabilityTest.java
+++ b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/mbedtls/MbedTlsClientInteroperabilityTest.java
@@ -19,7 +19,6 @@
import static org.eclipse.californium.interoperability.test.ProcessUtil.TIMEOUT_MILLIS;
import static org.eclipse.californium.interoperability.test.mbedtls.MbedTlsProcessUtil.AuthenticationMode.CHAIN;
import static org.junit.Assert.assertTrue;
-import static org.junit.Assume.assumeNotNull;
import java.io.IOException;
import java.net.InetAddress;
@@ -28,7 +27,6 @@
import org.eclipse.californium.elements.config.Configuration;
import org.eclipse.californium.elements.rule.TestNameLoggerRule;
import org.eclipse.californium.interoperability.test.ConnectorUtil;
-import org.eclipse.californium.interoperability.test.ProcessUtil.ProcessResult;
import org.eclipse.californium.interoperability.test.ScandiumUtil;
import org.eclipse.californium.interoperability.test.ShutdownUtil;
import org.eclipse.californium.scandium.config.DtlsConfig;
@@ -69,8 +67,7 @@ public class MbedTlsClientInteroperabilityTest {
@BeforeClass
public static void init() throws IOException, InterruptedException {
processUtil = new MbedTlsProcessUtil();
- ProcessResult result = processUtil.getMbedTlsVersion(TIMEOUT_MILLIS);
- assumeNotNull(result);
+ processUtil.assumeMinVersion("3.2.");
scandiumUtil = new ScandiumUtil(false);
}
diff --git a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/mbedtls/MbedTlsProcessUtil.java b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/mbedtls/MbedTlsProcessUtil.java
index d0b9aca897..240dedc22a 100644
--- a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/mbedtls/MbedTlsProcessUtil.java
+++ b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/mbedtls/MbedTlsProcessUtil.java
@@ -23,12 +23,14 @@
import static org.eclipse.californium.interoperability.test.CredentialslUtil.TRUSTSTORE;
import static org.eclipse.californium.interoperability.test.CredentialslUtil.OPENSSL_PSK_IDENTITY;
import static org.eclipse.californium.interoperability.test.CredentialslUtil.OPENSSL_PSK_SECRET;
+import static org.junit.Assume.assumeNotNull;
import static org.junit.Assume.assumeTrue;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
+import java.util.regex.Matcher;
import org.eclipse.californium.elements.util.StringUtil;
import org.eclipse.californium.interoperability.test.ProcessUtil;
@@ -77,8 +79,6 @@ public enum AuthenticationMode {
private String verboseLevel = DEFAULT_VERBOSE_LEVEL;
- private ProcessResult version;
-
/**
* Create instance.
*/
@@ -103,17 +103,21 @@ public void setVerboseLevel(String level) {
* @param timeMillis timeout in milliseconds
* @return result of version command. {@code null}, if not available.
*/
- public ProcessResult getMbedTlsVersion(long timeMillis) {
- if (version == null) {
+ public ProcessResult getToolVersion(long timeMillis) {
+ if (versionResult == null) {
try {
- execute("mbedtls_ssl_client2", "version");
- version = waitResult(timeMillis);
+ execute("mbedtls_ssl_client2", "build_version=1");
+ versionResult = waitResult(timeMillis);
+ assumeNotNull(versionResult);
+ Matcher matcher = versionResult.match("mbed TLS (\\S+) ");
+ assumeNotNull(matcher);
+ version = matcher.group(1);
} catch (InterruptedException ex) {
return null;
} catch (IOException ex) {
}
}
- return version;
+ return versionResult;
}
public String startupClient(String destination, int port, MbedTlsProcessUtil.AuthenticationMode authMode,
@@ -144,6 +148,7 @@ public String startupClient(String destination, int port, MbedTlsProcessUtil.Aut
add(args, authMode, CA_CERTIFICATES);
}
add(args, curves);
+ args.addAll(extraArgs);
print(args);
execute(args);
return mbedTlsCiphers;
@@ -175,6 +180,7 @@ public String startupServer(String accept, int port, MbedTlsProcessUtil.Authenti
add(args, authMode, chain);
}
add(args, curves);
+ args.addAll(extraArgs);
print(args);
execute(args);
// ensure, server is ready to ACCEPT messages
diff --git a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/mbedtls/MbedTlsServerAuthenticationInteroperabilityTest.java b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/mbedtls/MbedTlsServerAuthenticationInteroperabilityTest.java
index 4d832efd72..56f891ccb5 100644
--- a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/mbedtls/MbedTlsServerAuthenticationInteroperabilityTest.java
+++ b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/mbedtls/MbedTlsServerAuthenticationInteroperabilityTest.java
@@ -24,7 +24,6 @@
import static org.eclipse.californium.interoperability.test.mbedtls.MbedTlsProcessUtil.AuthenticationMode.CHAIN;
import static org.eclipse.californium.interoperability.test.mbedtls.MbedTlsProcessUtil.AuthenticationMode.TRUST;
import static org.junit.Assert.assertTrue;
-import static org.junit.Assume.assumeNotNull;
import static org.junit.Assume.assumeTrue;
import java.io.IOException;
@@ -34,7 +33,6 @@
import org.eclipse.californium.elements.config.Configuration;
import org.eclipse.californium.elements.rule.TestNameLoggerRule;
import org.eclipse.californium.interoperability.test.ConnectorUtil;
-import org.eclipse.californium.interoperability.test.ProcessUtil.ProcessResult;
import org.eclipse.californium.interoperability.test.ScandiumUtil;
import org.eclipse.californium.interoperability.test.ShutdownUtil;
import org.eclipse.californium.scandium.config.DtlsConfig;
@@ -75,9 +73,7 @@ public class MbedTlsServerAuthenticationInteroperabilityTest {
@BeforeClass
public static void init() throws IOException, InterruptedException {
processUtil = new MbedTlsProcessUtil();
- ProcessResult result = processUtil.getMbedTlsVersion(TIMEOUT_MILLIS);
- assumeNotNull(result);
-
+ processUtil.assumeMinVersion("3.2.");
scandiumUtil = new ScandiumUtil(true);
cipherSuite = CipherSuite.TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8;
}
diff --git a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/mbedtls/MbedTlsServerInteroperabilityTest.java b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/mbedtls/MbedTlsServerInteroperabilityTest.java
index 16bafa0e66..41e262d690 100644
--- a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/mbedtls/MbedTlsServerInteroperabilityTest.java
+++ b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/mbedtls/MbedTlsServerInteroperabilityTest.java
@@ -21,7 +21,6 @@
import static org.eclipse.californium.interoperability.test.ProcessUtil.TIMEOUT_MILLIS;
import static org.eclipse.californium.interoperability.test.mbedtls.MbedTlsProcessUtil.AuthenticationMode.CHAIN;
import static org.junit.Assert.assertTrue;
-import static org.junit.Assume.assumeNotNull;
import java.io.IOException;
import java.net.InetAddress;
@@ -29,7 +28,6 @@
import org.eclipse.californium.elements.config.Configuration;
import org.eclipse.californium.elements.rule.TestNameLoggerRule;
-import org.eclipse.californium.interoperability.test.ProcessUtil.ProcessResult;
import org.eclipse.californium.interoperability.test.ScandiumUtil;
import org.eclipse.californium.interoperability.test.ShutdownUtil;
import org.eclipse.californium.scandium.config.DtlsConfig;
@@ -72,8 +70,7 @@ public class MbedTlsServerInteroperabilityTest {
@BeforeClass
public static void init() throws IOException, InterruptedException {
processUtil = new MbedTlsProcessUtil();
- ProcessResult result = processUtil.getMbedTlsVersion(TIMEOUT_MILLIS);
- assumeNotNull(result);
+ processUtil.assumeMinVersion("3.2.");
scandiumUtil = new ScandiumUtil(true);
}
diff --git a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/mbedtls/MbedTlsUtil.java b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/mbedtls/MbedTlsUtil.java
index da57a9bb65..6a0de45ac1 100644
--- a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/mbedtls/MbedTlsUtil.java
+++ b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/mbedtls/MbedTlsUtil.java
@@ -71,6 +71,26 @@ public class MbedTlsUtil {
CIPHERSUITES_MAP.put(CipherSuite.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,
"TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA384");
+ CIPHERSUITES_MAP.put(CipherSuite.TLS_PSK_WITH_ARIA_128_GCM_SHA256,
+ "TLS-PSK-WITH-ARIA-128-GCM-SHA256");
+ CIPHERSUITES_MAP.put(CipherSuite.TLS_PSK_WITH_ARIA_256_GCM_SHA384,
+ "TLS-PSK-WITH-ARIA-256-GCM-SHA384");
+ CIPHERSUITES_MAP.put(CipherSuite.TLS_PSK_WITH_ARIA_128_CBC_SHA256,
+ "TLS-PSK-WITH-ARIA-128-CBC-SHA256");
+ CIPHERSUITES_MAP.put(CipherSuite.TLS_PSK_WITH_ARIA_256_CBC_SHA384,
+ "TLS-PSK-WITH-ARIA-256-CBC-SHA384");
+ CIPHERSUITES_MAP.put(CipherSuite.TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256,
+ "TLS-ECDHE-ECDSA-WITH-ARIA-128-CBC-SHA256");
+ CIPHERSUITES_MAP.put(CipherSuite.TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384,
+ "TLS-ECDHE-ECDSA-WITH-ARIA-256-CBC-SHA384");
+ CIPHERSUITES_MAP.put(CipherSuite.TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256,
+ "TLS-ECDHE-ECDSA-WITH-ARIA-128-GCM-SHA256");
+ CIPHERSUITES_MAP.put(CipherSuite.TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384,
+ "TLS-ECDHE-ECDSA-WITH-ARIA-256-GCM-SHA384");
+ CIPHERSUITES_MAP.put(CipherSuite.TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256,
+ "TLS-ECDHE-RSA-WITH-ARIA-128-GCM-SHA256");
+ CIPHERSUITES_MAP.put(CipherSuite.TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384,
+ "TLS-ECDHE-RSA-WITH-ARIA-256-GCM-SHA384");
}
/**
diff --git a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/openssl/OpenSslClientAuthenticationInteroperabilityTest.java b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/openssl/OpenSslClientAuthenticationInteroperabilityTest.java
index a581a0bc99..514efe533c 100644
--- a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/openssl/OpenSslClientAuthenticationInteroperabilityTest.java
+++ b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/openssl/OpenSslClientAuthenticationInteroperabilityTest.java
@@ -16,13 +16,16 @@
package org.eclipse.californium.interoperability.test.openssl;
import static org.eclipse.californium.interoperability.test.ConnectorUtil.HANDSHAKE_TIMEOUT_MILLIS;
+import static org.eclipse.californium.interoperability.test.CredentialslUtil.CLIENT_EDDSA_CERTIFICATE;
import static org.eclipse.californium.interoperability.test.CredentialslUtil.CLIENT_RSA_CERTIFICATE;
import static org.eclipse.californium.interoperability.test.ProcessUtil.TIMEOUT_MILLIS;
+import static org.eclipse.californium.interoperability.test.ProcessUtil.FOLLOW_UP_TIMEOUT_MILLIS;
+import static org.eclipse.californium.interoperability.test.openssl.OpenSslProcessUtil.DEFAULT_CURVES;
+import static org.eclipse.californium.interoperability.test.openssl.OpenSslProcessUtil.DEFAULT_EDDSA_SIGALGS;
import static org.eclipse.californium.interoperability.test.openssl.OpenSslProcessUtil.AuthenticationMode.CERTIFICATE;
import static org.eclipse.californium.interoperability.test.openssl.OpenSslProcessUtil.AuthenticationMode.CHAIN;
import static org.eclipse.californium.interoperability.test.openssl.OpenSslProcessUtil.AuthenticationMode.TRUST;
import static org.junit.Assert.assertTrue;
-import static org.junit.Assume.assumeNotNull;
import static org.junit.Assume.assumeTrue;
import java.io.File;
@@ -32,13 +35,14 @@
import java.util.ArrayList;
import java.util.List;
+import org.eclipse.californium.elements.auth.RawPublicKeyIdentity;
+import org.eclipse.californium.elements.auth.X509CertPath;
import org.eclipse.californium.elements.config.CertificateAuthenticationMode;
import org.eclipse.californium.elements.config.Configuration;
import org.eclipse.californium.elements.rule.TestNameLoggerRule;
import org.eclipse.californium.elements.util.JceNames;
import org.eclipse.californium.elements.util.JceProviderUtil;
import org.eclipse.californium.interoperability.test.ConnectorUtil;
-import org.eclipse.californium.interoperability.test.ProcessUtil.ProcessResult;
import org.eclipse.californium.interoperability.test.ScandiumUtil;
import org.eclipse.californium.interoperability.test.ShutdownUtil;
import org.eclipse.californium.scandium.config.DtlsConfig;
@@ -77,9 +81,7 @@ public class OpenSslClientAuthenticationInteroperabilityTest {
@BeforeClass
public static void init() throws IOException, InterruptedException {
processUtil = new OpenSslProcessUtil();
- ProcessResult result = processUtil.getOpenSslVersion(TIMEOUT_MILLIS);
- assumeNotNull(result);
- assumeTrue(result.contains("OpenSSL 1\\.1\\."));
+ processUtil.assumeMinVersion("1.1.");
scandiumUtil = new ScandiumUtil(false);
cipherSuite = CipherSuite.TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8;
}
@@ -172,6 +174,81 @@ public void testOpenSslClientTrustTrustRoot() throws Exception {
connect(cipher);
}
+ @Test
+ public void testOpenSslClientBothRawPublicKey() throws Exception {
+ processUtil.assumeMinVersion("3.2.");
+ processUtil.addExtraArgs("-enable_server_rpk", "-enable_client_rpk");
+ scandiumUtil.start(BIND, null, cipherSuite);
+
+ String cipher = processUtil.startupClient(DESTINATION, CERTIFICATE, cipherSuite);
+ connect(cipher, "Server raw public key");
+ scandiumUtil.assertPrincipalType(HANDSHAKE_TIMEOUT_MILLIS, RawPublicKeyIdentity.class);
+ }
+
+ @Test
+ public void testOpenSslClientClientRawPublicKey() throws Exception {
+ processUtil.assumeMinVersion("3.2.");
+ processUtil.addExtraArgs("-enable_client_rpk");
+ scandiumUtil.start(BIND, null, cipherSuite);
+
+ String cipher = processUtil.startupClient(DESTINATION, CERTIFICATE, cipherSuite);
+ connect(cipher, "Server certificate");
+ scandiumUtil.assertPrincipalType(HANDSHAKE_TIMEOUT_MILLIS, RawPublicKeyIdentity.class);
+ }
+
+ @Test
+ public void testOpenSslClientServerRawPublicKey() throws Exception {
+ processUtil.assumeMinVersion("3.2.");
+ processUtil.addExtraArgs("-enable_server_rpk");
+ scandiumUtil.start(BIND, null, cipherSuite);
+
+ String cipher = processUtil.startupClient(DESTINATION, CERTIFICATE, cipherSuite);
+ connect(cipher, "Server raw public key");
+ scandiumUtil.assertPrincipalType(HANDSHAKE_TIMEOUT_MILLIS, X509CertPath.class);
+ }
+
+ @Test
+ public void testOpenSslClientBothRawPublicKeyEd25519() throws Exception {
+ assumeTrue("X25519 not support by JCE", XECDHECryptography.SupportedGroup.X25519.isUsable());
+ processUtil.assumeMinVersion("3.2.");
+ processUtil.addExtraArgs("-enable_server_rpk", "-enable_client_rpk");
+ scandiumUtil.loadEdDsaCredentials(ConnectorUtil.SERVER_EDDSA_NAME);
+ scandiumUtil.start(BIND, null, cipherSuite);
+
+ String cipher = processUtil.startupClient(DESTINATION, CERTIFICATE, DEFAULT_CURVES, DEFAULT_EDDSA_SIGALGS,
+ CLIENT_EDDSA_CERTIFICATE, cipherSuite);
+ connect(cipher, "Server raw public key", "X25519");
+ scandiumUtil.assertPrincipalType(HANDSHAKE_TIMEOUT_MILLIS, RawPublicKeyIdentity.class);
+ }
+
+ @Test
+ public void testOpenSslClientBothRawPublicKeyEmptyCertificate() throws Exception {
+ processUtil.assumeMinVersion("3.2.");
+ processUtil.addExtraArgs("-enable_server_rpk", "-enable_client_rpk");
+ DtlsConnectorConfig.Builder dtlsBuilder = DtlsConnectorConfig.builder(new Configuration())
+ .setAsList(DtlsConfig.DTLS_SIGNATURE_AND_HASH_ALGORITHMS, SignatureAndHashAlgorithm.SHA256_WITH_ECDSA)
+ .set(DtlsConfig.DTLS_CLIENT_AUTHENTICATION_MODE, CertificateAuthenticationMode.WANTED);
+ scandiumUtil.start(BIND, dtlsBuilder, ScandiumUtil.TRUST_ROOT, cipherSuite);
+
+ String cipher = processUtil.startupClient(DESTINATION, CERTIFICATE, DEFAULT_CURVES, null, CLIENT_RSA_CERTIFICATE, cipherSuite);
+ connect(cipher, "Server raw public key");
+ scandiumUtil.assertPrincipalType(HANDSHAKE_TIMEOUT_MILLIS, null);
+ }
+
+ @Test
+ public void testOpenSslClientBothRawPublicKeyClientUnauthenticated() throws Exception {
+ processUtil.assumeMinVersion("3.2.");
+ processUtil.addExtraArgs("-enable_server_rpk", "-enable_client_rpk");
+ DtlsConnectorConfig.Builder dtlsBuilder = DtlsConnectorConfig.builder(new Configuration())
+ .set(DtlsConfig.DTLS_CLIENT_AUTHENTICATION_MODE, CertificateAuthenticationMode.NONE);
+
+ scandiumUtil.start(BIND, dtlsBuilder, ScandiumUtil.TRUST_ROOT, cipherSuite);
+
+ String cipher = processUtil.startupClient(DESTINATION, CERTIFICATE, cipherSuite);
+ connect(cipher, "Server raw public key");
+ scandiumUtil.assertPrincipalType(HANDSHAKE_TIMEOUT_MILLIS, null);
+ }
+
@Test
public void testOpenSslClientUnauthenticated() throws Exception {
DtlsConnectorConfig.Builder dtlsBuilder = DtlsConnectorConfig.builder(new Configuration())
@@ -183,12 +260,22 @@ public void testOpenSslClientUnauthenticated() throws Exception {
connect(cipher);
}
+ @Test
+ public void testOpenSslClientEd25519() throws Exception {
+ assumeTrue("X25519 not support by JCE", XECDHECryptography.SupportedGroup.X25519.isUsable());
+ scandiumUtil.loadEdDsaCredentials(ConnectorUtil.SERVER_EDDSA_NAME);
+ scandiumUtil.start(BIND, null, cipherSuite);
+
+ String cipher = processUtil.startupClient(DESTINATION, CERTIFICATE, DEFAULT_CURVES, DEFAULT_EDDSA_SIGALGS, CLIENT_EDDSA_CERTIFICATE, cipherSuite);
+ connect(cipher, "X25519");
+ }
+
@Test
public void testOpenSslClientX25519() throws Exception {
assumeTrue("X25519 not support by JCE", XECDHECryptography.SupportedGroup.X25519.isUsable());
scandiumUtil.start(BIND, ScandiumUtil.TRUST_ROOT, cipherSuite);
- String cipher = processUtil.startupClient(DESTINATION, TRUST, "X25519:prime256v1", null, cipherSuite);
+ String cipher = processUtil.startupClient(DESTINATION, TRUST, DEFAULT_CURVES, null, cipherSuite);
connect(cipher, "X25519");
}
@@ -206,7 +293,7 @@ public void testOpenSslClientPrime256v1() throws Exception {
scandiumUtil.start(BIND, ScandiumUtil.TRUST_ROOT, cipherSuite);
String cipher = processUtil.startupClient(DESTINATION, TRUST, "prime256v1", null, cipherSuite);
- connect(cipher, "ECDH, P-256");
+ connect(cipher, "ECDH, (P-256|prime256v1),");
}
@Test
@@ -214,7 +301,7 @@ public void testOpenSslClientSecP384r1() throws Exception {
scandiumUtil.start(BIND, ScandiumUtil.TRUST_ROOT, cipherSuite);
String cipher = processUtil.startupClient(DESTINATION, TRUST, "secp384r1:prime256v1", null, cipherSuite);
- connect(cipher, "ECDH, P-384");
+ connect(cipher, "ECDH, (P-384|secp384r1),");
}
@Test
@@ -254,7 +341,7 @@ public void testOpenSslClientEdDsaCertificatChain() throws Exception {
.set(DtlsConfig.DTLS_SIGNATURE_AND_HASH_ALGORITHMS, defaults);
scandiumUtil.start(BIND, dtlsBuilder, ScandiumUtil.TRUST_ROOT, cipherSuite);
- String cipher = processUtil.startupClient(DESTINATION, TRUST, "X25519:prime256v1",
+ String cipher = processUtil.startupClient(DESTINATION, TRUST, DEFAULT_CURVES,
"ed25519:ECDSA+SHA256", "clientEdDsa.pem", cipherSuite);
connect(cipher);
}
@@ -294,7 +381,7 @@ public void testOpenSslClientUnauthenticatedFullhandshake() throws Exception {
public void connect(String cipher, String... misc) throws Exception {
assertTrue("handshake failed!", processUtil.waitConsole("Cipher is ", HANDSHAKE_TIMEOUT_MILLIS));
- assertTrue("wrong cipher suite!", processUtil.waitConsole("Cipher is " + cipher, TIMEOUT_MILLIS));
+ assertTrue("wrong cipher suite!", processUtil.waitConsole("Cipher is " + cipher, FOLLOW_UP_TIMEOUT_MILLIS));
if (misc != null) {
for (String check : misc) {
assertTrue("missing " + check, processUtil.waitConsole(check, TIMEOUT_MILLIS));
diff --git a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/openssl/OpenSslClientInteroperabilityTest.java b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/openssl/OpenSslClientInteroperabilityTest.java
index 39e1e214e4..022333dfeb 100644
--- a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/openssl/OpenSslClientInteroperabilityTest.java
+++ b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/openssl/OpenSslClientInteroperabilityTest.java
@@ -17,10 +17,9 @@
import static org.eclipse.californium.interoperability.test.ConnectorUtil.HANDSHAKE_TIMEOUT_MILLIS;
import static org.eclipse.californium.interoperability.test.ProcessUtil.TIMEOUT_MILLIS;
+import static org.eclipse.californium.interoperability.test.ProcessUtil.FOLLOW_UP_TIMEOUT_MILLIS;
import static org.eclipse.californium.interoperability.test.openssl.OpenSslProcessUtil.AuthenticationMode.CERTIFICATE;
import static org.junit.Assert.assertTrue;
-import static org.junit.Assume.assumeNotNull;
-import static org.junit.Assume.assumeTrue;
import java.io.IOException;
import java.net.InetAddress;
@@ -29,7 +28,6 @@
import org.eclipse.californium.elements.config.Configuration;
import org.eclipse.californium.elements.rule.TestNameLoggerRule;
import org.eclipse.californium.interoperability.test.ConnectorUtil;
-import org.eclipse.californium.interoperability.test.ProcessUtil.ProcessResult;
import org.eclipse.californium.interoperability.test.ScandiumUtil;
import org.eclipse.californium.interoperability.test.ShutdownUtil;
import org.eclipse.californium.scandium.config.DtlsConfig;
@@ -69,9 +67,7 @@ public class OpenSslClientInteroperabilityTest {
@BeforeClass
public static void init() throws IOException, InterruptedException {
processUtil = new OpenSslProcessUtil();
- ProcessResult result = processUtil.getOpenSslVersion(TIMEOUT_MILLIS);
- assumeNotNull(result);
- assumeTrue(result.contains("OpenSSL 1\\.1\\."));
+ processUtil.assumeMinVersion("1.1.");
scandiumUtil = new ScandiumUtil(false);
}
@@ -109,7 +105,8 @@ public void testOpenSslClient() throws Exception {
scandiumUtil.start(BIND, null, cipherSuite);
String cipher = processUtil.startupClient(DESTINATION, CERTIFICATE, cipherSuite);
- assertTrue(processUtil.waitConsole("Cipher is " + cipher, HANDSHAKE_TIMEOUT_MILLIS));
+ assertTrue(processUtil.waitConsole("Cipher is ", HANDSHAKE_TIMEOUT_MILLIS));
+ assertTrue(processUtil.waitConsole("Cipher is " + cipher, FOLLOW_UP_TIMEOUT_MILLIS));
String message = "Hello Scandium!";
processUtil.send(message);
@@ -137,7 +134,8 @@ public void testOpenSslClientMultiFragments() throws Exception {
scandiumUtil.start(BIND, builder, null, cipherSuite);
String cipher = processUtil.startupClient(DESTINATION, CERTIFICATE, cipherSuite);
- assertTrue(processUtil.waitConsole("Cipher is " + cipher, HANDSHAKE_TIMEOUT_MILLIS));
+ assertTrue(processUtil.waitConsole("Cipher is ", HANDSHAKE_TIMEOUT_MILLIS));
+ assertTrue(processUtil.waitConsole("Cipher is " + cipher, FOLLOW_UP_TIMEOUT_MILLIS));
String message = "Hello Scandium!";
processUtil.send(message);
diff --git a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/openssl/OpenSslProcessUtil.java b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/openssl/OpenSslProcessUtil.java
index 42e9adac8a..55712ff86b 100644
--- a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/openssl/OpenSslProcessUtil.java
+++ b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/openssl/OpenSslProcessUtil.java
@@ -17,19 +17,23 @@
import static org.eclipse.californium.interoperability.test.CredentialslUtil.CA_CERTIFICATES;
import static org.eclipse.californium.interoperability.test.CredentialslUtil.CA_RSA_CERTIFICATES;
+import static org.eclipse.californium.interoperability.test.CredentialslUtil.CA_EDDSA_CERTIFICATES;
import static org.eclipse.californium.interoperability.test.CredentialslUtil.CLIENT_CERTIFICATE;
import static org.eclipse.californium.interoperability.test.CredentialslUtil.SERVER_CERTIFICATE;
+import static org.eclipse.californium.interoperability.test.CredentialslUtil.SERVER_EDDSA_CERTIFICATE;
import static org.eclipse.californium.interoperability.test.CredentialslUtil.SERVER_CA_RSA_CERTIFICATE;
import static org.eclipse.californium.interoperability.test.CredentialslUtil.TRUSTSTORE;
import static org.eclipse.californium.interoperability.test.CredentialslUtil.OPENSSL_PSK_IDENTITY;
import static org.eclipse.californium.interoperability.test.CredentialslUtil.OPENSSL_PSK_SECRET;
import static org.junit.Assume.assumeFalse;
+import static org.junit.Assume.assumeNotNull;
import static org.junit.Assume.assumeTrue;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
+import java.util.regex.Matcher;
import org.eclipse.californium.elements.util.StringUtil;
import org.eclipse.californium.interoperability.test.ProcessUtil;
@@ -78,10 +82,11 @@ public enum AuthenticationMode {
public static final String DEFAULT_CURVES = "X25519:prime256v1";
public static final String DEFAULT_SIGALGS = "ECDSA+SHA384:ECDSA+SHA256:RSA+SHA256";
+ public static final String DEFAULT_EDDSA_SIGALGS = "ed25519:ECDSA+SHA384:ECDSA+SHA256:RSA+SHA256";
- private ProcessResult version;
-
- private List extraArgs = new ArrayList<>();
+ public static final String OPENSSL_OS = "openssl";
+ public static final String OPENSSL_DEV = "/usr/local/ssl/bin/openssl";
+ public static final String OPENSSL = OPENSSL_OS;
/**
* Create instance.
@@ -95,25 +100,34 @@ public OpenSslProcessUtil() {
* @param timeMillis timeout in milliseconds
* @return result of version command. {@code null}, if not available.
*/
- public ProcessResult getOpenSslVersion(long timeMillis) {
- if (version == null) {
+ public ProcessResult getToolVersion(long timeMillis) {
+ if (versionResult == null) {
try {
- execute("openssl", "version");
- version = waitResult(timeMillis);
+ execute(OPENSSL, "version");
+ versionResult = waitResult(timeMillis);
+ assumeNotNull(versionResult);
+ Matcher matcher = versionResult.match("OpenSSL (\\S+) ");
+ assumeNotNull(matcher);
+ version = matcher.group(1);
} catch (InterruptedException ex) {
return null;
} catch (IOException ex) {
}
}
- return version;
+ return versionResult;
}
+ /**
+ * Assume, that the version supports a server.
+ *
+ * Version {@code 1.1.1a-k} seems to be broken on windows.
+ */
public void assumeServerVersion() {
String os = System.getProperty("os.name");
if (os.startsWith("Windows")) {
- if (version != null) {
+ if (versionResult != null) {
assumeFalse("Windows openssl server 1.1.1 seems to be broken!",
- version.contains("OpenSSL 1\\.1\\.1[a-k]"));
+ versionResult.contains("OpenSSL 1\\.1\\.1[a-k]"));
} else {
assumeFalse("result for openssl version missing!", true);
}
@@ -129,23 +143,13 @@ public void assumeServerVersion() {
* "_blank">openssl issue .
*/
public void assumePskServerVersion() {
- if (version != null) {
- assumeFalse("openssl 1.1.1l - server PSK support is broken!", version.contains("OpenSSL 1\\.1\\.1l"));
+ if (versionResult != null) {
+ assumeFalse("openssl 1.1.1l - server PSK support is broken!", versionResult.contains("OpenSSL 1\\.1\\.1l"));
} else {
assumeFalse("result for openssl version missing!", true);
}
}
- public void clearExtraArgs() {
- extraArgs.clear();
- }
-
- public void addExtraArgs(String... args) {
- for (String arg : args) {
- extraArgs.add(arg);
- }
- }
-
public String startupClient(String destination, OpenSslProcessUtil.AuthenticationMode authMode,
CipherSuite... ciphers) throws IOException, InterruptedException {
return startupClient(destination, authMode, DEFAULT_CURVES, null, ciphers);
@@ -161,7 +165,7 @@ public String startupClient(String destination, OpenSslProcessUtil.Authenticatio
List list = Arrays.asList(ciphers);
List args = new ArrayList();
String openSslCiphers = OpenSslUtil.getOpenSslCipherSuites(ciphers);
- args.addAll(Arrays.asList("openssl", "s_client", "-dtls1_2", "-4", "-connect", destination, "-cipher",
+ args.addAll(Arrays.asList(OPENSSL, "s_client", "-dtls1_2", "-4", "-connect", destination, "-cipher",
openSslCiphers));
if (CipherSuite.containsPskBasedCipherSuite(list)) {
args.add("-psk_identity");
@@ -172,13 +176,13 @@ public String startupClient(String destination, OpenSslProcessUtil.Authenticatio
if (CipherSuite.containsCipherSuiteRequiringCertExchange(list)) {
args.add("-cert");
args.add(clientCert);
- add(args, authMode, CA_CERTIFICATES);
+ add(args, authMode, CA_CERTIFICATES, TRUSTSTORE);
}
add(args, curves, sigAlgs);
args.addAll(extraArgs);
print(args);
execute(args);
- return "(" + openSslCiphers.replace(":", "|") + ")";
+ return "(" + openSslCiphers.replace(":@SECLEVEL=0", "").replace(":", "|") + ")";
}
public String startupServer(String accept, OpenSslProcessUtil.AuthenticationMode authMode, CipherSuite... ciphers)
@@ -191,7 +195,7 @@ public String startupServer(String accept, OpenSslProcessUtil.AuthenticationMode
List list = Arrays.asList(ciphers);
List args = new ArrayList();
String openSslCiphers = OpenSslUtil.getOpenSslCipherSuites(ciphers);
- args.addAll(Arrays.asList("openssl", "s_server", "-4", "-dtls1_2", "-accept", accept, "-listen", "-verify", "5",
+ args.addAll(Arrays.asList(OPENSSL, "s_server", "-dtls1_2", "-4", "-accept", accept, "-listen", "-verify", "5",
"-cipher", openSslCiphers));
if (CipherSuite.containsPskBasedCipherSuite(list)) {
assumePskServerVersion();
@@ -204,10 +208,15 @@ public String startupServer(String accept, OpenSslProcessUtil.AuthenticationMode
args.add("-cert");
args.add(serverCertificate);
String chain = CA_CERTIFICATES;
+ String trust = TRUSTSTORE;
if (SERVER_CA_RSA_CERTIFICATE.equals(serverCertificate)) {
chain = CA_RSA_CERTIFICATES;
+ trust = CA_RSA_CERTIFICATES;
+ } else if (SERVER_EDDSA_CERTIFICATE.equals(serverCertificate)) {
+ chain = CA_EDDSA_CERTIFICATES;
+ trust = CA_EDDSA_CERTIFICATES;
}
- add(args, authMode, chain);
+ add(args, authMode, chain, trust);
}
add(args, curves, sigAlgs);
args.addAll(extraArgs);
@@ -215,7 +224,7 @@ public String startupServer(String accept, OpenSslProcessUtil.AuthenticationMode
execute(args);
// ensure, server is ready to ACCEPT messages
assumeTrue(waitConsole("ACCEPT", TIMEOUT_MILLIS));
- return "(" + openSslCiphers.replace(":", "|") + ")";
+ return "(" + openSslCiphers.replace(":@SECLEVEL=0", "").replace(":", "|") + ")";
}
public void add(List args, String curves, String sigAlgs) throws IOException, InterruptedException {
@@ -229,7 +238,7 @@ public void add(List args, String curves, String sigAlgs) throws IOExcep
}
}
- public void add(List args, OpenSslProcessUtil.AuthenticationMode authMode, String chain)
+ public void add(List args, OpenSslProcessUtil.AuthenticationMode authMode, String chain, String trust)
throws IOException, InterruptedException {
switch (authMode) {
case PSK:
@@ -244,7 +253,7 @@ public void add(List args, OpenSslProcessUtil.AuthenticationMode authMod
break;
case TRUST:
args.add("-CAfile");
- args.add(TRUSTSTORE);
+ args.add(trust);
args.add("-build_chain");
break;
}
diff --git a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/openssl/OpenSslServerAuthenticationInteroperabilityTest.java b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/openssl/OpenSslServerAuthenticationInteroperabilityTest.java
index c05fd8f9e7..8610dcf285 100644
--- a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/openssl/OpenSslServerAuthenticationInteroperabilityTest.java
+++ b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/openssl/OpenSslServerAuthenticationInteroperabilityTest.java
@@ -18,28 +18,32 @@
import static org.eclipse.californium.interoperability.test.ConnectorUtil.HANDSHAKE_TIMEOUT_MILLIS;
import static org.eclipse.californium.interoperability.test.CredentialslUtil.SERVER_CERTIFICATE;
import static org.eclipse.californium.interoperability.test.CredentialslUtil.SERVER_RSA_CERTIFICATE;
+import static org.eclipse.californium.interoperability.test.CredentialslUtil.SERVER_EDDSA_CERTIFICATE;
import static org.eclipse.californium.interoperability.test.CredentialslUtil.SERVER_CA_RSA_CERTIFICATE;
import static org.eclipse.californium.interoperability.test.ProcessUtil.TIMEOUT_MILLIS;
+import static org.eclipse.californium.interoperability.test.ProcessUtil.FOLLOW_UP_TIMEOUT_MILLIS;
import static org.eclipse.californium.interoperability.test.openssl.OpenSslProcessUtil.AuthenticationMode.PSK;
import static org.eclipse.californium.interoperability.test.openssl.OpenSslProcessUtil.AuthenticationMode.CERTIFICATE;
import static org.eclipse.californium.interoperability.test.openssl.OpenSslProcessUtil.AuthenticationMode.CHAIN;
import static org.eclipse.californium.interoperability.test.openssl.OpenSslProcessUtil.AuthenticationMode.TRUST;
+import static org.eclipse.californium.interoperability.test.openssl.OpenSslProcessUtil.DEFAULT_CURVES;
+import static org.eclipse.californium.interoperability.test.openssl.OpenSslProcessUtil.DEFAULT_SIGALGS;
import static org.junit.Assert.assertTrue;
-import static org.junit.Assume.assumeNotNull;
import static org.junit.Assume.assumeTrue;
import java.io.IOException;
import java.net.InetAddress;
import java.net.InetSocketAddress;
+import org.eclipse.californium.elements.auth.RawPublicKeyIdentity;
import org.eclipse.californium.elements.config.Configuration;
import org.eclipse.californium.elements.rule.TestNameLoggerRule;
import org.eclipse.californium.interoperability.test.ConnectorUtil;
-import org.eclipse.californium.interoperability.test.ProcessUtil.ProcessResult;
import org.eclipse.californium.interoperability.test.ScandiumUtil;
import org.eclipse.californium.interoperability.test.ShutdownUtil;
import org.eclipse.californium.scandium.config.DtlsConfig;
import org.eclipse.californium.scandium.config.DtlsConnectorConfig;
+import org.eclipse.californium.scandium.dtls.CertificateType;
import org.eclipse.californium.scandium.dtls.SignatureAndHashAlgorithm;
import org.eclipse.californium.scandium.dtls.cipher.CipherSuite;
import org.eclipse.californium.scandium.dtls.cipher.XECDHECryptography;
@@ -80,11 +84,8 @@ public class OpenSslServerAuthenticationInteroperabilityTest {
@BeforeClass
public static void init() throws IOException, InterruptedException {
processUtil = new OpenSslProcessUtil();
- ProcessResult result = processUtil.getOpenSslVersion(TIMEOUT_MILLIS);
- assumeNotNull(result);
- assumeTrue(result.contains("OpenSSL 1\\.1\\."));
+ processUtil.assumeMinVersion("1.1.");
processUtil.assumeServerVersion();
-
scandiumUtil = new ScandiumUtil(true);
cipherSuite = CipherSuite.TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8;
}
@@ -197,6 +198,79 @@ public void testOpenSslServerTrustTrustRoot() throws Exception {
connect(cipher);
}
+ @Test
+ public void testOpenSslServerBothRawPublicKey() throws Exception {
+ processUtil.assumeMinVersion("3.2.");
+ processUtil.addExtraArgs("-enable_server_rpk", "-enable_client_rpk");
+ String cipher = processUtil.startupServer(ACCEPT, TRUST, cipherSuite);
+
+ scandiumUtil.setCertificateTypes(CertificateType.RAW_PUBLIC_KEY, CertificateType.X_509);
+ scandiumUtil.start(BIND, ScandiumUtil.TRUST_ROOT, cipherSuite);
+
+ connect(cipher, "Client raw public key");
+ scandiumUtil.assertPrincipalType(HANDSHAKE_TIMEOUT_MILLIS, RawPublicKeyIdentity.class);
+ }
+
+ @Test
+ public void testOpenSslServerBothRawPublicKeyEmptyCertificate() throws Exception {
+ processUtil.assumeMinVersion("3.2.");
+ processUtil.addExtraArgs("-enable_server_rpk", "-enable_client_rpk");
+ String cipher = processUtil.startupServer(ACCEPT, TRUST, cipherSuite);
+
+ DtlsConnectorConfig.Builder dtlsBuilder = DtlsConnectorConfig.builder(new Configuration())
+ .setAsList(DtlsConfig.DTLS_SIGNATURE_AND_HASH_ALGORITHMS, SignatureAndHashAlgorithm.SHA256_WITH_ECDSA);
+ scandiumUtil.setAnonymous();
+ scandiumUtil.setCertificateTypes(CertificateType.RAW_PUBLIC_KEY, CertificateType.X_509);
+ scandiumUtil.start(BIND, dtlsBuilder, ScandiumUtil.TRUST_ROOT, cipherSuite);
+
+ connect(cipher);
+ scandiumUtil.assertPrincipalType(HANDSHAKE_TIMEOUT_MILLIS, RawPublicKeyIdentity.class);
+ }
+
+ /**
+ * @see
+ * OpenSSL - State of support for Ed25519 certificates with DTLS 1.2?
+ */
+ @Test
+ @Ignore // Ed25519 fails on server side
+ public void testOpenSslServerBothRawPublicKeyEd25519() throws Exception {
+ assumeTrue("X25519 not support by JCE", XECDHECryptography.SupportedGroup.X25519.isUsable());
+ processUtil.assumeMinVersion("3.2.");
+ processUtil.addExtraArgs("-enable_server_rpk", "-enable_client_rpk");
+ String cipher = processUtil.startupServer(ACCEPT, TRUST, SERVER_EDDSA_CERTIFICATE, DEFAULT_CURVES, null,
+ cipherSuite);
+
+ DtlsConnectorConfig.Builder dtlsBuilder = DtlsConnectorConfig.builder(new Configuration())
+ .setAsList(DtlsConfig.DTLS_CURVES, SupportedGroup.X25519, SupportedGroup.secp256r1);
+
+ scandiumUtil.loadEdDsaCredentials(ConnectorUtil.CLIENT_EDDSA_NAME);
+ scandiumUtil.setCertificateTypes(CertificateType.RAW_PUBLIC_KEY, CertificateType.X_509);
+ scandiumUtil.start(BIND, dtlsBuilder, ScandiumUtil.TRUST_ROOT, cipherSuite);
+
+ connect(cipher, "Shared (Elliptic )?groups: [xX]25519", "Client raw public key");
+ scandiumUtil.assertPrincipalType(HANDSHAKE_TIMEOUT_MILLIS, RawPublicKeyIdentity.class);
+ }
+
+ /**
+ * @see
+ * OpenSSL - State of support for Ed25519 certificates with DTLS 1.2?
+ */
+ @Test
+ @Ignore // Ed25519 fails on server side
+ public void testOpenSslServerEd25519() throws Exception {
+ assumeTrue("X25519 not support by JCE", XECDHECryptography.SupportedGroup.X25519.isUsable());
+ String cipher = processUtil.startupServer(ACCEPT, TRUST, SERVER_EDDSA_CERTIFICATE, DEFAULT_CURVES, "ed25519:" + DEFAULT_SIGALGS,
+ cipherSuite);
+
+ DtlsConnectorConfig.Builder dtlsBuilder = DtlsConnectorConfig.builder(new Configuration())
+ .setAsList(DtlsConfig.DTLS_CURVES, SupportedGroup.X25519, SupportedGroup.secp256r1);
+
+ scandiumUtil.loadEdDsaCredentials(ConnectorUtil.CLIENT_EDDSA_NAME);
+ scandiumUtil.start(BIND, dtlsBuilder, ScandiumUtil.TRUST_ROOT, cipherSuite);
+
+ connect(cipher, "Shared (Elliptic )?groups: [xX]25519");
+ }
+
@Test
public void testOpenSslServerX25519() throws Exception {
assumeTrue("X25519 not support by JCE", XECDHECryptography.SupportedGroup.X25519.isUsable());
@@ -206,7 +280,7 @@ public void testOpenSslServerX25519() throws Exception {
.setAsList(DtlsConfig.DTLS_CURVES, SupportedGroup.X25519, SupportedGroup.secp256r1);
scandiumUtil.start(BIND, dtlsBuilder, ScandiumUtil.TRUST_ROOT, cipherSuite);
- connect(cipher, "Shared Elliptic groups: X25519");
+ connect(cipher, "Shared (Elliptic )?groups: [xX]25519");
}
@Test
@@ -218,7 +292,7 @@ public void testOpenSslServerX448() throws Exception {
.setAsList(DtlsConfig.DTLS_CURVES, SupportedGroup.X448, SupportedGroup.secp256r1);
scandiumUtil.start(BIND, dtlsBuilder, ScandiumUtil.TRUST_ROOT, cipherSuite);
- connect(cipher, "Shared Elliptic groups: X448");
+ connect(cipher, "Shared (Elliptic )?groups: [xX]448");
}
@Test
@@ -229,7 +303,7 @@ public void testOpenSslServerPrime256v1() throws Exception {
.setAsList(DtlsConfig.DTLS_CURVES, SupportedGroup.secp256r1);
scandiumUtil.start(BIND, dtlsBuilder, ScandiumUtil.TRUST_ROOT, cipherSuite);
- connect(cipher, "Shared Elliptic (groups|curves): P-256");
+ connect(cipher, "Shared (Elliptic )?(groups|curves): (P-256|secp256r1)");
}
@Test
@@ -240,7 +314,7 @@ public void testOpenSslServerSecP384r1() throws Exception {
.setAsList(DtlsConfig.DTLS_CURVES, SupportedGroup.secp384r1, SupportedGroup.secp256r1);
scandiumUtil.start(BIND, dtlsBuilder, ScandiumUtil.TRUST_ROOT, cipherSuite);
- connect(cipher, "Shared Elliptic (groups|curves): P-384");
+ connect(cipher, "Shared (Elliptic )?(groups|curves): (P-384|secp384r1)");
}
@Test
@@ -256,7 +330,7 @@ public void testOpenSslServerBrainpoolP384r1() throws Exception {
SignatureAndHashAlgorithm.SHA256_WITH_ECDSA);
scandiumUtil.start(BIND, dtlsBuilder, ScandiumUtil.TRUST_ROOT, cipherSuite);
- connect(cipher, "Shared Elliptic (groups|curves): brainpoolP384r1:P-256");
+ connect(cipher, "Shared (Elliptic )?(groups|curves): brainpoolP384r1:(P-256|secp256r1)");
}
@Test
@@ -306,7 +380,7 @@ public void connect(String cipher, String... misc) throws Exception {
scandiumUtil.send(message, DESTINATION, HANDSHAKE_TIMEOUT_MILLIS);
assertTrue("handshake failed!", processUtil.waitConsole("CIPHER is ", TIMEOUT_MILLIS));
- assertTrue("wrong cipher suite!", processUtil.waitConsole("CIPHER is " + cipher, TIMEOUT_MILLIS));
+ assertTrue("wrong cipher suite!", processUtil.waitConsole("CIPHER is " + cipher, FOLLOW_UP_TIMEOUT_MILLIS));
if (misc != null) {
for (String check : misc) {
assertTrue("missing " + check, processUtil.waitConsole(check, TIMEOUT_MILLIS));
diff --git a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/openssl/OpenSslServerInteroperabilityTest.java b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/openssl/OpenSslServerInteroperabilityTest.java
index d3b89c00c5..e11a354736 100644
--- a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/openssl/OpenSslServerInteroperabilityTest.java
+++ b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/openssl/OpenSslServerInteroperabilityTest.java
@@ -19,10 +19,9 @@
import static org.eclipse.californium.interoperability.test.CredentialslUtil.SERVER_CERTIFICATE;
import static org.eclipse.californium.interoperability.test.CredentialslUtil.SERVER_RSA_CERTIFICATE;
import static org.eclipse.californium.interoperability.test.ProcessUtil.TIMEOUT_MILLIS;
+import static org.eclipse.californium.interoperability.test.ProcessUtil.FOLLOW_UP_TIMEOUT_MILLIS;
import static org.eclipse.californium.interoperability.test.openssl.OpenSslProcessUtil.AuthenticationMode.CERTIFICATE;
import static org.junit.Assert.assertTrue;
-import static org.junit.Assume.assumeNotNull;
-import static org.junit.Assume.assumeTrue;
import java.io.IOException;
import java.net.InetAddress;
@@ -30,7 +29,6 @@
import org.eclipse.californium.elements.config.Configuration;
import org.eclipse.californium.elements.rule.TestNameLoggerRule;
-import org.eclipse.californium.interoperability.test.ProcessUtil.ProcessResult;
import org.eclipse.californium.interoperability.test.ScandiumUtil;
import org.eclipse.californium.interoperability.test.ShutdownUtil;
import org.eclipse.californium.scandium.config.DtlsConfig;
@@ -76,9 +74,7 @@ public class OpenSslServerInteroperabilityTest {
@BeforeClass
public static void init() throws IOException, InterruptedException {
processUtil = new OpenSslProcessUtil();
- ProcessResult result = processUtil.getOpenSslVersion(TIMEOUT_MILLIS);
- assumeNotNull(result);
- assumeTrue(result.contains("OpenSSL 1\\.1\\."));
+ processUtil.assumeMinVersion("1.1.");
processUtil.assumeServerVersion();
scandiumUtil = new ScandiumUtil(true);
}
@@ -122,7 +118,8 @@ public void testOpenSslServer() throws Exception {
String message = "Hello OpenSSL!";
scandiumUtil.send(message, DESTINATION, HANDSHAKE_TIMEOUT_MILLIS);
- assertTrue(processUtil.waitConsole("CIPHER is " + cipher, TIMEOUT_MILLIS));
+ assertTrue(processUtil.waitConsole("CIPHER is ", TIMEOUT_MILLIS));
+ assertTrue(processUtil.waitConsole("CIPHER is " + cipher, FOLLOW_UP_TIMEOUT_MILLIS));
assertTrue(processUtil.waitConsole(message, TIMEOUT_MILLIS));
processUtil.send("ACK-" + message);
@@ -147,7 +144,8 @@ public void testOpenSslServerMultiFragments() throws Exception {
String message = "Hello OpenSSL!";
scandiumUtil.send(message, DESTINATION, HANDSHAKE_TIMEOUT_MILLIS);
- assertTrue(processUtil.waitConsole("CIPHER is " + cipher, TIMEOUT_MILLIS));
+ assertTrue(processUtil.waitConsole("CIPHER is ", TIMEOUT_MILLIS));
+ assertTrue(processUtil.waitConsole("CIPHER is " + cipher, FOLLOW_UP_TIMEOUT_MILLIS));
assertTrue(processUtil.waitConsole(message, TIMEOUT_MILLIS));
processUtil.send("ACK-" + message);
diff --git a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/openssl/OpenSslUtil.java b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/openssl/OpenSslUtil.java
index 7024853227..c7941952e4 100644
--- a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/openssl/OpenSslUtil.java
+++ b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/openssl/OpenSslUtil.java
@@ -38,15 +38,15 @@ public class OpenSslUtil {
CIPHERSUITES_MAP.put(CipherSuite.TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256, "ECDHE-PSK-AES128-CBC-SHA256");
CIPHERSUITES_MAP.put(CipherSuite.TLS_PSK_WITH_AES_128_GCM_SHA256, "PSK-AES128-GCM-SHA256");
CIPHERSUITES_MAP.put(CipherSuite.TLS_PSK_WITH_AES_256_GCM_SHA378, "PSK-AES256-GCM-SHA384");
- CIPHERSUITES_MAP.put(CipherSuite.TLS_PSK_WITH_AES_128_CCM_8, "PSK-AES128-CCM8");
- CIPHERSUITES_MAP.put(CipherSuite.TLS_PSK_WITH_AES_256_CCM_8, "PSK-AES256-CCM8");
+ CIPHERSUITES_MAP.put(CipherSuite.TLS_PSK_WITH_AES_128_CCM_8, "PSK-AES128-CCM8:@SECLEVEL=0");
+ CIPHERSUITES_MAP.put(CipherSuite.TLS_PSK_WITH_AES_256_CCM_8, "PSK-AES256-CCM8:@SECLEVEL=0");
CIPHERSUITES_MAP.put(CipherSuite.TLS_PSK_WITH_AES_128_CCM, "PSK-AES128-CCM");
CIPHERSUITES_MAP.put(CipherSuite.TLS_PSK_WITH_AES_256_CCM, "PSK-AES256-CCM");
CIPHERSUITES_MAP.put(CipherSuite.TLS_PSK_WITH_AES_128_CBC_SHA256, "PSK-AES128-CBC-SHA256");
CIPHERSUITES_MAP.put(CipherSuite.TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, "ECDHE-ECDSA-AES128-GCM-SHA256");
CIPHERSUITES_MAP.put(CipherSuite.TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, "ECDHE-ECDSA-AES256-GCM-SHA384");
- CIPHERSUITES_MAP.put(CipherSuite.TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8, "ECDHE-ECDSA-AES128-CCM8");
- CIPHERSUITES_MAP.put(CipherSuite.TLS_ECDHE_ECDSA_WITH_AES_256_CCM_8, "ECDHE-ECDSA-AES256-CCM8");
+ CIPHERSUITES_MAP.put(CipherSuite.TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8, "ECDHE-ECDSA-AES128-CCM8:@SECLEVEL=0");
+ CIPHERSUITES_MAP.put(CipherSuite.TLS_ECDHE_ECDSA_WITH_AES_256_CCM_8, "ECDHE-ECDSA-AES256-CCM8:@SECLEVEL=0");
CIPHERSUITES_MAP.put(CipherSuite.TLS_ECDHE_ECDSA_WITH_AES_128_CCM, "ECDHE-ECDSA-AES128-CCM");
CIPHERSUITES_MAP.put(CipherSuite.TLS_ECDHE_ECDSA_WITH_AES_256_CCM, "ECDHE-ECDSA-AES256-CCM");
CIPHERSUITES_MAP.put(CipherSuite.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, "ECDHE-ECDSA-AES256-SHA");
@@ -59,6 +59,13 @@ public class OpenSslUtil {
CIPHERSUITES_MAP.put(CipherSuite.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, "ECDHE-RSA-AES256-SHA");
CIPHERSUITES_MAP.put(CipherSuite.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, "ECDHE-RSA-AES256-SHA384");
+ CIPHERSUITES_MAP.put(CipherSuite.TLS_PSK_WITH_ARIA_128_GCM_SHA256, "PSK-ARIA128-GCM-SHA256");
+ CIPHERSUITES_MAP.put(CipherSuite.TLS_PSK_WITH_ARIA_256_GCM_SHA384, "PSK-ARIA256-GCM-SHA384");
+ CIPHERSUITES_MAP.put(CipherSuite.TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256, "ECDHE-ECDSA-ARIA128-GCM-SHA256");
+ CIPHERSUITES_MAP.put(CipherSuite.TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384, "ECDHE-ECDSA-ARIA256-GCM-SHA384");
+ CIPHERSUITES_MAP.put(CipherSuite.TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256, "ECDHE-ARIA128-GCM-SHA256");
+ CIPHERSUITES_MAP.put(CipherSuite.TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384, "ECDHE-ARIA256-GCM-SHA384");
+
}
/**
diff --git a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/tinydtls/TinydtlsClientInteroperabilityTest.java b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/tinydtls/TinydtlsClientInteroperabilityTest.java
new file mode 100644
index 0000000000..6d636d92b9
--- /dev/null
+++ b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/tinydtls/TinydtlsClientInteroperabilityTest.java
@@ -0,0 +1,149 @@
+/*******************************************************************************
+ * Copyright (c) 2022 Contributors to the Eclipse Foundation.
+ *
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * and Eclipse Distribution License v1.0 which accompany this distribution.
+ *
+ * The Eclipse Public License is available at
+ * http://www.eclipse.org/legal/epl-v20.html
+ * and the Eclipse Distribution License is available at
+ * http://www.eclipse.org/org/documents/edl-v10.html.
+ *
+ ******************************************************************************/
+package org.eclipse.californium.interoperability.test.tinydtls;
+
+import static org.eclipse.californium.interoperability.test.ConnectorUtil.HANDSHAKE_TIMEOUT_MILLIS;
+import static org.eclipse.californium.interoperability.test.ProcessUtil.TIMEOUT_MILLIS;
+import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+
+import java.io.IOException;
+import java.net.InetAddress;
+import java.net.InetSocketAddress;
+
+import org.eclipse.californium.elements.DtlsEndpointContext;
+import org.eclipse.californium.elements.EndpointContext;
+import org.eclipse.californium.elements.rule.TestNameLoggerRule;
+import org.eclipse.californium.elements.util.Bytes;
+import org.eclipse.californium.interoperability.test.ScandiumUtil;
+import org.eclipse.californium.interoperability.test.ShutdownUtil;
+import org.eclipse.californium.scandium.dtls.cipher.CipherSuite;
+import org.junit.After;
+import org.junit.AfterClass;
+import org.junit.BeforeClass;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.Parameterized;
+import org.junit.runners.Parameterized.Parameter;
+import org.junit.runners.Parameterized.Parameters;
+
+/**
+ * Test for interoperability with tinydtls client.
+ *
+ * Test several different cipher suites.
+ *
+ * @see TinydtlsUtil
+ * @since 3.8
+ */
+@RunWith(Parameterized.class)
+public class TinydtlsClientInteroperabilityTest {
+
+ @Rule
+ public TestNameLoggerRule name = new TestNameLoggerRule();
+
+ private static final InetSocketAddress BIND = new InetSocketAddress(InetAddress.getLoopbackAddress(),
+ ScandiumUtil.PORT);
+ private static final String DESTINATION = "127.0.0.1";
+
+ private static TinydtlsProcessUtil processUtil;
+ private static ScandiumUtil scandiumUtil;
+
+ @BeforeClass
+ public static void init() throws IOException, InterruptedException {
+ processUtil = new TinydtlsProcessUtil();
+ processUtil.assumeMinVersion("0.8.6");
+ scandiumUtil = new ScandiumUtil(false);
+ }
+
+ @AfterClass
+ public static void shutdown() throws InterruptedException {
+ ShutdownUtil.shutdown(scandiumUtil, processUtil);
+ }
+
+ @Parameter
+ public CipherSuite cipherSuite;
+
+ /**
+ * @return List of cipher suites.
+ */
+ @Parameters(name = "{0}")
+ public static Iterable cipherSuiteParams() {
+ return TinydtlsUtil.getSupportedTestCipherSuites();
+ }
+
+ @After
+ public void stop() throws InterruptedException {
+ ShutdownUtil.shutdown(scandiumUtil, processUtil);
+ }
+
+ /**
+ * Establish a "connection" and send a message to the server and back to the
+ * client.
+ */
+ @Test
+ public void testTinydtlsClient() throws Exception {
+ processUtil.setTag("tinydtls-client, " + cipherSuite.name());
+ scandiumUtil.start(BIND, null, cipherSuite);
+
+ String cipher = processUtil.startupClient(DESTINATION, ScandiumUtil.PORT,
+ TinydtlsProcessUtil.AuthenticationMode.PSK, cipherSuite);
+ assertTrue(processUtil.waitConsole("encrypt using " + cipher, HANDSHAKE_TIMEOUT_MILLIS));
+ assertTrue(processUtil.waitConsole("Handshake complete", HANDSHAKE_TIMEOUT_MILLIS));
+
+ String message = "Hello Scandium!\n";
+ processUtil.send(message);
+
+ scandiumUtil.assertReceivedData(message, TIMEOUT_MILLIS);
+ scandiumUtil.response("ACK-" + message, TIMEOUT_MILLIS);
+
+ assertTrue(processUtil.waitConsole("ACK-" + message, TIMEOUT_MILLIS));
+
+ processUtil.send("client:exit\n");
+
+ processUtil.stop(TIMEOUT_MILLIS);
+ }
+
+ @Test
+ public void testTinydtlsClientCid() throws Exception {
+ processUtil.setTag("tinydtls-client, " + cipherSuite.name());
+ processUtil.addExtraArgs("-#", "-e", "-r");
+ scandiumUtil.start(BIND, null, cipherSuite);
+
+ String cipher = processUtil.startupClient(DESTINATION, ScandiumUtil.PORT,
+ TinydtlsProcessUtil.AuthenticationMode.PSK, cipherSuite);
+ assertTrue(processUtil.waitConsole("encrypt using " + cipher, HANDSHAKE_TIMEOUT_MILLIS));
+ assertTrue(processUtil.waitConsole("Handshake complete", HANDSHAKE_TIMEOUT_MILLIS));
+
+ String message = "Hello Scandium!\n";
+ processUtil.send(message);
+
+ scandiumUtil.assertReceivedData(message, TIMEOUT_MILLIS);
+ scandiumUtil.response("ACK-" + message, TIMEOUT_MILLIS);
+
+ assertTrue(processUtil.waitConsole("ACK-" + message, TIMEOUT_MILLIS));
+
+ processUtil.send("client:exit\n");
+
+ EndpointContext context = scandiumUtil.getContext(TIMEOUT_MILLIS);
+ Bytes bytes = context.get(DtlsEndpointContext.KEY_WRITE_CONNECTION_ID);
+ assertNotNull("Missing CID", bytes);
+ Boolean extendedMasterSecret = context.get(DtlsEndpointContext.KEY_EXTENDED_MASTER_SECRET);
+ assertEquals("Missing extended master secret", Boolean.TRUE, extendedMasterSecret);
+
+ processUtil.stop(TIMEOUT_MILLIS);
+ }
+
+}
diff --git a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/tinydtls/TinydtlsProcessUtil.java b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/tinydtls/TinydtlsProcessUtil.java
new file mode 100644
index 0000000000..84cddf129e
--- /dev/null
+++ b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/tinydtls/TinydtlsProcessUtil.java
@@ -0,0 +1,138 @@
+/*******************************************************************************
+ * Copyright (c) 2022 Contributors to the Eclipse Foundation.
+ *
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * and Eclipse Distribution License v1.0 which accompany this distribution.
+ *
+ * The Eclipse Public License is available at
+ * http://www.eclipse.org/legal/epl-v20.html
+ * and the Eclipse Distribution License is available at
+ * http://www.eclipse.org/org/documents/edl-v10.html.
+ *
+ ******************************************************************************/
+package org.eclipse.californium.interoperability.test.tinydtls;
+
+import static org.eclipse.californium.interoperability.test.CredentialslUtil.SERVER_CERTIFICATE;
+import static org.junit.Assume.assumeNotNull;
+
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import java.util.regex.Matcher;
+
+import org.eclipse.californium.interoperability.test.ProcessUtil;
+import org.eclipse.californium.scandium.dtls.cipher.CipherSuite;
+
+/**
+ * Test utility for tinydtls interoperability.
+ *
+ * Executes (externally provided) tinydtls client and server.
+ *
+ * Requires pre-installed dtls-client and dtls-server of tinydtls. Please use
+ * the names "tinydtls-client" and "tinydtls-server" for the binaries found in
+ * {@code }/tests when copy or link them into your {@code PATH}.
+ *
+ * @since 3.8
+ */
+public class TinydtlsProcessUtil extends ProcessUtil {
+
+ public enum AuthenticationMode {
+ /**
+ * Use PSK.
+ */
+ PSK,
+ /**
+ * Use RPK.
+ */
+ RPK
+ }
+
+ public static final String DEFAULT_VERBOSE_LEVEL = "9";
+
+ private static final String CLIENT = "tinydtls-client2";
+ private static final String SERVER = "tinydtls-server2";
+
+ private String verboseLevel = DEFAULT_VERBOSE_LEVEL;
+
+ /**
+ * Create instance.
+ */
+ public TinydtlsProcessUtil() {
+ }
+
+ public void shutdown() throws InterruptedException {
+ super.shutdown();
+ verboseLevel = DEFAULT_VERBOSE_LEVEL;
+ }
+
+ public void setVerboseLevel(String level) {
+ this.verboseLevel = level;
+ }
+
+ /**
+ * {@inheritDoc}
+ *
+ * Get tinydtls version.
+ */
+ @Override
+ public ProcessResult getToolVersion(long timeMillis) {
+ if (versionResult == null) {
+ try {
+ execute(CLIENT, "-h");
+ versionResult = waitResult(timeMillis);
+ assumeNotNull(versionResult);
+ Matcher matcher = versionResult.match("dtls-\\S+ v(\\S+) --");
+ assumeNotNull(matcher);
+ version = matcher.group(1);
+ } catch (InterruptedException ex) {
+ return null;
+ } catch (IOException ex) {
+ }
+ }
+ return versionResult;
+ }
+
+ public String startupClient(String destination, int port, AuthenticationMode authMode, CipherSuite cipherSuite)
+ throws IOException, InterruptedException {
+ return startupClient(destination, port, authMode, null, cipherSuite);
+ }
+
+ public String startupClient(String destination, int port, AuthenticationMode authMode, String clientCert,
+ CipherSuite cipherSuite) throws IOException, InterruptedException {
+ List args = new ArrayList();
+ String tinydtlsCiphers = TinydtlsUtil.getTinydtlsCipherSuites(cipherSuite);
+ args.addAll(Arrays.asList(CLIENT, "-v", verboseLevel, "-c", tinydtlsCiphers, destination,
+ Integer.toString(port)));
+ args.addAll(extraArgs);
+ print(args);
+ execute(args);
+ return tinydtlsCiphers;
+ }
+
+ public String startupServer(String accept, int port, AuthenticationMode authMode, CipherSuite cipherSuite)
+ throws IOException, InterruptedException {
+ return startupServer(accept, port, authMode, SERVER_CERTIFICATE, cipherSuite);
+ }
+
+ public String startupServer(String accept, int port, AuthenticationMode authMode, String serverCertificate,
+ CipherSuite cipherSuite) throws IOException, InterruptedException {
+ List args = new ArrayList();
+ String tinydtlsCiphers = TinydtlsUtil.getTinydtlsCipherSuites(cipherSuite);
+ args.addAll(Arrays.asList(SERVER, "-v", verboseLevel, "-c" + tinydtlsCiphers, "-A", accept, "-p",
+ Integer.toString(port)));
+ args.addAll(extraArgs);
+ print(args);
+ execute(args);
+ // ensure, server is ready to ACCEPT messages
+ // assumeTrue(waitConsole("Bind on udp:", TIMEOUT_MILLIS));
+ return tinydtlsCiphers;
+ }
+
+ public ProcessResult stop(long timeoutMillis) throws InterruptedException, IOException {
+ clearExtraArgs();
+ return waitResult(timeoutMillis);
+ }
+
+}
diff --git a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/tinydtls/TinydtlsServerInteroperabilityTest.java b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/tinydtls/TinydtlsServerInteroperabilityTest.java
new file mode 100644
index 0000000000..0a194c5ca2
--- /dev/null
+++ b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/tinydtls/TinydtlsServerInteroperabilityTest.java
@@ -0,0 +1,151 @@
+/*******************************************************************************
+ * Copyright (c) 2022 Contributors to the Eclipse Foundation.
+ *
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * and Eclipse Distribution License v1.0 which accompany this distribution.
+ *
+ * The Eclipse Public License is available at
+ * http://www.eclipse.org/legal/epl-v20.html
+ * and the Eclipse Distribution License is available at
+ * http://www.eclipse.org/org/documents/edl-v10.html.
+ *
+ ******************************************************************************/
+package org.eclipse.californium.interoperability.test.tinydtls;
+
+import static org.eclipse.californium.interoperability.test.ConnectorUtil.HANDSHAKE_TIMEOUT_MILLIS;
+import static org.eclipse.californium.interoperability.test.ProcessUtil.TIMEOUT_MILLIS;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+
+import java.io.IOException;
+import java.net.InetAddress;
+import java.net.InetSocketAddress;
+
+import org.eclipse.californium.elements.DtlsEndpointContext;
+import org.eclipse.californium.elements.EndpointContext;
+import org.eclipse.californium.elements.config.Configuration;
+import org.eclipse.californium.elements.rule.TestNameLoggerRule;
+import org.eclipse.californium.interoperability.test.ScandiumUtil;
+import org.eclipse.californium.interoperability.test.ShutdownUtil;
+import org.eclipse.californium.scandium.config.DtlsConfig;
+import org.eclipse.californium.scandium.config.DtlsConfig.DtlsRole;
+import org.eclipse.californium.scandium.config.DtlsConnectorConfig;
+import org.eclipse.californium.scandium.dtls.cipher.CipherSuite;
+import org.junit.After;
+import org.junit.AfterClass;
+import org.junit.BeforeClass;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.Parameterized;
+import org.junit.runners.Parameterized.Parameter;
+import org.junit.runners.Parameterized.Parameters;
+
+/**
+ * Test for interoperability with tinydtls server.
+ *
+ * Test several different cipher suites.
+ *
+ * @see TinydtlsUtil
+ * @since 3.8
+ */
+@RunWith(Parameterized.class)
+public class TinydtlsServerInteroperabilityTest {
+
+ @Rule
+ public TestNameLoggerRule name = new TestNameLoggerRule();
+
+ private static final InetSocketAddress BIND = new InetSocketAddress(InetAddress.getLoopbackAddress(), 0);
+ private static final InetSocketAddress DESTINATION = new InetSocketAddress(InetAddress.getLoopbackAddress(),
+ ScandiumUtil.PORT);
+ private static final String ACCEPT = "127.0.0.1";
+
+ private static TinydtlsProcessUtil processUtil;
+ private static ScandiumUtil scandiumUtil;
+
+ @BeforeClass
+ public static void init() throws IOException, InterruptedException {
+ processUtil = new TinydtlsProcessUtil();
+ processUtil.assumeMinVersion("0.8.6");
+ scandiumUtil = new ScandiumUtil(true);
+ }
+
+ @AfterClass
+ public static void shutdown() throws InterruptedException {
+ ShutdownUtil.shutdown(scandiumUtil, processUtil);
+ }
+
+ @Parameter
+ public CipherSuite cipherSuite;
+
+ /**
+ * @return List of cipher suites.
+ */
+ @Parameters(name = "{0}")
+ public static Iterable cipherSuiteParams() {
+ return TinydtlsUtil.getSupportedTestCipherSuites();
+ }
+
+ @After
+ public void stop() throws InterruptedException {
+ ShutdownUtil.shutdown(scandiumUtil, processUtil);
+ }
+
+ /**
+ * Establish a "connection" and send a message to the server and back to the
+ * client.
+ */
+ @Test
+ public void testTinydtlsServer() throws Exception {
+ processUtil.setTag("tinydtls-server, " + cipherSuite.name());
+ String cipher = processUtil.startupServer(ACCEPT, ScandiumUtil.PORT, TinydtlsProcessUtil.AuthenticationMode.PSK,
+ cipherSuite);
+
+ DtlsConnectorConfig.Builder builder = DtlsConnectorConfig.builder(new Configuration()).set(DtlsConfig.DTLS_ROLE,
+ DtlsRole.CLIENT_ONLY);
+ scandiumUtil.start(BIND, builder, null, cipherSuite);
+
+ String message = "Hello Scandium!\n";
+ scandiumUtil.send(message, DESTINATION, HANDSHAKE_TIMEOUT_MILLIS);
+
+ assertTrue(processUtil.waitConsole("encrypt using " + cipher, TIMEOUT_MILLIS));
+ assertTrue(processUtil.waitConsole(message, TIMEOUT_MILLIS));
+
+ scandiumUtil.assertReceivedData(message, TIMEOUT_MILLIS);
+
+ message = "server:exit\n";
+ scandiumUtil.send(message, DESTINATION, HANDSHAKE_TIMEOUT_MILLIS);
+
+ processUtil.stop(TIMEOUT_MILLIS);
+ }
+
+ @Test
+ public void testTinydtlsServerForceExtension() throws Exception {
+ processUtil.setTag("tinydtls-server, " + cipherSuite.name());
+ processUtil.addExtraArgs("-e", "-r");
+ String cipher = processUtil.startupServer(ACCEPT, ScandiumUtil.PORT, TinydtlsProcessUtil.AuthenticationMode.PSK,
+ cipherSuite);
+
+ DtlsConnectorConfig.Builder builder = DtlsConnectorConfig.builder(new Configuration()).set(DtlsConfig.DTLS_ROLE,
+ DtlsRole.CLIENT_ONLY);
+ scandiumUtil.start(BIND, builder, null, cipherSuite);
+
+ String message = "Hello Scandium!\n";
+ scandiumUtil.send(message, DESTINATION, HANDSHAKE_TIMEOUT_MILLIS);
+
+ assertTrue(processUtil.waitConsole("encrypt using " + cipher, TIMEOUT_MILLIS));
+ assertTrue(processUtil.waitConsole(message, TIMEOUT_MILLIS));
+
+ scandiumUtil.assertReceivedData(message, TIMEOUT_MILLIS);
+
+ message = "server:exit\n";
+ scandiumUtil.send(message, DESTINATION, HANDSHAKE_TIMEOUT_MILLIS);
+
+ EndpointContext context = scandiumUtil.getContext(TIMEOUT_MILLIS);
+ Boolean extendedMasterSecret = context.get(DtlsEndpointContext.KEY_EXTENDED_MASTER_SECRET);
+ assertEquals("Missing extended master secret", Boolean.TRUE, extendedMasterSecret);
+
+ processUtil.stop(TIMEOUT_MILLIS);
+ }
+}
diff --git a/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/tinydtls/TinydtlsUtil.java b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/tinydtls/TinydtlsUtil.java
new file mode 100644
index 0000000000..c44e4267f4
--- /dev/null
+++ b/californium-tests/californium-interoperability-tests/src/test/java/org/eclipse/californium/interoperability/test/tinydtls/TinydtlsUtil.java
@@ -0,0 +1,83 @@
+/*******************************************************************************
+ * Copyright (c) 2022 Contributors to the Eclipse Foundation.
+ *
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * and Eclipse Distribution License v1.0 which accompany this distribution.
+ *
+ * The Eclipse Public License is available at
+ * http://www.eclipse.org/legal/epl-v20.html
+ * and the Eclipse Distribution License is available at
+ * http://www.eclipse.org/org/documents/edl-v10.html.
+ *
+ ******************************************************************************/
+package org.eclipse.californium.interoperability.test.tinydtls;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Set;
+import java.util.TreeSet;
+
+import org.eclipse.californium.scandium.dtls.cipher.CipherSuite;
+
+/**
+ * Utility for tinydtls.
+ *
+ * Map of {@link CipherSuite} to tinydtls cipher suite name.
+ *
+ * @since 3.8
+ */
+public class TinydtlsUtil {
+
+ /**
+ * Map of Californium's cipher suites to tinydtls names.
+ */
+ public static final Map CIPHERSUITES_MAP = new HashMap();
+
+ static {
+ CIPHERSUITES_MAP.put(CipherSuite.TLS_PSK_WITH_AES_128_CCM_8, "TLS_PSK_WITH_AES_128_CCM_8");
+ CIPHERSUITES_MAP.put(CipherSuite.TLS_PSK_WITH_AES_128_CCM, "TLS_PSK_WITH_AES_128_CCM");
+ CIPHERSUITES_MAP.put(CipherSuite.TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8, "TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8");
+ CIPHERSUITES_MAP.put(CipherSuite.TLS_ECDHE_ECDSA_WITH_AES_128_CCM, "TLS_ECDHE_ECDSA_WITH_AES_128_CCM");
+ }
+
+ /**
+ * Get cipher suites supported by the JCE.
+ *
+ * @return JCE supported cipher suites
+ */
+ public static Iterable getSupportedCipherSuites() {
+ Set supported = new TreeSet<>();
+ for (CipherSuite cipherSuite : CIPHERSUITES_MAP.keySet()) {
+ if (cipherSuite.isSupported()) {
+ supported.add(cipherSuite);
+ }
+ }
+ return supported;
+ }
+
+ /**
+ * Get test cipher suites supported by the JCE.
+ *
+ * @return JCE supported test cipher suites
+ */
+ public static Iterable getSupportedTestCipherSuites() {
+ return TinydtlsUtil.getSupportedCipherSuites();
+ }
+
+ /**
+ * Get tinydtls cipher suite name.
+ *
+ * @param cipherSuite Californium cipher suite.
+ * @return tinydtls cipher suite name.
+ * @throws IllegalArgumentException if cipher suite is provided, which is
+ * not included in {@link #CIPHERSUITES_MAP}.
+ */
+ public static String getTinydtlsCipherSuites(CipherSuite cipherSuite) {
+ String tinydtlsCipher = CIPHERSUITES_MAP.get(cipherSuite);
+ if (tinydtlsCipher == null) {
+ throw new IllegalArgumentException("'" + cipherSuite + "' is not supported by tinydtls!");
+ }
+ return tinydtlsCipher;
+ }
+}
diff --git a/californium-tests/pom.xml b/californium-tests/pom.xml
index 4d668f9708..c092c2fd70 100644
--- a/californium-tests/pom.xml
+++ b/californium-tests/pom.xml
@@ -8,7 +8,7 @@
org.eclipse.californium
cf-bom
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
../bom
californium-tests
diff --git a/cf-oscore/pom.xml b/cf-oscore/pom.xml
index 0b00fb1f63..767bd9151e 100644
--- a/cf-oscore/pom.xml
+++ b/cf-oscore/pom.xml
@@ -7,7 +7,7 @@
org.eclipse.californium
cf-bom
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
../bom
diff --git a/cf-oscore/src/main/java/org/eclipse/californium/oscore/ObjectSecurityContextLayer.java b/cf-oscore/src/main/java/org/eclipse/californium/oscore/ObjectSecurityContextLayer.java
index b24f368f21..73d627f9fb 100644
--- a/cf-oscore/src/main/java/org/eclipse/californium/oscore/ObjectSecurityContextLayer.java
+++ b/cf-oscore/src/main/java/org/eclipse/californium/oscore/ObjectSecurityContextLayer.java
@@ -23,7 +23,6 @@
import org.eclipse.californium.core.coap.EmptyMessage;
import org.eclipse.californium.core.coap.Message;
import org.eclipse.californium.core.coap.MessageObserverAdapter;
-import org.eclipse.californium.core.coap.OptionNumberRegistry;
import org.eclipse.californium.core.coap.OptionSet;
import org.eclipse.californium.core.coap.Request;
import org.eclipse.californium.core.coap.Response;
@@ -234,7 +233,7 @@ public void receiveResponse(Exchange exchange, Response response) {
// block-wise layer (for outer block-wise). If a response was not
// processed by OSCORE in the ObjectSecurityLayer it will happen here.
Response rawResponse = exchange.getCurrentResponse();
- boolean outerBlockwise = rawResponse.getOptions().hasBlock2()
+ boolean outerBlockwise = rawResponse != null && rawResponse.getOptions().hasBlock2()
&& ctxDb.getContextByToken(rawResponse.getToken()) != null;
if (outerBlockwise) {
@@ -277,11 +276,11 @@ public void receiveResponse(Exchange exchange, Response response) {
private static boolean shouldProtectRequest(Request request) {
OptionSet options = request.getOptions();
- return options.hasOption(OptionNumberRegistry.OSCORE);
+ return options.hasOscore();
}
private static boolean isProtected(Message message) {
OptionSet options = message.getOptions();
- return options.hasOption(OptionNumberRegistry.OSCORE);
+ return options.hasOscore();
}
}
diff --git a/cf-oscore/src/main/java/org/eclipse/californium/oscore/ObjectSecurityLayer.java b/cf-oscore/src/main/java/org/eclipse/californium/oscore/ObjectSecurityLayer.java
index 93498393ed..1996a7fa27 100644
--- a/cf-oscore/src/main/java/org/eclipse/californium/oscore/ObjectSecurityLayer.java
+++ b/cf-oscore/src/main/java/org/eclipse/californium/oscore/ObjectSecurityLayer.java
@@ -23,7 +23,6 @@
import org.eclipse.californium.core.coap.EmptyMessage;
import org.eclipse.californium.core.coap.Message;
import org.eclipse.californium.core.coap.MessageObserverAdapter;
-import org.eclipse.californium.core.coap.OptionNumberRegistry;
import org.eclipse.californium.core.coap.OptionSet;
import org.eclipse.californium.core.coap.Request;
import org.eclipse.californium.core.coap.Response;
@@ -129,8 +128,9 @@ public void sendRequest(final Exchange exchange, final Request request) {
// Handle outgoing requests for more data from a responder that
// is responding with outer block-wise. These requests should
// not be processed with OSCORE.
- if (request.getOptions().hasBlock2() && exchange.getCurrentResponse() != null) {
- final OSCoreCtx ctx = ctxDb.getContextByToken(exchange.getCurrentResponse().getToken());
+ Response response = exchange.getCurrentResponse();
+ if (request.getOptions().hasBlock2() && response != null) {
+ final OSCoreCtx ctx = ctxDb.getContextByToken(response.getToken());
if (ctx != null) {
request.addMessageObserver(0, new MessageObserverAdapter() {
@@ -421,7 +421,7 @@ private boolean responseShouldBeProtected(Exchange exchange, Response response)
private static boolean shouldProtectRequest(Request request) {
OptionSet options = request.getOptions();
- return options.hasOption(OptionNumberRegistry.OSCORE);
+ return options.hasOscore();
}
diff --git a/cf-oscore/src/main/java/org/eclipse/californium/oscore/OptionJuggle.java b/cf-oscore/src/main/java/org/eclipse/californium/oscore/OptionJuggle.java
index 14ddfec665..4d03ed87a8 100644
--- a/cf-oscore/src/main/java/org/eclipse/californium/oscore/OptionJuggle.java
+++ b/cf-oscore/src/main/java/org/eclipse/californium/oscore/OptionJuggle.java
@@ -20,6 +20,7 @@
package org.eclipse.californium.oscore;
import java.util.ArrayList;
+import java.util.Collections;
import java.util.List;
import org.eclipse.californium.core.coap.Option;
@@ -299,10 +300,10 @@ private static void copy(Message newMessage, Message oldMessage) {
*/
public static OptionSet merge(OptionSet eOptions, OptionSet uOptions) {
- List u = uOptions.asSortedList();
+ List e = eOptions.asSortedList();
- for (Option tmp : u) {
- if (!eOptions.hasOption(tmp.getNumber())) {
+ for (Option tmp : uOptions.asSortedList()) {
+ if (Collections.binarySearch(e, tmp) < 0) {
eOptions.addOption(tmp);
}
}
diff --git a/cf-oscore/src/test/java/org/eclipse/californium/oscore/OSCoreTest.java b/cf-oscore/src/test/java/org/eclipse/californium/oscore/OSCoreTest.java
index 16a01432b1..54c12b67fe 100644
--- a/cf-oscore/src/test/java/org/eclipse/californium/oscore/OSCoreTest.java
+++ b/cf-oscore/src/test/java/org/eclipse/californium/oscore/OSCoreTest.java
@@ -29,12 +29,11 @@
import org.eclipse.californium.core.coap.CoAP;
import org.eclipse.californium.core.coap.MediaTypeRegistry;
-import org.eclipse.californium.core.coap.Option;
-import org.eclipse.californium.core.coap.OptionNumberRegistry;
import org.eclipse.californium.core.coap.OptionSet;
import org.eclipse.californium.core.coap.Request;
import org.eclipse.californium.core.coap.Response;
import org.eclipse.californium.core.coap.Token;
+import org.eclipse.californium.core.coap.option.StandardOptionRegistry;
import org.eclipse.californium.core.network.RandomTokenGenerator;
import org.eclipse.californium.core.network.TokenGenerator;
import org.eclipse.californium.core.network.TokenGenerator.Scope;
@@ -267,7 +266,7 @@ public void testEncryptedNoOptionsNoPayload() {
public void testEncryptDecryptOptions() throws OSException {
Request request = Request.newGet().setURI("coap://localhost:5683");
request.getOptions().setLocationPath("/test/path");
- request.getOptions().addOption(new Option(OptionNumberRegistry.OSCORE, Bytes.EMPTY));
+ request.getOptions().addOption(StandardOptionRegistry.OSCORE.create(Bytes.EMPTY));
assertEquals(2, request.getOptions().getLocationPathCount());
try {
request = ObjectSecurityLayer.prepareSend(dbClient, request);
@@ -507,7 +506,7 @@ private Request sendRequest(String uri, OSCoreCtxDB db, Token token) throws OSEx
Request request = Request.newPost().setURI(uri);
request.setToken(token);
db.addContext(token, ctx);
- request.getOptions().addOption(new Option(OptionNumberRegistry.OSCORE, Bytes.EMPTY));
+ request.getOptions().addOption(StandardOptionRegistry.OSCORE.create(Bytes.EMPTY));
return ObjectSecurityLayer.prepareSend(db, request);
}
@@ -542,7 +541,7 @@ private Response sendResponse(String responsePayload, OSCoreCtx tid, Token token
response.setPayload(responsePayload);
response.getOptions().setContentFormat(MediaTypeRegistry.TEXT_PLAIN);
}
- response.getOptions().addOption(new Option(OptionNumberRegistry.OSCORE, Bytes.EMPTY));
+ response.getOptions().addOption(StandardOptionRegistry.OSCORE.create(Bytes.EMPTY));
response.setToken(token);
return ObjectSecurityLayer.prepareSend(null, response, tid, false, false, clientCtx.getSenderSeq());
diff --git a/cf-pubsub/pom.xml b/cf-pubsub/pom.xml
index 7b2cc42f18..750fd7eb0d 100644
--- a/cf-pubsub/pom.xml
+++ b/cf-pubsub/pom.xml
@@ -6,7 +6,7 @@
org.eclipse.californium
cf-bom
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
../bom
diff --git a/cf-utils/cf-cli-tcp-netty/pom.xml b/cf-utils/cf-cli-tcp-netty/pom.xml
index 08a3aec19f..ea65b2f8bf 100755
--- a/cf-utils/cf-cli-tcp-netty/pom.xml
+++ b/cf-utils/cf-cli-tcp-netty/pom.xml
@@ -8,7 +8,7 @@
org.eclipse.californium
cf-bom
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
../../bom
diff --git a/cf-utils/cf-cli/pom.xml b/cf-utils/cf-cli/pom.xml
index 2c71f63eee..b67f6460d0 100755
--- a/cf-utils/cf-cli/pom.xml
+++ b/cf-utils/cf-cli/pom.xml
@@ -8,7 +8,7 @@
org.eclipse.californium
cf-bom
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
../../bom
diff --git a/cf-utils/cf-cli/src/main/java/org/eclipse/californium/cli/ClientInitializer.java b/cf-utils/cf-cli/src/main/java/org/eclipse/californium/cli/ClientInitializer.java
index d9ea3a368d..d49cfba946 100644
--- a/cf-utils/cf-cli/src/main/java/org/eclipse/californium/cli/ClientInitializer.java
+++ b/cf-utils/cf-cli/src/main/java/org/eclipse/californium/cli/ClientInitializer.java
@@ -62,6 +62,7 @@
import org.eclipse.californium.scandium.dtls.pskstore.AdvancedPskStore;
import org.eclipse.californium.scandium.dtls.x509.SingleCertificateProvider;
import org.eclipse.californium.scandium.dtls.x509.StaticNewAdvancedCertificateVerifier;
+import org.eclipse.californium.scandium.util.ListUtils;
import org.eclipse.californium.scandium.util.SecretUtil;
import org.eclipse.californium.scandium.util.ServerNames;
import org.slf4j.Logger;
@@ -356,7 +357,9 @@ public static DtlsConnectorConfig.Builder createDtlsConfig(ClientBaseConfig clie
}
DtlsConnectorConfig.Builder dtlsConfig = DtlsConnectorConfig.builder(config);
+ StaticNewAdvancedCertificateVerifier.Builder verifierBuilder = StaticNewAdvancedCertificateVerifier.builder();
boolean psk = false;
+ boolean cert = false;
List keyExchangeAlgorithms = new ArrayList();
List certificateTypes = new ArrayList();
for (ConnectorConfig.AuthenticationMode auth : clientConfig.authenticationModes) {
@@ -368,16 +371,16 @@ public static DtlsConnectorConfig.Builder createDtlsConfig(ClientBaseConfig clie
keyExchangeAlgorithms.add(KeyExchangeAlgorithm.PSK);
break;
case RPK:
+ cert = true;
certificateTypes.add(CertificateType.RAW_PUBLIC_KEY);
- keyExchangeAlgorithms.add(KeyExchangeAlgorithm.EC_DIFFIE_HELLMAN);
- dtlsConfig.setAdvancedCertificateVerifier(
- StaticNewAdvancedCertificateVerifier.builder().setTrustAllRPKs().build());
+ ListUtils.addIfAbsent(keyExchangeAlgorithms, KeyExchangeAlgorithm.EC_DIFFIE_HELLMAN);
+ verifierBuilder.setTrustAllRPKs();
break;
case X509:
+ cert = true;
certificateTypes.add(CertificateType.X_509);
- dtlsConfig.setAdvancedCertificateVerifier(StaticNewAdvancedCertificateVerifier.builder()
- .setTrustedCertificates(clientConfig.trust.trusts).build());
- keyExchangeAlgorithms.add(KeyExchangeAlgorithm.EC_DIFFIE_HELLMAN);
+ verifierBuilder.setTrustedCertificates(clientConfig.trust.trusts);
+ ListUtils.addIfAbsent(keyExchangeAlgorithms, KeyExchangeAlgorithm.EC_DIFFIE_HELLMAN);
break;
case ECDHE_PSK:
psk = true;
@@ -385,6 +388,10 @@ public static DtlsConnectorConfig.Builder createDtlsConfig(ClientBaseConfig clie
break;
}
}
+ if (cert) {
+ verifierBuilder.setSupportedCertificateTypes(certificateTypes);
+ dtlsConfig.setAdvancedCertificateVerifier(verifierBuilder.build());
+ }
if (clientConfig.authentication != null && clientConfig.authentication.credentials != null) {
Credentials identity = clientConfig.authentication.credentials;
diff --git a/cf-utils/cf-cli/src/main/java/org/eclipse/californium/cli/ConnectorConfig.java b/cf-utils/cf-cli/src/main/java/org/eclipse/californium/cli/ConnectorConfig.java
index a738c06123..8f01b6f160 100644
--- a/cf-utils/cf-cli/src/main/java/org/eclipse/californium/cli/ConnectorConfig.java
+++ b/cf-utils/cf-cli/src/main/java/org/eclipse/californium/cli/ConnectorConfig.java
@@ -36,6 +36,7 @@
import org.eclipse.californium.elements.util.StringUtil;
import org.eclipse.californium.scandium.config.DtlsConfig;
import org.eclipse.californium.scandium.config.DtlsConfig.DtlsRole;
+import org.eclipse.californium.scandium.dtls.CertificateType;
import org.eclipse.californium.scandium.dtls.ExtendedMasterSecretMode;
import org.eclipse.californium.scandium.dtls.PskSecretResult;
import org.eclipse.californium.scandium.dtls.cipher.CipherSuite;
@@ -465,6 +466,21 @@ public void register(CommandLine cmd) {
* Setup dependent defaults.
*/
public void defaults() {
+ CoapConfig.register();
+ UdpConfig.register();
+ DtlsConfig.register();
+ DefinitionsProvider provider = new DefinitionsProvider() {
+
+ @Override
+ public void applyDefinitions(Configuration config) {
+ config.set(DtlsConfig.DTLS_ROLE, DtlsRole.CLIENT_ONLY);
+ config.set(DtlsConfig.DTLS_RECOMMENDED_CIPHER_SUITES_ONLY, false);
+ if (customConfigurationDefaultsProvider != null) {
+ customConfigurationDefaultsProvider.applyDefinitions(config);
+ }
+ }
+ };
+ configuration = Configuration.createWithFile(configurationFile, configurationHeader, provider);
if (pskStore != null) {
if (identity != null || secret != null) {
System.err.println("Use either '--psk-store' or single psk credentials!");
@@ -496,21 +512,6 @@ public void defaults() {
if (cipherHelpRequested || authHelpRequested) {
helpRequested = true;
}
- CoapConfig.register();
- UdpConfig.register();
- DtlsConfig.register();
- DefinitionsProvider provider = new DefinitionsProvider() {
-
- @Override
- public void applyDefinitions(Configuration config) {
- config.set(DtlsConfig.DTLS_ROLE, DtlsRole.CLIENT_ONLY);
- config.set(DtlsConfig.DTLS_RECOMMENDED_CIPHER_SUITES_ONLY, false);
- if (customConfigurationDefaultsProvider != null) {
- customConfigurationDefaultsProvider.applyDefinitions(config);
- }
- }
- };
- configuration = Configuration.createWithFile(configurationFile, configurationHeader, provider);
}
protected void defaultAuthenticationModes() {
@@ -518,7 +519,19 @@ protected void defaultAuthenticationModes() {
authenticationModes.add(AuthenticationMode.PSK);
}
if (authentication != null) {
- authenticationModes.add(AuthenticationMode.X509);
+ List list = configuration.get(DtlsConfig.DTLS_CERTIFICATE_TYPES);
+ if (list.isEmpty()) {
+ authenticationModes.add(AuthenticationMode.X509);
+ authenticationModes.add(AuthenticationMode.RPK);
+ } else {
+ for (CertificateType type : list) {
+ if (CertificateType.RAW_PUBLIC_KEY == type) {
+ authenticationModes.add(AuthenticationMode.RPK);
+ } else if (CertificateType.X_509 == type) {
+ authenticationModes.add(AuthenticationMode.X509);
+ }
+ }
+ }
}
}
diff --git a/cf-utils/cf-cluster/pom.xml b/cf-utils/cf-cluster/pom.xml
index f5c30fac46..028e9e381a 100644
--- a/cf-utils/cf-cluster/pom.xml
+++ b/cf-utils/cf-cluster/pom.xml
@@ -8,7 +8,7 @@
org.eclipse.californium
cf-bom
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
../../bom
cf-cluster
diff --git a/cf-utils/cf-nat/README.md b/cf-utils/cf-nat/README.md
index 45eff722ae..048fc4084a 100644
--- a/cf-utils/cf-nat/README.md
+++ b/cf-utils/cf-nat/README.md
@@ -6,7 +6,7 @@ In order to test NAT and LoadBalancer specific situations, this module contains
# Download
-[Eclipse Release Repository](https://repo.eclipse.org/content/repositories/californium-releases/org/eclipse/californium/cf-nat/3.7.0/cf-nat-3.7.0.jar)
+[Eclipse Release Repository](https://repo.eclipse.org/content/repositories/californium-releases/org/eclipse/californium/cf-nat/3.8.0/cf-nat-3.8.0.jar)
#Usage
diff --git a/cf-utils/cf-nat/pom.xml b/cf-utils/cf-nat/pom.xml
index 24f601762d..cb010488ee 100644
--- a/cf-utils/cf-nat/pom.xml
+++ b/cf-utils/cf-nat/pom.xml
@@ -8,7 +8,7 @@
org.eclipse.californium
cf-bom
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
../../bom
cf-nat
diff --git a/cf-utils/cf-unix-health/pom.xml b/cf-utils/cf-unix-health/pom.xml
index b61e8b172d..23d1238531 100644
--- a/cf-utils/cf-unix-health/pom.xml
+++ b/cf-utils/cf-unix-health/pom.xml
@@ -8,7 +8,7 @@
org.eclipse.californium
cf-bom
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
../../bom
cf-unix-health
diff --git a/demo-apps/cf-android/app/build.gradle b/demo-apps/cf-android/app/build.gradle
index c2bab18530..52a662199b 100644
--- a/demo-apps/cf-android/app/build.gradle
+++ b/demo-apps/cf-android/app/build.gradle
@@ -55,7 +55,7 @@ android {
dependencies {
- def californiumVersion = '3.7.0'
+ def californiumVersion = '3.8.0'
implementation fileTree(include: ['*.jar'], dir: 'libs')
implementation 'org.eclipse.californium:californium-core:' + californiumVersion
diff --git a/demo-apps/cf-benchmark-observe/pom.xml b/demo-apps/cf-benchmark-observe/pom.xml
index 5ce743de4a..89be9ea7b9 100644
--- a/demo-apps/cf-benchmark-observe/pom.xml
+++ b/demo-apps/cf-benchmark-observe/pom.xml
@@ -8,7 +8,7 @@
org.eclipse.californium
demo-apps
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
cf-benchmark-observe
jar
diff --git a/demo-apps/cf-benchmark/pom.xml b/demo-apps/cf-benchmark/pom.xml
index 04453ebe3d..7e49bd7ca7 100755
--- a/demo-apps/cf-benchmark/pom.xml
+++ b/demo-apps/cf-benchmark/pom.xml
@@ -8,7 +8,7 @@
org.eclipse.californium
demo-apps
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
cf-benchmark
jar
diff --git a/demo-apps/cf-cocoa/pom.xml b/demo-apps/cf-cocoa/pom.xml
index 057aee5ce7..c04b9e2364 100755
--- a/demo-apps/cf-cocoa/pom.xml
+++ b/demo-apps/cf-cocoa/pom.xml
@@ -8,7 +8,7 @@
org.eclipse.californium
demo-apps
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
cf-cocoa
jar
diff --git a/demo-apps/cf-extplugtest-client/benchmark.sh b/demo-apps/cf-extplugtest-client/benchmark.sh
index 074643ac2e..16a2903b7e 100755
--- a/demo-apps/cf-extplugtest-client/benchmark.sh
+++ b/demo-apps/cf-extplugtest-client/benchmark.sh
@@ -84,13 +84,13 @@ echo
# cat /proc/sys/vm/max_map_count
# prlimit
-CF_JAR=cf-extplugtest-client-3.8.0.jar
+CF_JAR=cf-extplugtest-client-3.9.0.jar
CF_JAR_FIND="cf-extplugtest-client-*.jar"
CF_EXEC="org.eclipse.californium.extplugtests.BenchmarkClient"
#CF_OPT="-XX:+UseG1GC -Xmx6g -Xverify:none"
-CF_OPT="-XX:MaxRAMPercentage=50"
+CF_OPT="-XX:+UseZGC -Xmx10g"
-export CALIFORNIUM_STATISTIC="3.8.0"
+export CALIFORNIUM_STATISTIC="3.9.0"
if [ -z "$1" ] ; then
CF_HOST=localhost
@@ -148,7 +148,7 @@ MULTIPLIER=10
: "${REQS:=$((1000 * $MULTIPLIER))}"
REQS_EXTRA=$(($REQS + ($REQS/10)))
REV_REQS=$((2 * $REQS))
-: "${NOTIFIES:=$((1000 * $MULTIPLIER))}"
+: "${NOTIFIES:=$((350 * $MULTIPLIER))}"
: "${REV_NOTIFIES:=$NOTIFIES}"
: "${PAYLOAD:=40}"
@@ -157,8 +157,8 @@ REV_REQS=$((2 * $REQS))
: "${REQS_LARGE:=$(($PAYLOAD * $REQS / $PAYLOAD_LARGE))}"
: "${UDP_CLIENTS:=$((200 * $CLIENTS_MULTIPLIER))}"
-: "${TCP_CLIENTS:=$((50 * $CLIENTS_MULTIPLIER))}"
-: "${OBS_CLIENTS:=$((50 * $CLIENTS_MULTIPLIER))}"
+: "${TCP_CLIENTS:=$((100 * $CLIENTS_MULTIPLIER))}"
+: "${OBS_CLIENTS:=$((100 * $CLIENTS_MULTIPLIER))}"
: "${CALI_AUTH:=--psk-store cali.psk}"
@@ -235,29 +235,31 @@ benchmark()
benchmark_all()
{
- if [ ${USE_REQUEST} -eq 1 ] ; then
# POST
- if [ ${USE_CON} -eq 1 ] || [ ${USE_CON} -eq 3 ] ; then
- if [ ${USE_LARGE_BLOCK1} -ne 0 ] ; then
+ if [ ${USE_REQUEST} -eq 1 ] ; then
+# Large Payload
+ if [ ${USE_LARGE_BLOCK1} -ne 0 ] ; then
+ if [ ${USE_CON} -eq 1 ] || [ ${USE_CON} -eq 3 ] ; then
benchmark_udp "${RESOURCE_PATH}?rlen=${PAYLOAD}" --clients ${UDP_CLIENTS} --requests ${REQS_LARGE} ${USE_NONESTOP} --payload-random ${PAYLOAD_LARGE} --blocksize 64
fi
+ if [ ${USE_NON} -ne 0 ] ; then
+ benchmark_udp "${RESOURCE_PATH}?rlen=${PAYLOAD}" --clients ${UDP_CLIENTS} --non --requests ${REQS_LARGE} ${USE_NONESTOP} --payload-random ${PAYLOAD_LARGE} --blocksize 64
+ fi
+ benchmark_tcp "${RESOURCE_PATH}?rlen=${PAYLOAD}" --clients ${TCP_CLIENTS} --requests ${REQS_LARGE} ${USE_NONESTOP} --payload-random ${PAYLOAD_LARGE} --bertblocks 4
+ fi
+
+# Small Payload
+ if [ ${USE_CON} -eq 1 ] || [ ${USE_CON} -eq 3 ] ; then
benchmark_udp "${RESOURCE_PATH}?rlen=${PAYLOAD}" --clients ${UDP_CLIENTS} --requests ${REQS} ${USE_NONESTOP} ${USE_NSTART} --payload-random ${PAYLOAD}
fi
if [ ${USE_NON} -ne 0 ] ; then
- if [ ${USE_LARGE_BLOCK1} -ne 0 ] ; then
- benchmark_udp "${RESOURCE_PATH}?rlen=${PAYLOAD}" --clients ${UDP_CLIENTS} --non --requests ${REQS_LARGE} ${USE_NONESTOP} --payload-random ${PAYLOAD_LARGE} --blocksize 64
- fi
benchmark_udp "${RESOURCE_PATH}?rlen=${PAYLOAD}" --clients ${UDP_CLIENTS} --non --requests ${REQS} ${USE_NONESTOP} ${USE_NSTART} --payload-random ${PAYLOAD}
fi
-
- if [ ${USE_LARGE_BLOCK1} -ne 0 ] ; then
- benchmark_tcp "${RESOURCE_PATH}?rlen=${PAYLOAD}" --clients ${TCP_CLIENTS} --requests ${REQS_LARGE} ${USE_NONESTOP} --payload-random ${PAYLOAD_LARGE} --bertblocks 4
- fi
benchmark_tcp "${RESOURCE_PATH}?rlen=${PAYLOAD}" --clients ${TCP_CLIENTS} --requests ${REQS} ${USE_NONESTOP} --payload-random ${PAYLOAD}
- if [ ${USE_CON} -eq 2 ] || [ ${USE_CON} -eq 3 ] ; then
# POST separate response
+ if [ ${USE_CON} -eq 2 ] || [ ${USE_CON} -eq 3 ] ; then
benchmark_udp "${RESOURCE_PATH}?rlen=${PAYLOAD}&ack" --clients ${UDP_CLIENTS} --requests ${REQS} ${USE_NONESTOP} ${USE_NSTART} --payload-random ${PAYLOAD}
fi
fi
@@ -266,6 +268,7 @@ benchmark_all()
benchmark_udp "${RESOURCE_PATH}?rlen=${PAYLOAD}" --clients ${OBS_CLIENTS} --requests 1 ${USE_NONESTOP} --notifies ${NOTIFIES} --reregister 25 --register 75
benchmark_udp "${RESOURCE_PATH}?rlen=${PAYLOAD}" --clients ${OBS_CLIENTS} --requests 1 ${USE_NONESTOP} --notifies ${NOTIFIES} --reregister 25 --register 75 --cancel-proactive
benchmark_tcp "${RESOURCE_PATH}?rlen=${PAYLOAD}" --clients ${OBS_CLIENTS} --requests 1 ${USE_NONESTOP} --notifies ${NOTIFIES} --reregister 25 --register 75
+ benchmark_tcp "${RESOURCE_PATH}?rlen=${PAYLOAD}" --clients ${OBS_CLIENTS} --requests 1 ${USE_NONESTOP} --notifies ${NOTIFIES} --reregister 25 --register 75 --cancel-proactive
fi
if [ ${USE_REVERSE} -eq 1 ] ; then
diff --git a/demo-apps/cf-extplugtest-client/hono-benchmark.sh b/demo-apps/cf-extplugtest-client/hono-benchmark.sh
index ba21178dd0..3086983fef 100755
--- a/demo-apps/cf-extplugtest-client/hono-benchmark.sh
+++ b/demo-apps/cf-extplugtest-client/hono-benchmark.sh
@@ -52,12 +52,12 @@ echo
# cat /proc/sys/vm/max_map_count
# prlimit
-CF_JAR=cf-extplugtest-client-3.8.0.jar
+CF_JAR=cf-extplugtest-client-3.9.0.jar
CF_JAR_FIND='cf-extplugtest-client-*.jar'
CF_EXEC="org.eclipse.californium.extplugtests.BenchmarkClient"
CF_OPT="-XX:+UseG1GC -Xmx6g -Xverify:none"
-export CALIFORNIUM_STATISTIC="3.8.0-hono"
+export CALIFORNIUM_STATISTIC="3.9.0-hono"
# store psk credentials in "hono.psk"
# format:
diff --git a/demo-apps/cf-extplugtest-client/pom.xml b/demo-apps/cf-extplugtest-client/pom.xml
index 60e5aa5766..1c22386daa 100644
--- a/demo-apps/cf-extplugtest-client/pom.xml
+++ b/demo-apps/cf-extplugtest-client/pom.xml
@@ -9,7 +9,7 @@
org.eclipse.californium
demo-apps
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
cf-extplugtest-client
diff --git a/demo-apps/cf-extplugtest-client/src/main/java/org/eclipse/californium/extplugtests/BenchmarkClient.java b/demo-apps/cf-extplugtest-client/src/main/java/org/eclipse/californium/extplugtests/BenchmarkClient.java
index 65df936365..d37eef3497 100644
--- a/demo-apps/cf-extplugtest-client/src/main/java/org/eclipse/californium/extplugtests/BenchmarkClient.java
+++ b/demo-apps/cf-extplugtest-client/src/main/java/org/eclipse/californium/extplugtests/BenchmarkClient.java
@@ -646,6 +646,7 @@ public void removedObserveRelation(ObserveRelation relation) {
private final String id;
private final boolean secure;
+ private final boolean tcp;
private final DTLSConnector dtlsConnector;
@@ -705,7 +706,7 @@ private Request prepareRequest(CoapClient client, long c) {
if (destinationContext != null) {
request.setDestinationContext(destinationContext);
}
- request.setURI(client.getURI());
+ request.setURI(uri);
ResponseTimeout timeout = new ResponseTimeout(request, responseTimeout, executorService);
request.addMessageObserver(timeout);
request.addMessageObserver(retransmissionDetector);
@@ -851,21 +852,26 @@ public boolean next(long delayMillis, long forceHandshake, boolean connected, bo
}
LOGGER.trace("{}: receive notify {}/{}", id, notifies, overallNotifiesDownCounter.get());
CoapObserveRelation relation = clientObserveRelation;
- if (relation != null) {
+ if (relation != null && !relation.isCanceled()) {
if (config.observe.register > 0 && (notifies % config.observe.register) == 0) {
- if (config.observe.proactive) {
+ clientObserveRelation = null;
+ if (config.observe.proactive || tcp) {
relation.proactiveCancel();
LOGGER.trace("{}: cancel proactive, register again {}/{}", id, notifies, overallNotifiesDownCounter.get());
return true;
} else {
relation.reactiveCancel();
LOGGER.trace("{}: register again {}/{}", id, notifies, overallNotifiesDownCounter.get());
+ // send next request for new registration
}
} else if (config.observe.reregister > 0 && (notifies % config.observe.reregister) == 0) {
- overallRequestsDownCounter.decrementAndGet();
notifyResponse.set(true);
- relation.reregister();
- LOGGER.trace("{}: reregister {}/{}", id, notifies, overallNotifiesDownCounter.get());
+ try {
+ relation.reregister();
+ overallRequestsDownCounter.decrementAndGet();
+ LOGGER.trace("{}: reregister {}/{}", id, notifies, overallNotifiesDownCounter.get());
+ } catch (IllegalStateException ex) {
+ }
return true;
} else {
// notify without new request
@@ -987,6 +993,7 @@ public void run() {
public BenchmarkClient(int index, Config.Reverse reverse, URI uri, CoapEndpoint endpoint,
ScheduledExecutorService executor, ScheduledThreadPoolExecutor secondaryExecutor) {
this.secure = CoAP.isSecureScheme(uri.getScheme());
+ this.tcp = CoAP.isTcpScheme(uri.getScheme());
Connector connector = endpoint.getConnector();
this.dtlsConnector = secure && connector instanceof DTLSConnector ? (DTLSConnector) connector : null;
this.id = endpoint.getTag();
@@ -1629,7 +1636,7 @@ public void run() {
boolean observe = false;
long lastReverseResponsesCountDown = overallReverseResponsesDownCounter.get();
if (config.reverse != null && lastReverseResponsesCountDown > 0) {
- System.out.println("Requests send.");
+ System.out.println("Requests sent.");
long lastChangeNanoRealtime = ClockUtil.nanoRealtime();
while (!overallReveresResponsesDone.await(DEFAULT_TIMEOUT_NANOS, TimeUnit.NANOSECONDS)) {
long currentReverseResponsesCountDown = overallReverseResponsesDownCounter.get();
@@ -1685,7 +1692,7 @@ public void run() {
long lastNotifiesCountDown = overallNotifiesDownCounter.get();
if (config.observe != null && lastNotifiesCountDown > 0) {
- System.out.println("Observe-Requests send.");
+ System.out.println("Observe-Requests sent.");
long currentOverallSentRequests = overallRequests - overallRequestsDownCounter.get();
long lastChangeNanoRealtime = ClockUtil.nanoRealtime();
while (!overallNotifiesDone.await(DEFAULT_TIMEOUT_NANOS, TimeUnit.NANOSECONDS)) {
diff --git a/demo-apps/cf-extplugtest-server/README.md b/demo-apps/cf-extplugtest-server/README.md
index b269c9a07e..bad3e41e8d 100644
--- a/demo-apps/cf-extplugtest-server/README.md
+++ b/demo-apps/cf-extplugtest-server/README.md
@@ -106,7 +106,7 @@ To see the set of options and arguments.
Requires to start the server with
```sh
-java -Xmx6g -XX:+UseG1GC -jar cf-extplugtest-server-3.7.0.jar --benchmark --no-plugtest
+java -Xmx6g -XX:+UseG1GC -jar cf-extplugtest-server-3.8.0.jar --benchmark --no-plugtest
```
The performance with enabled deduplication for CON requests depends a lot on heap management. Especially, if the performance goes down after a while, that is frequently caused by an exhausted heap. Therefore using explicit heap-options is recommended. Use the benchmark client from "cf-extplugtest-client", normally started with the shell script "benchmark.sh" there.
@@ -453,13 +453,13 @@ The current build-in cluster comes with three modes:
Start node 1 on port 15784, using `localhost:15884` as own cluster-management-interface. Provide `localhost:25884` as static cluster-management-interface for node 2:
```sh
-java -jar target/cf-extplugtest-server-3.7.0.jar --dtls-cluster ":15784;localhost:15884;1,---;localhost:25884;2"
+java -jar target/cf-extplugtest-server-3.8.0.jar --dtls-cluster ":15784;localhost:15884;1,---;localhost:25884;2"
```
Start node 2 on port 25784, using `localhost:25884` as own cluster-management-interface. Provide `localhost:15884` as static cluster-management-interface for node 1:
```sh
-java -jar target/cf-extplugtest-server-3.7.0.jar --dtls-cluster "---;localhost:15884;1,:25784;localhost:25884;2"
+java -jar target/cf-extplugtest-server-3.8.0.jar --dtls-cluster "---;localhost:15884;1,:25784;localhost:25884;2"
```
In that mode, the `address:cid` pairs of the other/foreign nodes are static.
@@ -467,7 +467,7 @@ In that mode, the `address:cid` pairs of the other/foreign nodes are static.
To use that setup, a basic udp-load-balancer may be used in front. The [Cf-NAT](https://github.com/eclipse/californium/tree/main/cf-utils/cf-nat) offers such a function:
```sh
-java -jar cf-nat-3.7.0.jar :5784 :15784 :25784
+java -jar cf-nat-3.8.0.jar :5784 :15784 :25784
```
Replace `` by the host the `cf-extplugtest-server` has been started.
@@ -477,19 +477,19 @@ Replace `` by the host the `cf-extplugtest-server` has been started.
Start node 1 on port 15784, using `localhost:15884` as own cluster-management-interface. Provide `localhost:25884,localhost:35884` as cluster-management-interfaces for the other nodes of this cluster group:
```sh
-java -jar target/cf-extplugtest-server-3.7.0.jar --dtls-cluster ":15784;localhost:15884;1" --dtls-cluster-group="localhost:25884,localhost:35884"
+java -jar target/cf-extplugtest-server-3.8.0.jar --dtls-cluster ":15784;localhost:15884;1" --dtls-cluster-group="localhost:25884,localhost:35884"
```
Start node 2 on port 25784, using `localhost:25884` as own cluster-management-interface. Provide `localhost:15884,localhost:35884` as cluster-management-interfaces for the other nodes of this cluster group:
```sh
-java -jar target/cf-extplugtest-server-3.7.0.jar --dtls-cluster ":25784;localhost:25884;2" --dtls-cluster-group="localhost:15884,localhost:35884"
+java -jar target/cf-extplugtest-server-3.8.0.jar --dtls-cluster ":25784;localhost:25884;2" --dtls-cluster-group="localhost:15884,localhost:35884"
```
Start node 3 on port 35784, using `localhost:35884` as own cluster-management-interface. Provide `localhost:15884,localhost:25884` as cluster-management-interfaces for the other nodes of this cluster group:
```sh
-java -jar target/cf-extplugtest-server-3.7.0.jar --dtls-cluster ":35784;localhost:35884;3" --dtls-cluster-group="localhost:15884,localhost:25884"
+java -jar target/cf-extplugtest-server-3.8.0.jar --dtls-cluster ":35784;localhost:35884;3" --dtls-cluster-group="localhost:15884,localhost:25884"
```
In that mode, the `address:cid` pairs of the other/foreign nodes are dynamically created using additional messages of the cluster-management-protocol.
@@ -504,13 +504,13 @@ In that mode, the `address:cid` pairs of the other/foreign nodes are dynamically
This cluster internal management traffic could be optionally encrypted using DTLS with PSK (all nodes share the same identity and secret).
```sh
-java -jar target/cf-extplugtest-server-3.7.0.jar --dtls-cluster ":25784;localhost:25884;2" --dtls-cluster-group="localhost:15884,localhost:35884 --dtls-cluster-group-security=topSecret!"
+java -jar target/cf-extplugtest-server-3.8.0.jar --dtls-cluster ":25784;localhost:25884;2" --dtls-cluster-group="localhost:15884,localhost:35884 --dtls-cluster-group-security=topSecret!"
```
To use that setup, a basic udp-load-balancer may be used in front as for the mode before. Just add the new third destination.
```sh
-java -jar cf-nat-3.7.0.jar :5784 :15784 :25784 :35784
+java -jar cf-nat-3.8.0.jar :5784 :15784 :25784 :35784
```
### k8s Nodes
@@ -521,7 +521,7 @@ java -jar cf-nat-3.7.0.jar :5784 :15784 :25784 :35784
Start nodes in a container using port `5784`, and `:5884` as own cluster-management-interface. Additionally provide the external port of the cluster-management-interface also with `5884`.
```
-CMD ["java", "-XX:+UseContainerSupport", "-XX:MaxRAMPercentage=75", "-jar", "/opt/app/cf-extplugtest-server-3.7.0.jar", "--no-plugtest", "--no-tcp", "--diagnose", "--benchmark", "--k8s-dtls-cluster", ":5784;:5884;5884"]
+CMD ["java", "-XX:+UseContainerSupport", "-XX:MaxRAMPercentage=75", "-jar", "/opt/app/cf-extplugtest-server-3.8.0.jar", "--no-plugtest", "--no-tcp", "--diagnose", "--benchmark", "--k8s-dtls-cluster", ":5784;:5884;5884"]
```
Example `CMD` statement for docker (":5884" for ":5884", "5884" for just port 5884, see [Dockerfile](service/Dockerfile)).
@@ -566,7 +566,7 @@ Using a k8s local-setup, the "StatefulSet" comes with a "in-cluster load balanci
To test the dtls-cid-cluster a coap-client can be used. For the k8s approach, start it with
```sh
-java -jar cf-client-3.7.0.jar --method GET coaps://:30784/mycontext
+java -jar cf-client-3.8.0.jar --method GET coaps://:30784/mycontext
==[ CoAP Request ]=============================================
MID : 12635
@@ -615,15 +615,15 @@ If you execute the client multiple times, you will see different `node-id`s, whe
For the other two variants above, `Static Nodes` or `Dynamic Nodes`, the `cf-nat` may be used as load-balancer. In that cases, just use the address of the `cf-nat` as destination, e.g.
```sh
-java -jar cf-client-3.7.0.jar --method GET coaps://:5784/mycontext
+java -jar cf-client-3.8.0.jar --method GET coaps://:5784/mycontext
```
### Test the dtls-cid-cluster with Cf-NAT
-To test, that the dtls-cid-cluster even works, if the client's address is changed, such a address change can be simulated using [Cf-NAT](https://github.com/eclipse/californium/tree/main/cf-utils/cf-nat) (download available in the [Eclipse Release Repository](https://repo.eclipse.org/content/repositories/californium-releases/org/eclipse/californium/cf-nat/3.7.0/cf-nat-3.7.0.jar)).
+To test, that the dtls-cid-cluster even works, if the client's address is changed, such a address change can be simulated using [Cf-NAT](https://github.com/eclipse/californium/tree/main/cf-utils/cf-nat) (download available in the [Eclipse Release Repository](https://repo.eclipse.org/content/repositories/californium-releases/org/eclipse/californium/cf-nat/3.8.0/cf-nat-3.8.0.jar)).
```sh
-java -jar cf-nat-3.7.0.jar :5784 :30784
+java -jar cf-nat-3.8.0.jar :5784 :30784
```
Starts a NAT at port `5784`, forwarding the traffic to `:30784`.
@@ -641,7 +641,7 @@ remove - remove destination from load balancer
reverse (on|off) - enable/disable reverse address updates.
```
-Start two [cf-browser-3.7.0](https://repo.eclipse.org/content/repositories/californium-releases/org/eclipse/californium/cf-browser/3.7.0/cf-browser-3.7.0.jar) instances. Enter as destination `coaps://:5784/mycontext` and execute a `GET` in both clients. Do they show different `node-ids`? If not, restart one as long as you get two different `node-id`s. Also check, if the line with `read-cid` is missing. If so, the DTLS Connection ID support is not enabled. Check, if `DTLS_CONNECTION_ID_LENGTH` is set in "Californium3.properties" to a number. Even `0` will enable it. But a empty value disables the DTLS Connection ID support!
+Start two [cf-browser-3.8.0](https://repo.eclipse.org/content/repositories/californium-releases/org/eclipse/californium/cf-browser/3.8.0/cf-browser-3.8.0.jar) instances. Enter as destination `coaps://:5784/mycontext` and execute a `GET` in both clients. Do they show different `node-ids`? If not, restart one as long as you get two different `node-id`s. Also check, if the line with `read-cid` is missing. If so, the DTLS Connection ID support is not enabled. Check, if `DTLS_CONNECTION_ID_LENGTH` is set in "Californium3.properties" to a number. Even `0` will enable it. But a empty value disables the DTLS Connection ID support!
```
ip: ?.?.?.?
@@ -655,7 +655,7 @@ write-cid:
ext-master-secret: true
newest-record: true
message-size-limit: 1399
-server: Cf 3.7.0
+server: Cf 3.8.0
```
Now, press `` on the console of the NAT.
@@ -687,7 +687,7 @@ write-cid:
ext-master-secret: true
newest-record: true
message-size-limit: 1399
-server: Cf 3.7.0
+server: Cf 3.8.0
```
You may retry that, you should see the same ip-address/port (5-tuple), if you retry it within the NATs timeout (30s).
@@ -709,7 +709,7 @@ write-cid:
ext-master-secret: true
newest-record: true
message-size-limit: 1399
-server: Cf 3.7.0
+server: Cf 3.8.0
```
You may even restart the NAT, the coaps communication will still work.
@@ -829,7 +829,7 @@ An idea to improve that, is not to backward the records and instead send them di
The communication is routed through NATs/LoadBalancer. A entry for `IPa => IPb` can usually not be used to send a record back from `IPc`. The simple load-balancer `cf-nat` offers therefore the "reverse address update feature". With that, sending back a message with `IPc => IPa` is not only possible, it updates the load-balancer destination to the right `IPc` node for this client's traffic. This works for the first two setups `Static Notes` and `Dynamic Notes`, if the `cf-nat`is used as load-balancer and started with
```sh
-java -jar cf-nat-3.7.0.jar :5784 :15784 :25784 -r
+java -jar cf-nat-3.8.0.jar :5784 :15784 :25784 -r
```
To check, if reverse address update is enabled, press `` on the console of the NAT.
@@ -846,13 +846,13 @@ When starting the nodes, add `--no-dtls-cluster-backward`.
Node 1
```sh
-java -jar target/cf-extplugtest-server-3.7.0.jar --dtls-cluster ":15784;localhost:15884;1" --dtls-cluster-group="localhost:25884" --no-dtls-cluster-backward
+java -jar target/cf-extplugtest-server-3.8.0.jar --dtls-cluster ":15784;localhost:15884;1" --dtls-cluster-group="localhost:25884" --no-dtls-cluster-backward
```
Node 2
```sh
-java -jar target/cf-extplugtest-server-3.7.0.jar --dtls-cluster ":25784;localhost:15884;2" --dtls-cluster-group="localhost:15884" --no-dtls-cluster-backward
+java -jar target/cf-extplugtest-server-3.8.0.jar --dtls-cluster ":25784;localhost:15884;2" --dtls-cluster-group="localhost:15884" --no-dtls-cluster-backward
```
You may try out the benchmark above and `clear` the NAT during execution. The 20% penalty is gone! The cluster adjusts very fast the load-balancers NAT entries with the right address.
diff --git a/demo-apps/cf-extplugtest-server/pom.xml b/demo-apps/cf-extplugtest-server/pom.xml
index 549f735fcf..255c62b59a 100644
--- a/demo-apps/cf-extplugtest-server/pom.xml
+++ b/demo-apps/cf-extplugtest-server/pom.xml
@@ -8,7 +8,7 @@
org.eclipse.californium
demo-apps
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
cf-extplugtest-server
jar
diff --git a/demo-apps/cf-extplugtest-server/service/Dockerfile b/demo-apps/cf-extplugtest-server/service/Dockerfile
index ef8ca65bbc..488d6676de 100644
--- a/demo-apps/cf-extplugtest-server/service/Dockerfile
+++ b/demo-apps/cf-extplugtest-server/service/Dockerfile
@@ -16,11 +16,11 @@
#
# usage: docker build . -t service/Dockerfile
-FROM eclipse-temurin:17.0.2_8-jre
+FROM eclipse-temurin:17-jre-focal
RUN mkdir /opt/app
COPY ./service/build ./CaliforniumReceivetest3.properties /opt/app/
-COPY ./target/cf-extplugtest-server-3.8.0-SNAPSHOT.jar /opt/app/cf-extplugtest-server.jar
+COPY ./target/cf-extplugtest-server-3.9.0-SNAPSHOT.jar /opt/app/cf-extplugtest-server.jar
#EXPOSE 5683/udp
#EXPOSE 5683/tcp
diff --git a/demo-apps/cf-extplugtest-server/service/DockerfileNoCluster b/demo-apps/cf-extplugtest-server/service/DockerfileNoCluster
index 55d1264320..63f58d46af 100644
--- a/demo-apps/cf-extplugtest-server/service/DockerfileNoCluster
+++ b/demo-apps/cf-extplugtest-server/service/DockerfileNoCluster
@@ -17,11 +17,11 @@
#
# usage: docker build . -t service/DockerfileNoCluster
-FROM eclipse-temurin:17.0.4.1_1-jre
+FROM eclipse-temurin:17-jre-focal
RUN mkdir /opt/app
COPY ./service/build ./CaliforniumReceivetest3.properties /opt/app/
-COPY ./target/cf-extplugtest-server-3.8.0-SNAPSHOT.jar /opt/app/cf-extplugtest-server.jar
+COPY ./target/cf-extplugtest-server-3.9.0-SNAPSHOT.jar /opt/app/cf-extplugtest-server.jar
#EXPOSE 5683/udp
#EXPOSE 5683/tcp
diff --git a/demo-apps/cf-extplugtest-server/service/deploy_k8s.sh b/demo-apps/cf-extplugtest-server/service/deploy_k8s.sh
index c522601af5..1b15f58222 100755
--- a/demo-apps/cf-extplugtest-server/service/deploy_k8s.sh
+++ b/demo-apps/cf-extplugtest-server/service/deploy_k8s.sh
@@ -63,7 +63,7 @@ fi
: "${DOCKERFILE:=service/Dockerfile}"
CONTAINER=cf-extserver-jdk11-slim
-VERSION=3.8.0
+VERSION=3.9.0
if [ "$1" = "install" ] ; then
CONTAINER_VERSION="${CONTAINER}:${VERSION}"
diff --git a/demo-apps/cf-extplugtest-server/src/main/java/org/eclipse/californium/extplugtests/ExtendedTestServer.java b/demo-apps/cf-extplugtest-server/src/main/java/org/eclipse/californium/extplugtests/ExtendedTestServer.java
index 8381cc4de6..426ed419fb 100644
--- a/demo-apps/cf-extplugtest-server/src/main/java/org/eclipse/californium/extplugtests/ExtendedTestServer.java
+++ b/demo-apps/cf-extplugtest-server/src/main/java/org/eclipse/californium/extplugtests/ExtendedTestServer.java
@@ -92,7 +92,7 @@
import org.eclipse.californium.scandium.config.DtlsClusterConnectorConfig;
import org.eclipse.californium.scandium.config.DtlsConfig;
import org.eclipse.californium.scandium.config.DtlsConnectorConfig;
-import org.eclipse.californium.scandium.dtls.CertificateType;
+import org.eclipse.californium.scandium.dtls.cipher.CipherSuite;
import org.eclipse.californium.scandium.dtls.pskstore.AsyncAdvancedPskStore;
import org.eclipse.californium.scandium.dtls.x509.AsyncKeyManagerCertificateProvider;
import org.eclipse.californium.scandium.dtls.x509.AsyncNewAdvancedCertificateVerifier;
@@ -149,7 +149,6 @@ public void applyDefinitions(Configuration config) {
config.set(DtlsConfig.DTLS_RECOMMENDED_CIPHER_SUITES_ONLY, false);
config.set(DtlsConfig.DTLS_AUTO_HANDSHAKE_TIMEOUT, null, TimeUnit.SECONDS);
config.set(DtlsConfig.DTLS_CONNECTION_ID_LENGTH, 6);
- config.set(DtlsConfig.DTLS_SUPPORT_DEPRECATED_CID, true);
config.set(DtlsConfig.DTLS_PRESELECTED_CIPHER_SUITES, PlugtestServer.PRESELECTED_CIPHER_SUITES);
config.set(DtlsConfig.DTLS_RECEIVE_BUFFER_SIZE, 1000000);
config.set(DtlsConfig.DTLS_RECEIVER_THREAD_COUNT, processors > 3 ? 2 : 1);
@@ -157,7 +156,10 @@ public void applyDefinitions(Configuration config) {
config.set(DtlsConfig.DTLS_REMOVE_STALE_DOUBLE_PRINCIPALS, true);
config.set(DtlsConfig.DTLS_MAC_ERROR_FILTER_QUIET_TIME, 4, TimeUnit.SECONDS);
config.set(DtlsConfig.DTLS_MAC_ERROR_FILTER_THRESHOLD, 8);
- config.set(TcpConfig.TCP_CONNECTION_IDLE_TIMEOUT, 1, TimeUnit.HOURS);
+ config.set(DtlsConfig.DTLS_RETRANSMISSION_TIMEOUT, 3, TimeUnit.SECONDS);
+ config.set(DtlsConfig.DTLS_ADDITIONAL_ECC_TIMEOUT, 8, TimeUnit.SECONDS);
+ config.set(TcpConfig.TCP_CONNECT_TIMEOUT, 15, TimeUnit.SECONDS);
+ config.set(TcpConfig.TCP_CONNECTION_IDLE_TIMEOUT, 60, TimeUnit.MINUTES);
config.set(TcpConfig.TLS_HANDSHAKE_TIMEOUT, 60, TimeUnit.SECONDS);
config.set(SystemConfig.HEALTH_STATUS_INTERVAL, 60, TimeUnit.SECONDS);
config.set(UdpConfig.UDP_RECEIVER_THREAD_COUNT, processors > 3 ? 2 : 1);
@@ -379,12 +381,12 @@ public static void main(String[] args) {
long notifyIntervalMillis = config.getNotifyIntervalMillis();
- final ExtendedTestServer server = new ExtendedTestServer(configuration, protocolConfig, config.benchmark, notifyIntervalMillis);
+ final ExtendedTestServer server = new ExtendedTestServer(configuration, protocolConfig, config.benchmark,
+ notifyIntervalMillis);
server.setVersion(PlugtestServer.CALIFORNIUM_BUILD_VERSION);
server.setTag("EXTENDED-TEST");
server.setExecutors(executor, secondaryExecutor, false);
- server.add(
- new Echo(configuration.get(CoapConfig.MAX_RESOURCE_BODY_SIZE), config.echoDelay ? executor : null));
+ server.add(new Echo(configuration, config.echoDelay ? executor : null));
if (config.diagnose) {
server.add(new Diagnose(server));
}
@@ -523,7 +525,8 @@ protected InetSocketAddress getAddress(Endpoint endpoint) {
PlugtestServer.load(config);
// start standard plugtest server and shutdown
- CoapServer plugtestServer = PlugtestServer.start(executor, secondaryExecutor, config, configuration, socketObserver, null);
+ CoapServer plugtestServer = PlugtestServer.start(executor, secondaryExecutor, config, configuration,
+ socketObserver, null);
server.start();
server.addLogger(!config.benchmark);
@@ -696,6 +699,9 @@ private void addClusterEndpoint(ScheduledExecutorService secondaryExecutor, Inet
: InterfaceType.EXTERNAL;
Configuration configuration = getConfig(Protocol.DTLS, interfaceType);
String tag = "dtls:node-" + nodeId + ":" + StringUtil.toString(dtlsInterface);
+ List list = configuration.get(DtlsConfig.DTLS_CIPHER_SUITES);
+ boolean psk = list == null || CipherSuite.containsPskBasedCipherSuite(list);
+ boolean certificate = list == null || CipherSuite.containsCipherSuiteRequiringCertExchange(list);
int handshakeResultDelayMillis = configuration.getTimeAsInt(DTLS_HANDSHAKE_RESULT_DELAY, TimeUnit.MILLISECONDS);
long healthStatusIntervalMillis = configuration.get(SystemConfig.HEALTH_STATUS_INTERVAL, TimeUnit.MILLISECONDS);
Integer cidLength = configuration.get(DtlsConfig.DTLS_CONNECTION_ID_LENGTH);
@@ -704,36 +710,41 @@ private void addClusterEndpoint(ScheduledExecutorService secondaryExecutor, Inet
}
initCredentials();
DtlsConnectorConfig.Builder dtlsConfigBuilder = DtlsConnectorConfig.builder(configuration);
- if (cliConfig.clientAuth != null) {
- dtlsConfigBuilder.set(DtlsConfig.DTLS_CLIENT_AUTHENTICATION_MODE, cliConfig.clientAuth);
- }
+ dtlsConfigBuilder.setAddress(dtlsInterface);
+ dtlsConfigBuilder.setLoggingTag(tag);
+ dtlsConfigBuilder.setConnectionListener(new MdcConnectionListener());
+
// set node-id in dtls-config-builder's Configuration clone
dtlsConfigBuilder.set(DtlsConfig.DTLS_CONNECTION_ID_NODE_ID, nodeId);
- PlugPskStore pskStore = new PlugPskStore();
- if (cliConfig.pskFile != null) {
- pskStore.loadPskCredentials(cliConfig.pskFile);
+ if (psk || cliConfig.pskFile != null) {
+ PlugPskStore pskStore = new PlugPskStore();
+ if (cliConfig.pskFile != null) {
+ pskStore.loadPskCredentials(cliConfig.pskFile);
+ }
+ AsyncAdvancedPskStore asyncPskStore = new AsyncAdvancedPskStore(pskStore);
+ asyncPskStore.setDelay(handshakeResultDelayMillis);
+ dtlsConfigBuilder.setAdvancedPskStore(asyncPskStore);
+ }
+ if (certificate) {
+ if (cliConfig.clientAuth != null) {
+ dtlsConfigBuilder.set(DtlsConfig.DTLS_CLIENT_AUTHENTICATION_MODE, cliConfig.clientAuth);
+ }
+ X509KeyManager keyManager = SslContextUtil.getX509KeyManager(serverCredentials);
+ AsyncKeyManagerCertificateProvider certificateProvider = new AsyncKeyManagerCertificateProvider(keyManager,
+ configuration.get(DtlsConfig.DTLS_CERTIFICATE_TYPES));
+ certificateProvider.setDelay(handshakeResultDelayMillis);
+ dtlsConfigBuilder.setCertificateIdentityProvider(certificateProvider);
+ AsyncNewAdvancedCertificateVerifier.Builder verifierBuilder = AsyncNewAdvancedCertificateVerifier.builder();
+ if (cliConfig.trustall) {
+ verifierBuilder.setTrustAllCertificates();
+ } else {
+ verifierBuilder.setTrustedCertificates(trustedCertificates);
+ }
+ verifierBuilder.setTrustAllRPKs();
+ AsyncNewAdvancedCertificateVerifier verifier = verifierBuilder.build();
+ verifier.setDelay(handshakeResultDelayMillis);
+ dtlsConfigBuilder.setAdvancedCertificateVerifier(verifier);
}
- AsyncAdvancedPskStore asyncPskStore = new AsyncAdvancedPskStore(pskStore);
- asyncPskStore.setDelay(handshakeResultDelayMillis);
- dtlsConfigBuilder.setAdvancedPskStore(asyncPskStore);
- dtlsConfigBuilder.setAddress(dtlsInterface);
- X509KeyManager keyManager = SslContextUtil.getX509KeyManager(serverCredentials);
- AsyncKeyManagerCertificateProvider certificateProvider = new AsyncKeyManagerCertificateProvider(keyManager,
- CertificateType.RAW_PUBLIC_KEY, CertificateType.X_509);
- certificateProvider.setDelay(handshakeResultDelayMillis);
- dtlsConfigBuilder.setCertificateIdentityProvider(certificateProvider);
- AsyncNewAdvancedCertificateVerifier.Builder verifierBuilder = AsyncNewAdvancedCertificateVerifier.builder();
- if (cliConfig.trustall) {
- verifierBuilder.setTrustAllCertificates();
- } else {
- verifierBuilder.setTrustedCertificates(trustedCertificates);
- }
- verifierBuilder.setTrustAllRPKs();
- AsyncNewAdvancedCertificateVerifier verifier = verifierBuilder.build();
- verifier.setDelay(handshakeResultDelayMillis);
- dtlsConfigBuilder.setAdvancedCertificateVerifier(verifier);
- dtlsConfigBuilder.setConnectionListener(new MdcConnectionListener());
- dtlsConfigBuilder.setLoggingTag(tag);
if (healthStatusIntervalMillis > 0) {
DtlsClusterHealthLogger health = new DtlsClusterHealthLogger(tag);
dtlsConfigBuilder.setHealthHandler(health);
@@ -794,6 +805,9 @@ private void addEndpoint(InetSocketAddress dtlsInterface, BaseConfig cliConfig)
: InterfaceType.EXTERNAL;
Configuration configuration = getConfig(Protocol.DTLS, interfaceType);
String tag = "dtls:" + StringUtil.toString(dtlsInterface);
+ List list = configuration.get(DtlsConfig.DTLS_CIPHER_SUITES);
+ boolean psk = list == null || CipherSuite.containsPskBasedCipherSuite(list);
+ boolean certificate = list == null || CipherSuite.containsCipherSuiteRequiringCertExchange(list);
int handshakeResultDelayMillis = configuration.getTimeAsInt(DTLS_HANDSHAKE_RESULT_DELAY, TimeUnit.MILLISECONDS);
long healthStatusIntervalMillis = configuration.get(SystemConfig.HEALTH_STATUS_INTERVAL, TimeUnit.MILLISECONDS);
Integer cidLength = configuration.get(DtlsConfig.DTLS_CONNECTION_ID_LENGTH);
@@ -802,30 +816,39 @@ private void addEndpoint(InetSocketAddress dtlsInterface, BaseConfig cliConfig)
}
initCredentials();
DtlsConnectorConfig.Builder dtlsConfigBuilder = DtlsConnectorConfig.builder(configuration);
- if (cliConfig.clientAuth != null) {
- dtlsConfigBuilder.set(DtlsConfig.DTLS_CLIENT_AUTHENTICATION_MODE, cliConfig.clientAuth);
- }
- AsyncAdvancedPskStore asyncPskStore = new AsyncAdvancedPskStore(new PlugPskStore());
- asyncPskStore.setDelay(handshakeResultDelayMillis);
- dtlsConfigBuilder.setAdvancedPskStore(asyncPskStore);
dtlsConfigBuilder.setAddress(dtlsInterface);
- X509KeyManager keyManager = SslContextUtil.getX509KeyManager(serverCredentials);
- AsyncKeyManagerCertificateProvider certificateProvider = new AsyncKeyManagerCertificateProvider(keyManager,
- CertificateType.RAW_PUBLIC_KEY, CertificateType.X_509);
- certificateProvider.setDelay(handshakeResultDelayMillis);
- dtlsConfigBuilder.setCertificateIdentityProvider(certificateProvider);
- AsyncNewAdvancedCertificateVerifier.Builder verifierBuilder = AsyncNewAdvancedCertificateVerifier.builder();
- if (cliConfig.trustall) {
- verifierBuilder.setTrustAllCertificates();
- } else {
- verifierBuilder.setTrustedCertificates(trustedCertificates);
- }
- verifierBuilder.setTrustAllRPKs();
- AsyncNewAdvancedCertificateVerifier verifier = verifierBuilder.build();
- verifier.setDelay(handshakeResultDelayMillis);
- dtlsConfigBuilder.setAdvancedCertificateVerifier(verifier);
- dtlsConfigBuilder.setConnectionListener(new MdcConnectionListener());
dtlsConfigBuilder.setLoggingTag(tag);
+ dtlsConfigBuilder.setConnectionListener(new MdcConnectionListener());
+
+ if (psk) {
+ PlugPskStore pskStore = new PlugPskStore();
+ if (cliConfig.pskFile != null) {
+ pskStore.loadPskCredentials(cliConfig.pskFile);
+ }
+ AsyncAdvancedPskStore asyncPskStore = new AsyncAdvancedPskStore(pskStore);
+ asyncPskStore.setDelay(handshakeResultDelayMillis);
+ dtlsConfigBuilder.setAdvancedPskStore(asyncPskStore);
+ }
+ if (certificate) {
+ if (cliConfig.clientAuth != null) {
+ dtlsConfigBuilder.set(DtlsConfig.DTLS_CLIENT_AUTHENTICATION_MODE, cliConfig.clientAuth);
+ }
+ X509KeyManager keyManager = SslContextUtil.getX509KeyManager(serverCredentials);
+ AsyncKeyManagerCertificateProvider certificateProvider = new AsyncKeyManagerCertificateProvider(keyManager,
+ configuration.get(DtlsConfig.DTLS_CERTIFICATE_TYPES));
+ certificateProvider.setDelay(handshakeResultDelayMillis);
+ dtlsConfigBuilder.setCertificateIdentityProvider(certificateProvider);
+ AsyncNewAdvancedCertificateVerifier.Builder verifierBuilder = AsyncNewAdvancedCertificateVerifier.builder();
+ if (cliConfig.trustall) {
+ verifierBuilder.setTrustAllCertificates();
+ } else {
+ verifierBuilder.setTrustedCertificates(trustedCertificates);
+ }
+ verifierBuilder.setTrustAllRPKs();
+ AsyncNewAdvancedCertificateVerifier verifier = verifierBuilder.build();
+ verifier.setDelay(handshakeResultDelayMillis);
+ dtlsConfigBuilder.setAdvancedCertificateVerifier(verifier);
+ }
if (healthStatusIntervalMillis > 0) {
DtlsHealthLogger health = new DtlsHealthLogger(tag);
dtlsConfigBuilder.setHealthHandler(health);
diff --git a/demo-apps/cf-extplugtest-server/src/main/java/org/eclipse/californium/extplugtests/resources/Diagnose.java b/demo-apps/cf-extplugtest-server/src/main/java/org/eclipse/californium/extplugtests/resources/Diagnose.java
index 0bf42d0675..c2ae21b239 100644
--- a/demo-apps/cf-extplugtest-server/src/main/java/org/eclipse/californium/extplugtests/resources/Diagnose.java
+++ b/demo-apps/cf-extplugtest-server/src/main/java/org/eclipse/californium/extplugtests/resources/Diagnose.java
@@ -110,10 +110,7 @@ public void update(List serverHealth) {
}
for (ServerInterface server : serverList) {
for (Endpoint ep : server.getEndpoints()) {
- String scheme = ep.getUri().getScheme();
- if (CoAP.isUdpScheme(scheme)) {
- addHealth(ep, serverHealth);
- }
+ addHealth(ep, serverHealth);
}
}
}
diff --git a/demo-apps/cf-helloworld-client/pom.xml b/demo-apps/cf-helloworld-client/pom.xml
index 3d843ecc58..59c9b78a00 100755
--- a/demo-apps/cf-helloworld-client/pom.xml
+++ b/demo-apps/cf-helloworld-client/pom.xml
@@ -8,7 +8,7 @@
org.eclipse.californium
demo-apps
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
cf-helloworld-client
jar
diff --git a/demo-apps/cf-helloworld-server/pom.xml b/demo-apps/cf-helloworld-server/pom.xml
index 416cffe5f2..0dd2169e9a 100755
--- a/demo-apps/cf-helloworld-server/pom.xml
+++ b/demo-apps/cf-helloworld-server/pom.xml
@@ -8,7 +8,7 @@
org.eclipse.californium
demo-apps
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
cf-helloworld-server
jar
diff --git a/demo-apps/cf-plugtest-checker/pom.xml b/demo-apps/cf-plugtest-checker/pom.xml
index 3ff8d70135..28eaade11d 100755
--- a/demo-apps/cf-plugtest-checker/pom.xml
+++ b/demo-apps/cf-plugtest-checker/pom.xml
@@ -8,7 +8,7 @@
org.eclipse.californium
demo-apps
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
cf-plugtest-checker
jar
diff --git a/demo-apps/cf-plugtest-checker/src/main/java/org/eclipse/californium/plugtests/TestClientAbstract.java b/demo-apps/cf-plugtest-checker/src/main/java/org/eclipse/californium/plugtests/TestClientAbstract.java
index 2d7e98518a..b6785db33a 100644
--- a/demo-apps/cf-plugtest-checker/src/main/java/org/eclipse/californium/plugtests/TestClientAbstract.java
+++ b/demo-apps/cf-plugtest-checker/src/main/java/org/eclipse/californium/plugtests/TestClientAbstract.java
@@ -37,6 +37,8 @@
import org.eclipse.californium.core.coap.Request;
import org.eclipse.californium.core.coap.Response;
import org.eclipse.californium.core.coap.Token;
+import org.eclipse.californium.core.coap.option.OptionDefinition;
+import org.eclipse.californium.core.coap.option.StandardOptionRegistry;
import org.eclipse.californium.core.coap.CoAP.Type;
import org.eclipse.californium.core.coap.EndpointContextTracer;
import org.eclipse.californium.core.network.Endpoint;
@@ -726,13 +728,14 @@ protected boolean hasNoToken(Response response) {
}
protected boolean hasObserve(Response response) {
- return hasOption(response, OptionNumberRegistry.OBSERVE, false);
+ return hasOption(response, StandardOptionRegistry.OBSERVE, false);
}
protected boolean hasNoObserve(Response response) {
- return hasOption(response, OptionNumberRegistry.OBSERVE, true);
+ return hasOption(response, StandardOptionRegistry.OBSERVE, true);
}
+ @Deprecated
protected boolean hasOption(Response response, int optionNumber, boolean invert) {
String name = OptionNumberRegistry.toString(optionNumber);
List asSortedList = response.getOptions().asSortedList();
@@ -763,6 +766,36 @@ protected boolean hasOption(Response response, int optionNumber, boolean invert)
return success;
}
+ protected boolean hasOption(Response response, OptionDefinition optionDefintion, boolean invert) {
+ String name = optionDefintion.getName();
+ List asSortedList = response.getOptions().asSortedList();
+ Option match = null;
+ for (Option option : asSortedList) {
+ if (optionDefintion.equals(option.getDefinition())) {
+ match = option;
+ break;
+ }
+ }
+ // invert to check for not having the option
+ boolean success = match != null ^ invert;
+
+ StringBuilder result = new StringBuilder();
+ if (success) {
+ result.append("PASS: Response ");
+ } else {
+ result.append("FAIL: Response ");
+ }
+ if (match != null) {
+ result.append("with ");
+ result.append(name);
+ } else {
+ result.append("without ").append(name);
+ }
+ System.out.println(result);
+
+ return success;
+ }
+
protected boolean checkOption(Option expextedOption, Option actualOption) {
// boolean success = actualOption!=null &&
// expextedOption.getOptionNumber()==actualOption.getOptionNumber();
diff --git a/demo-apps/cf-plugtest-checker/src/main/java/org/eclipse/californium/plugtests/tests/OC01.java b/demo-apps/cf-plugtest-checker/src/main/java/org/eclipse/californium/plugtests/tests/OC01.java
index 2e591c4604..22db5f24b1 100644
--- a/demo-apps/cf-plugtest-checker/src/main/java/org/eclipse/californium/plugtests/tests/OC01.java
+++ b/demo-apps/cf-plugtest-checker/src/main/java/org/eclipse/californium/plugtests/tests/OC01.java
@@ -17,9 +17,9 @@
import org.eclipse.californium.core.coap.CoAP.ResponseCode;
import org.eclipse.californium.core.coap.CoAP.Type;
-import org.eclipse.californium.core.coap.OptionNumberRegistry;
import org.eclipse.californium.core.coap.Request;
import org.eclipse.californium.core.coap.Response;
+import org.eclipse.californium.core.coap.option.StandardOptionRegistry;
import org.eclipse.californium.elements.util.Bytes;
import org.eclipse.californium.plugtests.OscoreTest;
import org.eclipse.californium.plugtests.TestClientAbstract;
@@ -51,7 +51,7 @@ protected boolean checkResponse(Request request, Response response) {
success &= checkType(Type.ACK, response.getType());
success &= checkCode(EXPECTED_RESPONSE_CODE, response.getCode());
success &= checkInt(request.getMID(), response.getMID(), "MID");
- success &= hasOption(response, OptionNumberRegistry.OSCORE, false);
+ success &= hasOption(response, StandardOptionRegistry.OSCORE, false);
success &= hasContentType(response);
success &= hasNonEmptyPayload(response);
diff --git a/demo-apps/cf-plugtest-checker/src/main/java/org/eclipse/californium/plugtests/tests/OC02.java b/demo-apps/cf-plugtest-checker/src/main/java/org/eclipse/californium/plugtests/tests/OC02.java
index f19c386f8e..c17bbb848c 100644
--- a/demo-apps/cf-plugtest-checker/src/main/java/org/eclipse/californium/plugtests/tests/OC02.java
+++ b/demo-apps/cf-plugtest-checker/src/main/java/org/eclipse/californium/plugtests/tests/OC02.java
@@ -17,9 +17,9 @@
import org.eclipse.californium.core.coap.CoAP.ResponseCode;
import org.eclipse.californium.core.coap.CoAP.Type;
-import org.eclipse.californium.core.coap.OptionNumberRegistry;
import org.eclipse.californium.core.coap.Request;
import org.eclipse.californium.core.coap.Response;
+import org.eclipse.californium.core.coap.option.StandardOptionRegistry;
import org.eclipse.californium.elements.util.Bytes;
import org.eclipse.californium.plugtests.OscoreTest;
import org.eclipse.californium.plugtests.TestClientAbstract;
@@ -51,7 +51,7 @@ protected boolean checkResponse(Request request, Response response) {
success &= checkType(Type.ACK, response.getType());
success &= checkCode(EXPECTED_RESPONSE_CODE, response.getCode());
success &= checkInt(request.getMID(), response.getMID(), "MID");
- success &= hasOption(response, OptionNumberRegistry.OSCORE, false);
+ success &= hasOption(response, StandardOptionRegistry.OSCORE, false);
return success;
}
diff --git a/demo-apps/cf-plugtest-checker/src/main/java/org/eclipse/californium/plugtests/tests/OC03.java b/demo-apps/cf-plugtest-checker/src/main/java/org/eclipse/californium/plugtests/tests/OC03.java
index ca955a113b..9e2bd3fe84 100644
--- a/demo-apps/cf-plugtest-checker/src/main/java/org/eclipse/californium/plugtests/tests/OC03.java
+++ b/demo-apps/cf-plugtest-checker/src/main/java/org/eclipse/californium/plugtests/tests/OC03.java
@@ -18,9 +18,9 @@
import org.eclipse.californium.core.coap.CoAP.ResponseCode;
import org.eclipse.californium.core.coap.CoAP.Type;
import org.eclipse.californium.core.coap.MediaTypeRegistry;
-import org.eclipse.californium.core.coap.OptionNumberRegistry;
import org.eclipse.californium.core.coap.Request;
import org.eclipse.californium.core.coap.Response;
+import org.eclipse.californium.core.coap.option.StandardOptionRegistry;
import org.eclipse.californium.elements.util.Bytes;
import org.eclipse.californium.plugtests.OscoreTest;
import org.eclipse.californium.plugtests.TestClientAbstract;
@@ -54,7 +54,7 @@ protected boolean checkResponse(Request request, Response response) {
success &= checkType(Type.ACK, response.getType());
success &= checkCode(EXPECTED_RESPONSE_CODE, response.getCode());
success &= checkInt(request.getMID(), response.getMID(), "MID");
- success &= hasOption(response, OptionNumberRegistry.OSCORE, false);
+ success &= hasOption(response, StandardOptionRegistry.OSCORE, false);
return success;
}
diff --git a/demo-apps/cf-plugtest-client/pom.xml b/demo-apps/cf-plugtest-client/pom.xml
index 22a367e9db..0a26720a22 100755
--- a/demo-apps/cf-plugtest-client/pom.xml
+++ b/demo-apps/cf-plugtest-client/pom.xml
@@ -8,7 +8,7 @@
org.eclipse.californium
demo-apps
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
cf-plugtest-client
jar
diff --git a/demo-apps/cf-plugtest-server/pom.xml b/demo-apps/cf-plugtest-server/pom.xml
index 997f27eb0c..cfa357e43f 100755
--- a/demo-apps/cf-plugtest-server/pom.xml
+++ b/demo-apps/cf-plugtest-server/pom.xml
@@ -8,7 +8,7 @@
org.eclipse.californium
demo-apps
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
cf-plugtest-server
jar
diff --git a/demo-apps/cf-plugtest-server/src/main/java/org/eclipse/californium/plugtests/AbstractTestServer.java b/demo-apps/cf-plugtest-server/src/main/java/org/eclipse/californium/plugtests/AbstractTestServer.java
index 78e8d41748..493cf42084 100644
--- a/demo-apps/cf-plugtest-server/src/main/java/org/eclipse/californium/plugtests/AbstractTestServer.java
+++ b/demo-apps/cf-plugtest-server/src/main/java/org/eclipse/californium/plugtests/AbstractTestServer.java
@@ -62,10 +62,10 @@
import org.eclipse.californium.scandium.MdcConnectionListener;
import org.eclipse.californium.scandium.config.DtlsConfig;
import org.eclipse.californium.scandium.config.DtlsConnectorConfig;
-import org.eclipse.californium.scandium.dtls.CertificateType;
import org.eclipse.californium.scandium.dtls.ConnectionId;
import org.eclipse.californium.scandium.dtls.PskPublicInformation;
import org.eclipse.californium.scandium.dtls.PskSecretResult;
+import org.eclipse.californium.scandium.dtls.cipher.CipherSuite;
import org.eclipse.californium.scandium.dtls.pskstore.AsyncAdvancedPskStore;
import org.eclipse.californium.scandium.dtls.pskstore.MultiPskFileStore;
import org.eclipse.californium.scandium.dtls.resumption.AsyncResumptionVerifier;
@@ -320,38 +320,45 @@ public void addEndpoints(BaseConfig cliConfig) {
TimeUnit.MILLISECONDS);
DtlsConnectorConfig.Builder dtlsConfigBuilder = DtlsConnectorConfig.builder(dtlsConfig);
- if (cliConfig.clientAuth != null) {
- dtlsConfigBuilder.set(DtlsConfig.DTLS_CLIENT_AUTHENTICATION_MODE, cliConfig.clientAuth);
- }
+ dtlsConfigBuilder.setAddress(bindToAddress);
String tag = "dtls:" + StringUtil.toString(bindToAddress);
dtlsConfigBuilder.setLoggingTag(tag);
- PlugPskStore pskStore = new PlugPskStore();
- if (cliConfig.pskFile != null) {
- pskStore.loadPskCredentials(cliConfig.pskFile);
+ List list = dtlsConfig.get(DtlsConfig.DTLS_CIPHER_SUITES);
+ boolean psk = list == null || CipherSuite.containsPskBasedCipherSuite(list);
+ boolean certificate = list == null || CipherSuite.containsCipherSuiteRequiringCertExchange(list);
+ if (psk || cliConfig.pskFile != null) {
+ PlugPskStore pskStore = new PlugPskStore();
+ if (cliConfig.pskFile != null) {
+ pskStore.loadPskCredentials(cliConfig.pskFile);
+ }
+ AsyncAdvancedPskStore asyncPskStore = new AsyncAdvancedPskStore(pskStore);
+ asyncPskStore.setDelay(handshakeResultDelayMillis);
+ dtlsConfigBuilder.setAdvancedPskStore(asyncPskStore);
}
- AsyncAdvancedPskStore asyncPskStore = new AsyncAdvancedPskStore(pskStore);
- asyncPskStore.setDelay(handshakeResultDelayMillis);
- dtlsConfigBuilder.setAdvancedPskStore(asyncPskStore);
- dtlsConfigBuilder.setAddress(bindToAddress);
- X509KeyManager keyManager = SslContextUtil.getX509KeyManager(serverCredentials);
- AsyncKeyManagerCertificateProvider certificateProvider = new AsyncKeyManagerCertificateProvider(
- keyManager, CertificateType.RAW_PUBLIC_KEY, CertificateType.X_509);
- certificateProvider.setDelay(handshakeResultDelayMillis);
- dtlsConfigBuilder.setCertificateIdentityProvider(certificateProvider);
- AsyncNewAdvancedCertificateVerifier.Builder verifierBuilder = AsyncNewAdvancedCertificateVerifier
- .builder();
- if (cliConfig.trustall) {
- verifierBuilder.setTrustAllCertificates();
- } else {
- verifierBuilder.setTrustedCertificates(trustedCertificates);
+ if (certificate) {
+ if (cliConfig.clientAuth != null) {
+ dtlsConfigBuilder.set(DtlsConfig.DTLS_CLIENT_AUTHENTICATION_MODE, cliConfig.clientAuth);
+ }
+ X509KeyManager keyManager = SslContextUtil.getX509KeyManager(serverCredentials);
+ AsyncKeyManagerCertificateProvider certificateProvider = new AsyncKeyManagerCertificateProvider(
+ keyManager, dtlsConfig.get(DtlsConfig.DTLS_CERTIFICATE_TYPES));
+ certificateProvider.setDelay(handshakeResultDelayMillis);
+ dtlsConfigBuilder.setCertificateIdentityProvider(certificateProvider);
+ AsyncNewAdvancedCertificateVerifier.Builder verifierBuilder = AsyncNewAdvancedCertificateVerifier
+ .builder();
+ if (cliConfig.trustall) {
+ verifierBuilder.setTrustAllCertificates();
+ } else {
+ verifierBuilder.setTrustedCertificates(trustedCertificates);
+ }
+ verifierBuilder.setTrustAllRPKs();
+ AsyncNewAdvancedCertificateVerifier verifier = verifierBuilder.build();
+ verifier.setDelay(handshakeResultDelayMillis);
+ dtlsConfigBuilder.setAdvancedCertificateVerifier(verifier);
+ AsyncResumptionVerifier resumptionVerifier = new AsyncResumptionVerifier();
+ resumptionVerifier.setDelay(handshakeResultDelayMillis);
+ dtlsConfigBuilder.setResumptionVerifier(resumptionVerifier);
}
- verifierBuilder.setTrustAllRPKs();
- AsyncNewAdvancedCertificateVerifier verifier = verifierBuilder.build();
- verifier.setDelay(handshakeResultDelayMillis);
- dtlsConfigBuilder.setAdvancedCertificateVerifier(verifier);
- AsyncResumptionVerifier resumptionVerifier = new AsyncResumptionVerifier();
- resumptionVerifier.setDelay(handshakeResultDelayMillis);
- dtlsConfigBuilder.setResumptionVerifier(resumptionVerifier);
dtlsConfigBuilder.setConnectionListener(new MdcConnectionListener());
if (dtlsConfig.get(SystemConfig.HEALTH_STATUS_INTERVAL, TimeUnit.MILLISECONDS) > 0) {
DtlsHealthLogger health = new DtlsHealthLogger(tag);
diff --git a/demo-apps/cf-plugtest-server/src/main/java/org/eclipse/californium/plugtests/PlugtestServer.java b/demo-apps/cf-plugtest-server/src/main/java/org/eclipse/californium/plugtests/PlugtestServer.java
index f5da30a2c9..bec641b039 100755
--- a/demo-apps/cf-plugtest-server/src/main/java/org/eclipse/californium/plugtests/PlugtestServer.java
+++ b/demo-apps/cf-plugtest-server/src/main/java/org/eclipse/californium/plugtests/PlugtestServer.java
@@ -160,8 +160,15 @@ public void applyDefinitions(Configuration config) {
config.set(DtlsConfig.DTLS_SUPPORT_DEPRECATED_CID, true);
config.set(DtlsConfig.DTLS_PRESELECTED_CIPHER_SUITES, PRESELECTED_CIPHER_SUITES);
config.set(DtlsConfig.DTLS_MAX_CONNECTIONS, 10000);
- config.set(DtlsConfig.DTLS_READ_WRITE_LOCK_CONNECTION_STORE, false);
+ config.set(DtlsConfig.DTLS_READ_WRITE_LOCK_CONNECTION_STORE, true);
config.set(DtlsConfig.DTLS_REMOVE_STALE_DOUBLE_PRINCIPALS, false);
+ config.set(DtlsConfig.DTLS_MAC_ERROR_FILTER_QUIET_TIME, 4, TimeUnit.SECONDS);
+ config.set(DtlsConfig.DTLS_MAC_ERROR_FILTER_THRESHOLD, 8);
+ config.set(DtlsConfig.DTLS_RETRANSMISSION_TIMEOUT, 3, TimeUnit.SECONDS);
+ config.set(DtlsConfig.DTLS_ADDITIONAL_ECC_TIMEOUT, 8, TimeUnit.SECONDS);
+ config.set(TcpConfig.TCP_CONNECT_TIMEOUT, 15, TimeUnit.SECONDS);
+ config.set(TcpConfig.TCP_CONNECTION_IDLE_TIMEOUT, 60, TimeUnit.MINUTES);
+ config.set(TcpConfig.TLS_HANDSHAKE_TIMEOUT, 60, TimeUnit.SECONDS);
config.set(EXTERNAL_UDP_MAX_MESSAGE_SIZE, 64);
config.set(EXTERNAL_UDP_PREFERRED_BLOCK_SIZE, 64);
config.set(UDP_DROPS_READ_INTERVAL, 2000, TimeUnit.MILLISECONDS);
@@ -490,8 +497,7 @@ public static AbstractTestServer start(ScheduledExecutorService mainExecutor, Sc
if (observer != null) {
server.addDefaultEndpointObserver(observer);
}
- server.add(new Echo(configuration.get(CoapConfig.MAX_RESOURCE_BODY_SIZE),
- config.echoDelay ? mainExecutor : null));
+ server.add(new Echo(configuration, config.echoDelay ? mainExecutor : null));
server.start();
server.addLogger(true);
diff --git a/demo-apps/cf-plugtest-server/src/main/java/org/eclipse/californium/plugtests/resources/Echo.java b/demo-apps/cf-plugtest-server/src/main/java/org/eclipse/californium/plugtests/resources/Echo.java
index 9a3f30798c..c7e43b089a 100644
--- a/demo-apps/cf-plugtest-server/src/main/java/org/eclipse/californium/plugtests/resources/Echo.java
+++ b/demo-apps/cf-plugtest-server/src/main/java/org/eclipse/californium/plugtests/resources/Echo.java
@@ -17,6 +17,8 @@
import static org.eclipse.californium.core.coap.CoAP.ResponseCode.BAD_OPTION;
import static org.eclipse.californium.core.coap.CoAP.ResponseCode.CHANGED;
+import static org.eclipse.californium.core.coap.CoAP.ResponseCode.CONTENT;
+import static org.eclipse.californium.core.coap.CoAP.ResponseCode.DELETED;
import static org.eclipse.californium.core.coap.CoAP.ResponseCode.NOT_ACCEPTABLE;
import static org.eclipse.californium.core.coap.CoAP.ResponseCode.SERVICE_UNAVAILABLE;
import static org.eclipse.californium.core.coap.MediaTypeRegistry.APPLICATION_LINK_FORMAT;
@@ -35,13 +37,16 @@
import java.util.concurrent.atomic.AtomicInteger;
import org.eclipse.californium.core.CoapResource;
-import org.eclipse.californium.core.coap.CoAP.ResponseCode;
import org.eclipse.californium.core.coap.LinkFormat;
import org.eclipse.californium.core.coap.MediaTypeRegistry;
import org.eclipse.californium.core.coap.Request;
+import org.eclipse.californium.core.coap.Response;
import org.eclipse.californium.core.coap.UriQueryParameter;
+import org.eclipse.californium.core.config.CoapConfig;
import org.eclipse.californium.core.server.resources.CoapExchange;
import org.eclipse.californium.core.server.resources.Resource;
+import org.eclipse.californium.core.server.resources.ResourceAttributes;
+import org.eclipse.californium.elements.config.Configuration;
import org.eclipse.californium.elements.util.LeastRecentlyUsedCache;
/**
@@ -54,6 +59,7 @@
* "ack" : use separate ACK and response.
* "delay=n" : milliseconds to delay the response.
* "keep" : keep post to be read with GET.
+ * "id" : identity to be used the keep the post, if the encryption based principal is missing.
*
*
* Supported content types:
@@ -87,11 +93,15 @@ public class Echo extends CoapResource {
* URI query parameter to keep the POST for later GET.
*/
private static final String URI_QUERY_OPTION_KEEP = "keep";
+ /**
+ * URI query parameter providing a id to keep the POST for later GET.
+ */
+ private static final String URI_QUERY_OPTION_ID = "id";
/**
* Supported query parameter.
*/
private static final List SUPPORTED = Arrays.asList(URI_QUERY_OPTION_ACK, URI_QUERY_OPTION_DELAY,
- URI_QUERY_OPTION_RESPONSE_LENGTH, URI_QUERY_OPTION_KEEP);
+ URI_QUERY_OPTION_RESPONSE_LENGTH, URI_QUERY_OPTION_KEEP, URI_QUERY_OPTION_ID);
/**
* Maximum pending delayed responses.
*/
@@ -115,14 +125,14 @@ public class Echo extends CoapResource {
/**
* Create echo resource.
*
- * @param maxResourceSize maximum resource size.
+ * @param config Configuration for this resource.
* @param executor scheduler for delayed responses. {@code null}, if delay
* is not supported.
*/
- public Echo(int maxResourceSize, ScheduledExecutorService executor) {
+ public Echo(Configuration config, ScheduledExecutorService executor) {
super(RESOURCE_NAME);
this.executor = executor;
- this.maxResourceSize = maxResourceSize;
+ this.maxResourceSize = config.get(CoapConfig.MAX_RESOURCE_BODY_SIZE);
getAttributes().setTitle("Resource, which echo's a POST. POSTs with URI-query 'keep' can later be read by GET");
getAttributes().addContentType(TEXT_PLAIN);
getAttributes().addContentType(APPLICATION_OCTET_STREAM);
@@ -162,7 +172,10 @@ public void handleGET(final CoapExchange exchange) {
if (accept != UNDEFINED && accept != APPLICATION_LINK_FORMAT) {
exchange.respond(NOT_ACCEPTABLE);
} else {
- exchange.respond(ResponseCode.CONTENT, LinkFormat.serializeTree(this), APPLICATION_LINK_FORMAT);
+ Response response = new Response(CONTENT);
+ response.setPayload(LinkFormat.serializeTree(this));
+ response.getOptions().setContentFormat(APPLICATION_LINK_FORMAT);
+ exchange.respond(response);
}
}
@@ -192,6 +205,7 @@ public void handlePOST(final CoapExchange exchange) {
boolean ack = false;
boolean keep = false;
+ String id = null;
int length = 0;
int delay = 0;
try {
@@ -200,6 +214,7 @@ public void handlePOST(final CoapExchange exchange) {
length = helper.getArgumentAsInteger(URI_QUERY_OPTION_RESPONSE_LENGTH, 0, 0, maxResourceSize);
delay = helper.getArgumentAsInteger(URI_QUERY_OPTION_DELAY, 0, 0, (int) TimeUnit.SECONDS.toMillis(3600));
keep = helper.hasParameter(URI_QUERY_OPTION_KEEP);
+ id = helper.getArgument(URI_QUERY_OPTION_ID, null);
} catch (IllegalArgumentException ex) {
exchange.respond(BAD_OPTION, ex.getMessage());
return;
@@ -215,14 +230,18 @@ public void handlePOST(final CoapExchange exchange) {
}
if (keep) {
String principal = getPrincipalName(request);
+ if (principal == null) {
+ principal = id;
+ }
if (principal != null) {
request.setProtectFromOffload();
synchronized (keptPosts) {
Resource child = keptPosts.get(principal);
- if (child instanceof Keep) {
- ((Keep) child).setPost(request);
- } else {
- child = new Keep(principal, request);
+ if (!(child instanceof Keep)) {
+ child = new Keep(principal);
+ }
+ ((Keep) child).setPost(request);
+ if (child.getParent() == null) {
child.setParent(this);
keptPosts.put(principal, child);
}
@@ -230,6 +249,9 @@ public void handlePOST(final CoapExchange exchange) {
}
}
final int responseFormat = accept;
+ final Response response = new Response(CHANGED);
+ response.setPayload(responsePayload);
+ response.getOptions().setContentFormat(responseFormat);
if (delay > 0 && executor != null) {
boolean schedule = false;
if (pendingResponses.get() < MAX_PENDING_RESPONSES - 1) {
@@ -240,20 +262,20 @@ public void handlePOST(final CoapExchange exchange) {
}
}
if (schedule) {
- Runnable response = new Runnable() {
+ Runnable respond = new Runnable() {
@Override
public void run() {
- exchange.respond(CHANGED, responsePayload, responseFormat);
+ exchange.respond(response);
pendingResponses.decrementAndGet();
}
};
- executor.schedule(response, delay, TimeUnit.MILLISECONDS);
+ executor.schedule(respond, delay, TimeUnit.MILLISECONDS);
} else {
exchange.respond(SERVICE_UNAVAILABLE, "Too many delayed responses pending!");
}
} else {
- exchange.respond(CHANGED, responsePayload, responseFormat);
+ exchange.respond(response);
}
}
@@ -265,23 +287,24 @@ private static String getPrincipalName(Request request) {
return null;
}
- private static class Keep extends CoapResource {
+ private class Keep extends CoapResource {
private volatile Request post;
- private Keep(String principal, Request post) {
+ private Keep(String principal) {
super(principal);
setObservable(true);
- setPost(post);
}
public void setPost(Request post) {
this.post = post;
- getAttributes().clearContentType();
+ ResourceAttributes attributes = getAttributes();
+ attributes.clearContentType();
if (post.getOptions().hasContentFormat()) {
- getAttributes().addContentType(post.getOptions().getContentFormat());
+ attributes.addContentType(post.getOptions().getContentFormat());
}
- getAttributes().setAttribute("time", DATE_FORMAT.format(new Date()));
+ attributes.setAttribute("time", DATE_FORMAT.format(new Date()));
+ attributes.setAttribute("scheme", post.getScheme());
changed();
}
@@ -303,9 +326,19 @@ public void handleGET(final CoapExchange exchange) {
exchange.respond(NOT_ACCEPTABLE);
return;
}
- exchange.respond(CHANGED, devicePost.getPayload(), accept);
+ Response response = new Response(CONTENT);
+ response.setPayload(devicePost.getPayload());
+ response.getOptions().setContentFormat(accept);
+ exchange.respond(response);
}
+ @Override
+ public void handleDELETE(CoapExchange exchange) {
+ synchronized (keptPosts) {
+ keptPosts.remove(getName(), this);
+ }
+ exchange.respond(DELETED);
+ }
}
}
diff --git a/demo-apps/cf-plugtest-server/src/main/java/org/eclipse/californium/plugtests/resources/LargeCreate.java b/demo-apps/cf-plugtest-server/src/main/java/org/eclipse/californium/plugtests/resources/LargeCreate.java
index ab7f92ac59..75dddf3e6c 100755
--- a/demo-apps/cf-plugtest-server/src/main/java/org/eclipse/californium/plugtests/resources/LargeCreate.java
+++ b/demo-apps/cf-plugtest-server/src/main/java/org/eclipse/californium/plugtests/resources/LargeCreate.java
@@ -107,6 +107,7 @@ public void handleGET(CoapExchange exchange) {
@Override
public void handleDELETE(CoapExchange exchange) {
this.delete();
+ exchange.respond(DELETED);
}
}
diff --git a/demo-apps/cf-proxy2/README.md b/demo-apps/cf-proxy2/README.md
index cde46a7880..018838eeb1 100644
--- a/demo-apps/cf-proxy2/README.md
+++ b/demo-apps/cf-proxy2/README.md
@@ -9,7 +9,7 @@ The ExampleCrossProxy2 demonstrates the functions of the [californium-proxy2](..
Start the proxy:
```sh
-java -jar cf-proxy2-3.7.0.jar ExampleCrossProxy2 coap http
+java -jar cf-proxy2-3.8.0.jar ExampleCrossProxy2 coap http
```
This starts the example cross-proxy and a co-located coap- and http-destination-server.
@@ -17,13 +17,13 @@ This starts the example cross-proxy and a co-located coap- and http-destination-
Start a example coap-client (same host as proxy):
```sh
-java -jar cf-proxy2-3.7.0.jar ExampleProxy2CoapClient
+java -jar cf-proxy2-3.8.0.jar ExampleProxy2CoapClient
```
Start a example http-client (same host as proxy):
```sh
-java -jar cf-proxy2-3.7.0.jar ExampleProxy2HttpClient
+java -jar cf-proxy2-3.8.0.jar ExampleProxy2HttpClient
```
To test other setups requires to edit the examples and build them on your own.
@@ -33,7 +33,7 @@ To test other setups requires to edit the examples and build them on your own.
Start the proxy:
```sh
-java -jar cf-proxy2-3.7.0.jar ExampleSecureProxy2 coaps
+java -jar cf-proxy2-3.8.0.jar ExampleSecureProxy2 coaps
```
This starts the example cross-proxy and a co-located coaps-destination-server.
@@ -41,6 +41,6 @@ This starts the example cross-proxy and a co-located coaps-destination-server.
Start a example coaps-client (same host as proxy):
```sh
-java -jar cf-proxy2-3.7.0.jar ExampleSecureProxy2CoapClient
+java -jar cf-proxy2-3.8.0.jar ExampleSecureProxy2CoapClient
```
diff --git a/demo-apps/cf-proxy2/pom.xml b/demo-apps/cf-proxy2/pom.xml
index 3b25b373b7..5d9f9f732b 100644
--- a/demo-apps/cf-proxy2/pom.xml
+++ b/demo-apps/cf-proxy2/pom.xml
@@ -8,7 +8,7 @@
org.eclipse.californium
demo-apps
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
cf-proxy2
jar
diff --git a/demo-apps/cf-secure/pom.xml b/demo-apps/cf-secure/pom.xml
index 5565f3d8bb..e6cb96b921 100755
--- a/demo-apps/cf-secure/pom.xml
+++ b/demo-apps/cf-secure/pom.xml
@@ -8,7 +8,7 @@
org.eclipse.californium
demo-apps
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
cf-secure
jar
diff --git a/demo-apps/cf-simplefile-server/README.md b/demo-apps/cf-simplefile-server/README.md
index be55196e92..fcea7c65a3 100644
--- a/demo-apps/cf-simplefile-server/README.md
+++ b/demo-apps/cf-simplefile-server/README.md
@@ -10,14 +10,14 @@ Please refer to the eclipse Californium project page for license, build, and ins
## Download
-[Eclipse Release Repository](https://repo.eclipse.org/content/repositories/californium-releases/org/eclipse/californium/cf-simplefile-server/3.7.0/cf-simplefile-server-3.7.0.jar)
+[Eclipse Release Repository](https://repo.eclipse.org/content/repositories/californium-releases/org/eclipse/californium/cf-simplefile-server/3.8.0/cf-simplefile-server-3.8.0.jar)
## PREPARATION
Generate "Californium.properties" using
```sh
-java -jar cf-simplefile-server-3.7.0.jar
+java -jar cf-simplefile-server-3.8.0.jar
```
Adjust properties according you setup/environment, at least adjust "MAX_RESOURCE_BODY_SIZE"
@@ -28,7 +28,7 @@ Create a folder ("data" by default), and place the file(s) in that folder.
## RUN
```sh
-java -jar cf-simplefile-server-3.7.0.jar [--file-root=] [--path-root=]
+java -jar cf-simplefile-server-3.8.0.jar [--file-root=] [--path-root=]
```
Default for both roots is: "data".
@@ -43,7 +43,7 @@ URL: coap:////
e.g (using `cf-helloworld-client`)
```sh
-java -jar cf-helloworld-client-3.7.0.jar GETClient coap://localhost/data/file.bin file2save.bin
+java -jar cf-helloworld-client-3.8.0.jar GETClient coap://localhost/data/file.bin file2save.bin
```
(GET file "file.bin" from file-root-directory).
@@ -102,7 +102,7 @@ Options:
With that, the file system tree below `/home/cali/data` is used and the sub-path of URIs `coap:///files/` are used to locate the file within that tree.
```
-java -jar cf-simplefile-server-3.7.0.jar --file-root=/home/cali/data --path-root=files --no-tcp
+java -jar cf-simplefile-server-3.8.0.jar --file-root=/home/cali/data --path-root=files --no-tcp
INFO [SimpleFileServer]: GET: coap:///files/cf_64.png
INFO [SimpleFileServer]: GET: coap:///files/README.md
@@ -110,14 +110,14 @@ INFO [SimpleFileServer]: GET: coap:///files/fw/device.hex
```
```
-java -jar cf-helloworld-client-3.7.0.jar GETClient coap://localhost/files/cf_64.png picture2save.png
-java -jar cf-helloworld-client-3.7.0.jar GETClient coap://localhost/files/fw/device.hex firmware.hex
+java -jar cf-helloworld-client-3.8.0.jar GETClient coap://localhost/files/cf_64.png picture2save.png
+java -jar cf-helloworld-client-3.8.0.jar GETClient coap://localhost/files/fw/device.hex firmware.hex
```
Access files out of the file system sub-tree results in an error response.
```
-java -jar cf-helloworld-client-3.7.0.jar GETClient coap://localhost/files/../../other/top-secret.txt steal.txt
+java -jar cf-helloworld-client-3.8.0.jar GETClient coap://localhost/files/../../other/top-secret.txt steal.txt
4.01 - UNAUTHORIZED
```
diff --git a/demo-apps/cf-simplefile-server/pom.xml b/demo-apps/cf-simplefile-server/pom.xml
index 372f161232..a219682ceb 100644
--- a/demo-apps/cf-simplefile-server/pom.xml
+++ b/demo-apps/cf-simplefile-server/pom.xml
@@ -8,7 +8,7 @@
org.eclipse.californium
demo-apps
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
cf-simplefile-server
jar
diff --git a/demo-apps/cf-unix-setup/README.md b/demo-apps/cf-unix-setup/README.md
index 6545a4b8f2..ffe3f6898d 100644
--- a/demo-apps/cf-unix-setup/README.md
+++ b/demo-apps/cf-unix-setup/README.md
@@ -29,7 +29,7 @@ The variant and version may vary, but usually all from java "1.7" on will do it
sudo apt install openjdk-11-jre-headless
```
-and check the result again with `java -version`. If that's done, then copy your californium.jar to the host. If you want to run the cf-plugtest-server, it's the "/demo-apps/run/cf-plugtest-server-???.jar" (replace the ??? with the version your using, e.g. 3.7.0). The [cf-plugtest-server-3.7.0.jar](https://repo.eclipse.org/content/repositories/californium-releases/org/eclipse/californium/cf-plugtest-server/3.7.0/cf-plugtest-server-3.7.0.jar) is also available for download.
+and check the result again with `java -version`. If that's done, then copy your californium.jar to the host. If you want to run the cf-plugtest-server, it's the "/demo-apps/run/cf-plugtest-server-???.jar" (replace the ??? with the version your using, e.g. 3.8.0). The [cf-plugtest-server-3.8.0.jar](https://repo.eclipse.org/content/repositories/californium-releases/org/eclipse/californium/cf-plugtest-server/3.8.0/cf-plugtest-server-3.8.0.jar) is also available for download.
### Preparation
@@ -115,7 +115,7 @@ users:
runcmd:
- [ wget, "https://github.com/eclipse/californium/raw/main/demo-apps/cf-unix-setup/scripts/cali.service", -O, "/etc/systemd/system/cali.service" ]
- - [ wget, "https://repo.eclipse.org/content/repositories/californium-releases/org/eclipse/californium/cf-plugtest-server/3.7.0/cf-plugtest-server-3.7.0.jar", -O, "/home/cali/cf-plugtest-server-update.jar" ]
+ - [ wget, "https://repo.eclipse.org/content/repositories/californium-releases/org/eclipse/californium/cf-plugtest-server/3.8.0/cf-plugtest-server-3.8.0.jar", -O, "/home/cali/cf-plugtest-server-update.jar" ]
- [ wget, "https://github.com/eclipse/californium/raw/main/demo-apps/cf-plugtest-server/src/main/resources/logback.xml", -O, "/home/cali/logback.xml" ]
- [ systemctl, start, cali ]
- [ systemctl, enable, cali ]
@@ -127,7 +127,7 @@ runcmd:
[cloud-config.yaml](scripts/cloud-installs/cloud-config.yaml)
-This updates all packages, installs a java runtime and [fail2ban](#fail2ban). It the follows the manual installation, copying files and configuring the systemd service. The used files are downloaded from this git repository and the [Eclipse Release Repository](https://repo.eclipse.org/content/repositories/californium-releases/org/eclipse/californium/cf-plugtest-server/3.7.0/cf-plugtest-server-3.7.0.jar).
+This updates all packages, installs a java runtime and [fail2ban](#fail2ban). It the follows the manual installation, copying files and configuring the systemd service. The used files are downloaded from this git repository and the [Eclipse Release Repository](https://repo.eclipse.org/content/repositories/californium-releases/org/eclipse/californium/cf-plugtest-server/3.8.0/cf-plugtest-server-3.8.0.jar).
### Installation on Exoscale cloud
@@ -135,7 +135,7 @@ This updates all packages, installs a java runtime and [fail2ban](#fail2ban). It
[deploy_exo.sh](scripts/cloud-installs/deploy_exo.sh)
-This script uses the exoscale cli (exo) to create a compute instance and the [cloud-config.yaml](scripts/cloud-installs/cloud-config.yaml) to configure and install the [Californium Plugtest Server](https://repo.eclipse.org/content/repositories/californium-releases/org/eclipse/californium/cf-plugtest-server/3.7.0/cf-plugtest-server-3.7.0.jar).
+This script uses the exoscale cli (exo) to create a compute instance and the [cloud-config.yaml](scripts/cloud-installs/cloud-config.yaml) to configure and install the [Californium Plugtest Server](https://repo.eclipse.org/content/repositories/californium-releases/org/eclipse/californium/cf-plugtest-server/3.8.0/cf-plugtest-server-3.8.0.jar).
Features: IPv4, IPv6, Firewall
@@ -147,7 +147,7 @@ For further instructions see the comments in that script.
[deploy_do.sh](scripts/cloud-installs/deploy_do.sh)
-This script uses the digitalocean cli (doctl) to create a compute droplet and the [cloud-config.yaml](scripts/cloud-installs/cloud-config.yaml) to configure and install the [Californium Plugtest Server](https://repo.eclipse.org/content/repositories/californium-releases/org/eclipse/californium/cf-plugtest-server/3.7.0/cf-plugtest-server-3.7.0.jar).
+This script uses the digitalocean cli (doctl) to create a compute droplet and the [cloud-config.yaml](scripts/cloud-installs/cloud-config.yaml) to configure and install the [Californium Plugtest Server](https://repo.eclipse.org/content/repositories/californium-releases/org/eclipse/californium/cf-plugtest-server/3.8.0/cf-plugtest-server-3.8.0.jar).
Features: IPv4, IPv6, Firewall
@@ -159,7 +159,7 @@ For further instructions see the comments in that script.
[deploy_gcloud.sh](scripts/cloud-installs/deploy_gcloud.sh)
-This script uses the google cloud API (gcloud) to create a compute instance and the [cloud-config.yaml](scripts/cloud-installs/cloud-config.yaml) to configure and install the [Californium Plugtest Server](https://repo.eclipse.org/content/repositories/californium-releases/org/eclipse/californium/cf-plugtest-server/3.7.0/cf-plugtest-server-3.7.0.jar).
+This script uses the google cloud API (gcloud) to create a compute instance and the [cloud-config.yaml](scripts/cloud-installs/cloud-config.yaml) to configure and install the [Californium Plugtest Server](https://repo.eclipse.org/content/repositories/californium-releases/org/eclipse/californium/cf-plugtest-server/3.8.0/cf-plugtest-server-3.8.0.jar).
Features: IPv4, Firewall
@@ -171,7 +171,7 @@ For further instructions see the comments in that script.
[deploy_azure.sh](scripts/cloud-installs/deploy_azure.sh)
-This script uses the azure cloud API (az) to create a vm and the [cloud-config.yaml](scripts/cloud-installs/cloud-config.yaml) to configure and install the [Californium Plugtest Server](https://repo.eclipse.org/content/repositories/californium-releases/org/eclipse/californium/cf-plugtest-server/3.7.0/cf-plugtest-server-3.7.0.jar).
+This script uses the azure cloud API (az) to create a vm and the [cloud-config.yaml](scripts/cloud-installs/cloud-config.yaml) to configure and install the [Californium Plugtest Server](https://repo.eclipse.org/content/repositories/californium-releases/org/eclipse/californium/cf-plugtest-server/3.8.0/cf-plugtest-server-3.8.0.jar).
Features: IPv4, Firewall
@@ -183,7 +183,7 @@ For further instructions see the comments in that script.
[deploy_aws.sh](scripts/cloud-installs/deploy_aws.sh)
-This script uses the aws API (aws) to create a vm and the [cloud-config.yaml](scripts/cloud-installs/cloud-config.yaml) to configure and install the [Californium Plugtest Server](https://repo.eclipse.org/content/repositories/californium-releases/org/eclipse/californium/cf-plugtest-server/3.7.0/cf-plugtest-server-3.7.0.jar).
+This script uses the aws API (aws) to create a vm and the [cloud-config.yaml](scripts/cloud-installs/cloud-config.yaml) to configure and install the [Californium Plugtest Server](https://repo.eclipse.org/content/repositories/californium-releases/org/eclipse/californium/cf-plugtest-server/3.8.0/cf-plugtest-server-3.8.0.jar).
Features: IPv4, Firewall
diff --git a/demo-apps/cf-unix-setup/pom.xml b/demo-apps/cf-unix-setup/pom.xml
index 56b4bcdd9e..4607b34f5b 100644
--- a/demo-apps/cf-unix-setup/pom.xml
+++ b/demo-apps/cf-unix-setup/pom.xml
@@ -8,7 +8,7 @@
org.eclipse.californium
demo-apps
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
cf-unix-setup
diff --git a/demo-apps/cf-unix-setup/scripts/cloud-installs/cloud-config.yaml b/demo-apps/cf-unix-setup/scripts/cloud-installs/cloud-config.yaml
index 2727d937c9..45b868c1e4 100644
--- a/demo-apps/cf-unix-setup/scripts/cloud-installs/cloud-config.yaml
+++ b/demo-apps/cf-unix-setup/scripts/cloud-installs/cloud-config.yaml
@@ -32,7 +32,7 @@ users:
runcmd:
- [ wget, "https://github.com/eclipse/californium/raw/main/demo-apps/cf-unix-setup/scripts/cali.service", -O, "/etc/systemd/system/cali.service" ]
- - [ wget, "https://repo.eclipse.org/content/repositories/californium-releases/org/eclipse/californium/cf-plugtest-server/3.7.0/cf-plugtest-server-3.7.0.jar", -O, "/home/cali/cf-plugtest-server-update.jar" ]
+ - [ wget, "https://repo.eclipse.org/content/repositories/californium-releases/org/eclipse/californium/cf-plugtest-server/3.8.0/cf-plugtest-server-3.8.0.jar", -O, "/home/cali/cf-plugtest-server-update.jar" ]
- [ wget, "https://github.com/eclipse/californium/raw/main/demo-apps/cf-plugtest-server/src/main/resources/logback.xml", -O, "/home/cali/logback.xml" ]
- [ systemctl, start, cali ]
- [ systemctl, enable, cali ]
diff --git a/demo-apps/cf-unix-setup/scripts/install.sh b/demo-apps/cf-unix-setup/scripts/install.sh
index ba1dc3db8b..9cf391aeb7 100644
--- a/demo-apps/cf-unix-setup/scripts/install.sh
+++ b/demo-apps/cf-unix-setup/scripts/install.sh
@@ -24,7 +24,7 @@
# create non-su, non-login user
sudo adduser --system --home /home/cali --disabled-login cali
# move application from current folder to update file
-sudo mv cf-plugtest-server-3.7.0.jar /home/cali/cf-plugtest-server-update.jar
+sudo mv cf-plugtest-server-3.8.0.jar /home/cali/cf-plugtest-server-update.jar
# move service definition from current folder
sudo mv cali.service /etc/systemd/system
# reload service definitions
diff --git a/demo-apps/pom.xml b/demo-apps/pom.xml
index 726dbddcce..1ec6c72116 100644
--- a/demo-apps/pom.xml
+++ b/demo-apps/pom.xml
@@ -8,7 +8,7 @@
org.eclipse.californium
cf-bom
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
../bom
demo-apps
diff --git a/demo-apps/sc-dtls-example-client/pom.xml b/demo-apps/sc-dtls-example-client/pom.xml
index db6671276e..6ae528ed3d 100644
--- a/demo-apps/sc-dtls-example-client/pom.xml
+++ b/demo-apps/sc-dtls-example-client/pom.xml
@@ -8,7 +8,7 @@
org.eclipse.californium
demo-apps
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
sc-dtls-example-client
diff --git a/demo-apps/sc-dtls-example-server/pom.xml b/demo-apps/sc-dtls-example-server/pom.xml
index d4b1f145f8..8687ec85fc 100644
--- a/demo-apps/sc-dtls-example-server/pom.xml
+++ b/demo-apps/sc-dtls-example-server/pom.xml
@@ -8,7 +8,7 @@
org.eclipse.californium
demo-apps
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
sc-dtls-example-server
diff --git a/demo-certs/pom.xml b/demo-certs/pom.xml
index e41b90ce6d..37a03719ae 100644
--- a/demo-certs/pom.xml
+++ b/demo-certs/pom.xml
@@ -8,7 +8,7 @@
org.eclipse.californium
parent
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
demo-certs
diff --git a/element-connector-tcp-netty/pom.xml b/element-connector-tcp-netty/pom.xml
index 3d0d876b83..0fa78ef73a 100644
--- a/element-connector-tcp-netty/pom.xml
+++ b/element-connector-tcp-netty/pom.xml
@@ -6,7 +6,7 @@
org.eclipse.californium
cf-bom
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
../bom
@@ -15,9 +15,9 @@
Californium (Cf) Element Connector TCP netty
Element connector implementation for TCP/TLS using netty
-
+
- 4.1.82.Final
+ 4.1.87.Final
version="[${versionmask;==;${netty.version}},${versionmask;+;${netty.version}})"
diff --git a/element-connector-tcp-netty/src/main/java/org/eclipse/californium/elements/tcp/netty/TlsContextUtil.java b/element-connector-tcp-netty/src/main/java/org/eclipse/californium/elements/tcp/netty/TlsContextUtil.java
index 357b4eb631..8422f1973a 100644
--- a/element-connector-tcp-netty/src/main/java/org/eclipse/californium/elements/tcp/netty/TlsContextUtil.java
+++ b/element-connector-tcp-netty/src/main/java/org/eclipse/californium/elements/tcp/netty/TlsContextUtil.java
@@ -38,14 +38,37 @@
import io.netty.channel.Channel;
import io.netty.handler.ssl.SslHandler;
+import io.netty.util.AttributeKey;
/**
* Util for building for TLS endpoint context from channel.
+ *
+ * Note: since 3.8 the {@link Principal} and the session_id are cached using the
+ * {@link SSLSession#getLastAccessedTime()} to refresh them from the SSLSession.
*/
public class TlsContextUtil extends TcpContextUtil {
private static final Logger LOGGER = LoggerFactory.getLogger(TlsContextUtil.class);
+ /**
+ * Key for TLS connect timestamp.
+ *
+ * @since 3.8
+ */
+ private static final AttributeKey tlsConnectTimestamp = AttributeKey.newInstance("tls_connect_millis");
+ /**
+ * Key for TLS principal.
+ *
+ * @since 3.8
+ */
+ private static final AttributeKey tlsPrincipal = AttributeKey.newInstance("tls_principal");
+ /**
+ * Key for TLS session id.
+ *
+ * @since 3.8
+ */
+ private static final AttributeKey tlsSessionId = AttributeKey.newInstance("tls_session_id");
+
/**
* Client authentication mode.
*
@@ -86,54 +109,68 @@ public EndpointContext buildEndpointContext(Channel channel) {
SSLEngine sslEngine = sslHandler.engine();
SSLSession sslSession = sslEngine.getSession();
if (sslSession != null) {
- boolean checkKerberos = false;
+ long accessTime = sslSession.getLastAccessedTime();
Principal principal = null;
- if (clientAuthMode.useCertificateRequest()) {
- try {
- Certificate[] peerCertificateChain = sslSession.getPeerCertificates();
- if (peerCertificateChain != null && peerCertificateChain.length != 0) {
- principal = X509CertPath.fromCertificatesChain(peerCertificateChain);
- } else {
+ String sslId = null;
+ Long contextAccessTime = channel.attr(tlsConnectTimestamp).get();
+ if (contextAccessTime == null || accessTime != contextAccessTime.longValue()) {
+ boolean checkKerberos = false;
+ if (clientAuthMode.useCertificateRequest()) {
+ try {
+ Certificate[] peerCertificateChain = sslSession.getPeerCertificates();
+ if (peerCertificateChain != null && peerCertificateChain.length != 0) {
+ principal = X509CertPath.fromCertificatesChain(peerCertificateChain);
+ } else {
+ // maybe kerberos is used and therefore
+ // getPeerCertificates fails
+ checkKerberos = true;
+ }
+ } catch (SSLPeerUnverifiedException e1) {
// maybe kerberos is used and therefore
// getPeerCertificates fails
checkKerberos = true;
+ } catch (RuntimeException e) {
+ LOGGER.warn("TLS({}) failed to extract principal {}", id, e.getMessage());
}
- } catch (SSLPeerUnverifiedException e1) {
- // maybe kerberos is used and therefore
- // getPeerCertificates fails
- checkKerberos = true;
- } catch (RuntimeException e) {
- LOGGER.warn("TLS({}) failed to extract principal {}", id, e.getMessage());
- }
- if (checkKerberos) {
- try {
- principal = sslSession.getPeerPrincipal();
- } catch (SSLPeerUnverifiedException e2) {
- // still unverified, so also no kerberos
- if (clientAuthMode == CertificateAuthenticationMode.NEEDED) {
- LOGGER.warn("TLS({}) failed to verify principal, {}", id, e2.getMessage());
- } else {
- LOGGER.trace("TLS({}) failed to verify principal, {}", id, e2.getMessage());
+ if (checkKerberos) {
+ try {
+ principal = sslSession.getPeerPrincipal();
+ } catch (SSLPeerUnverifiedException e2) {
+ // still unverified, so also no kerberos
+ if (clientAuthMode == CertificateAuthenticationMode.NEEDED) {
+ LOGGER.warn("TLS({}) failed to verify principal, {}", id, e2.getMessage());
+ } else {
+ LOGGER.trace("TLS({}) failed to verify principal, {}", id, e2.getMessage());
+ }
}
}
- }
- if (principal != null) {
- LOGGER.debug("TLS({}) Principal {}", id, principal.getName());
- } else if (clientAuthMode == CertificateAuthenticationMode.NEEDED) {
- LOGGER.warn("TLS({}) principal missing", id);
- } else {
- LOGGER.trace("TLS({}) principal missing", id);
+ if (principal != null) {
+ LOGGER.debug("TLS({}) Principal {}", id, principal.getName());
+ } else if (clientAuthMode == CertificateAuthenticationMode.NEEDED) {
+ LOGGER.warn("TLS({}) principal missing", id);
+ } else {
+ LOGGER.trace("TLS({}) principal missing", id);
+ }
+ }
+ byte[] sessionId = sslSession.getId();
+ if (sessionId != null && sessionId.length > 0) {
+ sslId = StringUtil.byteArray2HexString(sessionId, StringUtil.NO_SEPARATOR, 0);
+ // cache session_id and principal
+ channel.attr(tlsConnectTimestamp).set(accessTime);
+ channel.attr(tlsPrincipal).set(principal);
+ channel.attr(tlsSessionId).set(sslId);
}
+ } else {
+ // load session_id and principal from cache
+ principal = channel.attr(tlsPrincipal).get();
+ sslId = channel.attr(tlsSessionId).get();
}
- byte[] sessionId = sslSession.getId();
- if (sessionId != null && sessionId.length > 0) {
- String sslId = StringUtil.byteArray2HexString(sessionId, StringUtil.NO_SEPARATOR, 0);
+ if (sslId != null) {
String cipherSuite = sslSession.getCipherSuite();
LOGGER.debug("TLS({},{},{})", id, StringUtil.trunc(sslId, 14), cipherSuite);
- return new TlsEndpointContext(address, principal, id, sslId, cipherSuite,
- sslSession.getLastAccessedTime());
+ return new TlsEndpointContext(address, principal, id, sslId, cipherSuite, accessTime);
}
}
// TLS handshake not finished
@@ -143,9 +180,10 @@ public EndpointContext buildEndpointContext(Channel channel) {
/**
* Get array of weak cipher suites.
*
- * Work-around for Bouncy Castle issue 1054: Default cipher suites when
- * running with java 7 (restricted) . Fixed with bouncy castle 1.7.0.
+ * Work-around for
+ * Bouncy Castle issue 1054: Default cipher suites when running
+ * with java 7 (restricted) . Fixed with bouncy castle 1.7.0.
*
* @param sslContext ssl context with default cipher suite
* @return array with weak cipher suites, subset of the ssl context.
diff --git a/element-connector/pom.xml b/element-connector/pom.xml
index c8138feb1a..eb80d0dc4e 100644
--- a/element-connector/pom.xml
+++ b/element-connector/pom.xml
@@ -8,7 +8,7 @@
org.eclipse.californium
cf-bom
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
../bom
diff --git a/element-connector/src/main/java/org/eclipse/californium/elements/util/EncryptedStreamUtil.java b/element-connector/src/main/java/org/eclipse/californium/elements/util/EncryptedStreamUtil.java
index 0e4f2fa814..ce8285d59f 100644
--- a/element-connector/src/main/java/org/eclipse/californium/elements/util/EncryptedStreamUtil.java
+++ b/element-connector/src/main/java/org/eclipse/californium/elements/util/EncryptedStreamUtil.java
@@ -22,6 +22,7 @@
import java.security.GeneralSecurityException;
import java.security.SecureRandom;
import java.security.spec.AlgorithmParameterSpec;
+import java.util.Arrays;
import javax.crypto.Cipher;
import javax.crypto.CipherInputStream;
@@ -135,12 +136,26 @@ private Cipher init(int mode, SecretKey password, byte[] seed) {
}
}
+ /**
+ * Read seed from input stream.
+ *
+ * @param in input stream
+ * @return read seed, or {@code null}, if missing.
+ * @see #prepare(byte[], InputStream, SecretKey)
+ * @since 3.8
+ */
+ public byte[] readSeed(InputStream in) {
+ DataStreamReader reader = new DataStreamReader(in);
+ return reader.readVarBytes(Byte.SIZE);
+ }
+
/**
* Prepare input stream.
*
* @param in input stream to read data from
* @param password password for decryption. If {@code null}, the input
- * stream must not be encrypted.
+ * stream must be not encrypted, but starts with an empty seed
+ * (byte 0).
* @return prepared input stream. If a "seed" is found at the head and
* password is provided, a {@link CipherInputStream}. If that
* doesn't {@link InputStream#markSupported()}, wrapped with a
@@ -149,8 +164,27 @@ private Cipher init(int mode, SecretKey password, byte[] seed) {
* empty input stream is returned and no items are loaded.
*/
public InputStream prepare(InputStream in, SecretKey password) {
- DataStreamReader reader = new DataStreamReader(in);
- byte[] seed = reader.readVarBytes(Byte.SIZE);
+ return prepare(readSeed(in), in, password);
+ }
+
+ /**
+ * Prepare input stream.
+ *
+ * @param seed seed to decrypt data. If {@code null}, don't decrypt.
+ * @param in input stream to read data from
+ * @param password password for decryption. If {@code null}, the input
+ * stream must be not encrypted, and the seed must be [@link
+ * null} or empty.
+ * @return prepared input stream. If a seed is provided and password is
+ * provided, a {@link CipherInputStream}. If that doesn't
+ * {@link InputStream#markSupported()}, wrapped with a
+ * {@link BufferedInputStream}. If a seed is provided, but the
+ * password is missing or the cipher algorithm isn't supported, a
+ * empty input stream is returned and no items are loaded.
+ * @see #readSeed(InputStream)
+ * @since 3.8
+ */
+ public InputStream prepare(byte[] seed, InputStream in, SecretKey password) {
if (seed != null && seed.length > 0) {
if (password == null) {
LOGGER.warn("missing password!");
@@ -176,19 +210,54 @@ public InputStream prepare(InputStream in, SecretKey password) {
*
* @param out output stream to write data to
* @param password password for encryption. If {@code null}, the output
- * stream is not encrypted.
+ * stream is not encrypted, but starts with an empty seed (byte
+ * 0).
* @return prepared output stream, {@link CipherOutputStream}, if a password
* is provided.
- * @throws IOException if an i/o-error occurred
+ * @throws IOException if an i/o-error occurred or no new random seed could
+ * be generated.
*/
public OutputStream prepare(OutputStream out, SecretKey password) throws IOException {
+ return prepare(null, out, password);
+ }
+
+ /**
+ * Prepare output stream.
+ *
+ * Writes random seed or {@link Bytes#EMPTY}, if no password is provided.
+ *
+ * @param seed seed the current/last written/read data is using. Ensure, a
+ * new seed is used to write. {@code null}, if not available.
+ * @param out output stream to write data to
+ * @param password password for encryption. If {@code null}, the output
+ * stream is not encrypted, but starts with an empty seed (byte
+ * 0).
+ * @return prepared output stream, {@link CipherOutputStream}, if a password
+ * is provided.
+ * @throws IOException if an i/o-error occurred or no new random seed could
+ * be generated.
+ * @since 3.8
+ */
+ public OutputStream prepare(byte[] seed, OutputStream out, SecretKey password) throws IOException {
DatagramWriter writer = new DatagramWriter();
if (password != null) {
- byte[] seed = new byte[16];
- new SecureRandom().nextBytes(seed);
- Cipher cipher = init(Cipher.ENCRYPT_MODE, password, seed);
+ byte[] newSeed = new byte[seed == null ? 16 : seed.length];
+ SecureRandom random = new SecureRandom();
+ int count = 0;
+ random.nextBytes(newSeed);
+ while (seed != null && Arrays.equals(seed, newSeed)) {
+ ++count;
+ if (count > 5) {
+ throw new IOException("Random seed failed!");
+ }
+ random.nextBytes(newSeed);
+ }
+ if (seed != null) {
+ System.arraycopy(newSeed, 0, seed, 0, seed.length);
+ }
+ Cipher cipher = init(Cipher.ENCRYPT_MODE, password, newSeed);
if (cipher != null) {
- writer.writeVarBytes(seed, Byte.SIZE);
+ writer.writeVarBytes(newSeed, Byte.SIZE);
writer.writeTo(out);
out = new CipherOutputStream(out, cipher);
} else {
diff --git a/element-connector/src/main/java/org/eclipse/californium/elements/util/JceNames.java b/element-connector/src/main/java/org/eclipse/californium/elements/util/JceNames.java
index 99217bbf94..019ac7b029 100644
--- a/element-connector/src/main/java/org/eclipse/californium/elements/util/JceNames.java
+++ b/element-connector/src/main/java/org/eclipse/californium/elements/util/JceNames.java
@@ -109,6 +109,22 @@ public interface JceNames {
/**
* Name of environment variable to specify the JCE.
+ *
+ * Usage via environment variable:
+ *
+ * unix:
+ * export CALIFORNIUM_JCE_PROVIDER=BC
+ * ...
+ * java ...
+ *
+ *
+ * or via system property:
+ *
+ *
+ * java -DCALIFORNIUM_JCE_PROVIDER=BC ...
+ *
+ *
+ * Requires to add the required jars to the classpath!
*/
public String CALIFORNIUM_JCE_PROVIDER = "CALIFORNIUM_JCE_PROVIDER";
/**
diff --git a/element-connector/src/main/java/org/eclipse/californium/elements/util/LimitedRunnable.java b/element-connector/src/main/java/org/eclipse/californium/elements/util/LimitedRunnable.java
index 54d4af890d..f06f9d169a 100644
--- a/element-connector/src/main/java/org/eclipse/californium/elements/util/LimitedRunnable.java
+++ b/element-connector/src/main/java/org/eclipse/californium/elements/util/LimitedRunnable.java
@@ -90,6 +90,14 @@ public boolean isOverflown() {
return overflow;
}
+ /**
+ * Handles {@code RejectedExecutionException}
+ * @param ex the thrown exception
+ *
+ * @since 3.8
+ */
+ public void onError(RejectedExecutionException ex) {};
+
/**
* Execute this job.
*
@@ -101,6 +109,7 @@ public void execute(Executor executor) {
executor.execute(this);
} catch (RejectedExecutionException ex) {
onDequeueing();
+ onError(ex);
throw ex;
}
}
diff --git a/element-connector/src/main/java/org/eclipse/californium/elements/util/SystemResourceMonitors.java b/element-connector/src/main/java/org/eclipse/californium/elements/util/SystemResourceMonitors.java
new file mode 100644
index 0000000000..fb2b27531e
--- /dev/null
+++ b/element-connector/src/main/java/org/eclipse/californium/elements/util/SystemResourceMonitors.java
@@ -0,0 +1,410 @@
+/********************************************************************************
+ * Copyright (c) 2023 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * https://www.eclipse.org/legal/epl-2.0, or the Eclipse Distribution License
+ * v1.0 which is available at
+ * https://www.eclipse.org/org/documents/edl-v10.php.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
+ ********************************************************************************/
+package org.eclipse.californium.elements.util;
+
+import java.io.File;
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.List;
+import java.util.concurrent.ScheduledExecutorService;
+import java.util.concurrent.ScheduledFuture;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicBoolean;
+import java.util.concurrent.atomic.AtomicReference;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Monitors for system resource.
+ *
+ * Check systems resource frequently for changes.
+ *
+ * @since 3.8
+ */
+public class SystemResourceMonitors {
+
+ /**
+ * Logger.
+ */
+ private static final Logger LOGGER = LoggerFactory.getLogger(SystemResourceMonitors.class);
+
+ /**
+ * List of system resource jobs.
+ */
+ private final List resources = new ArrayList<>();
+ /**
+ * Scheduler for jobs.
+ */
+ private final ScheduledExecutorService scheduler;
+ /**
+ * State indicator. {@code true} after {@link #start()}, {@code false} after
+ * {@link #stop()} or before {@link #start()}.
+ */
+ private final AtomicBoolean running = new AtomicBoolean();
+
+ /**
+ * Creates instance.
+ *
+ * @param scheduler scheduler to schedule checking jobs.
+ */
+ public SystemResourceMonitors(ScheduledExecutorService scheduler) {
+ this.scheduler = scheduler;
+ }
+
+ /**
+ * Add system resource monitor.
+ *
+ * @param name name of monitor
+ * @param interval interval for checks
+ * @param unit time unit for checks
+ * @param resource system resource monitor used for check.
+ * @return created check-job.
+ */
+ public SystemResourceJob addMonitor(String name, long interval, TimeUnit unit, SystemResourceMonitor resource) {
+ SystemResourceJob job = new SystemResourceJob(scheduler, name, interval, unit, resource);
+ resources.add(job);
+ if (running.get()) {
+ job.start();
+ }
+ return job;
+ }
+
+ /**
+ * Remove system resource monitor job.
+ *
+ * @param job system resource monitor check-job to remove
+ * @return {@code true}, if removed, {@code false}, if not contained.
+ */
+ public boolean remove(SystemResourceJob job) {
+ if (resources.remove(job)) {
+ job.stop();
+ return true;
+ }
+ return false;
+ }
+
+ /**
+ * Remove all system resource monitor check-jobs by name.
+ *
+ * @param name name of check-jobs, or {@code null} for all check-jobs.
+ * @return {@code true}, if at least one check-job is removed,
+ * {@code false}, if no check-job is removed.
+ */
+ public boolean remove(String name) {
+ boolean removed = false;
+ Iterator iterator = resources.iterator();
+ while (iterator.hasNext()) {
+ SystemResourceJob job = iterator.next();
+ if (name == null || name.equals(job.name)) {
+ job.stop();
+ iterator.remove();
+ removed = true;
+ }
+ }
+ return removed;
+ }
+
+ /**
+ * Start checks.
+ */
+ public void start() {
+ if (running.compareAndSet(false, true)) {
+ for (SystemResourceJob job : resources) {
+ job.start();
+ }
+ LOGGER.info("System resource monitor started!");
+ }
+ }
+
+ /**
+ * Stop checks.
+ */
+ public void stop() {
+ if (running.compareAndSet(true, false)) {
+ for (SystemResourceJob job : resources) {
+ job.stop();
+ }
+ LOGGER.info("System resource monitor stopped!");
+ }
+ }
+
+ /**
+ * Apply checks.
+ *
+ * @param name name of check-jobs, or {@code null} for all check-jobs.
+ */
+ public void checkNow(String name) {
+ for (SystemResourceJob job : resources) {
+ if (name == null || name.equals(job.name)) {
+ job.checkNow();
+ }
+ }
+ LOGGER.info("System resource monitor checked now!");
+ }
+
+ /**
+ * Interface to report result.
+ */
+ public interface SystemResourceCheckReady {
+
+ /**
+ * Report finished check-job.
+ *
+ * @param stop {@code true}, stop check-job. {@code false}, schedule
+ * next check.
+ */
+ void ready(boolean stop);
+ }
+
+ /**
+ * Job to check system resource changes.
+ */
+ public static class SystemResourceJob implements Runnable, SystemResourceCheckReady {
+
+ /**
+ * Name of job.
+ */
+ private final String name;
+ /**
+ * Interval of check-job.
+ */
+ private final long interval;
+ /**
+ * Time unit of interval.
+ */
+ private final TimeUnit unit;
+ /**
+ * System resource monitor.
+ */
+ private final SystemResourceMonitor resource;
+ /**
+ * Scheduler for check-job interval.
+ */
+ private final ScheduledExecutorService scheduler;
+ /**
+ * Future of scheduled job.
+ */
+ private final AtomicReference> scheduled = new AtomicReference<>();
+ /**
+ * Indicates pending check.
+ */
+ private final AtomicBoolean pending = new AtomicBoolean();
+
+ /**
+ * Create check-job.
+ *
+ * @param scheduler scheduler to be used.
+ * @param name name of job
+ * @param interval interval of checks
+ * @param unit unit of interval
+ * @param resource system resource monitor used for check.
+ */
+ private SystemResourceJob(ScheduledExecutorService scheduler, String name, long interval, TimeUnit unit,
+ SystemResourceMonitor resource) {
+ this.scheduler = scheduler;
+ this.name = name;
+ this.interval = interval;
+ this.unit = unit;
+ this.resource = resource;
+ }
+
+ /**
+ * Stop check-job.
+ */
+ private synchronized void stop() {
+ ScheduledFuture future = scheduled.getAndSet(null);
+ if (future != null) {
+ future.cancel(false);
+ }
+ }
+
+ /**
+ * Start check-job.
+ */
+ private synchronized void start() {
+ ScheduledFuture future = scheduled.getAndSet(scheduler.schedule(this, interval, unit));
+ if (future != null) {
+ future.cancel(false);
+ }
+ LOGGER.info("{} check scheduled in {} {}.", name, interval, unit);
+ }
+
+ /**
+ * Execute check-job now.
+ */
+ private void checkNow() {
+ if (pending.compareAndSet(false, true)) {
+ ScheduledFuture future = scheduled.get();
+ if (future != null) {
+ future.cancel(false);
+ }
+ resource.checkForUpdate(this);
+ }
+ }
+
+ /**
+ * Execute scheduled check-job.
+ */
+ private void check() {
+ if (pending.compareAndSet(false, true)) {
+ LOGGER.info("{} check for update!", name);
+ resource.checkForUpdate(this);
+ } else {
+ LOGGER.info("{} check for update pending!", name);
+ }
+ }
+
+ @Override
+ public void run() {
+ check();
+ }
+
+ @Override
+ public void ready(boolean stop) {
+ pending.set(false);
+ LOGGER.info("{} check ready!", name);
+ synchronized (this) {
+ ScheduledFuture future = scheduled.get();
+ if (future != null) {
+ if (stop) {
+ future.cancel(false);
+ } else {
+ start();
+ }
+ }
+ }
+ }
+ }
+
+ /**
+ * System resource monitor.
+ */
+ public interface SystemResourceMonitor {
+
+ /**
+ * Check resource for update.
+ *
+ * @param ready {@code true}
+ */
+ void checkForUpdate(SystemResourceCheckReady ready);
+
+ }
+
+ /**
+ * File monitor.
+ *
+ * Checks for changes in length and last modified date.
+ */
+ public static abstract class FileMonitor implements SystemResourceMonitor {
+
+ /**
+ * Monitored values.
+ */
+ public static class MonitoredValues {
+
+ private final long lastModified;
+ private final long length;
+
+ private MonitoredValues(long lastModified, long length) {
+ this.lastModified = lastModified;
+ this.length = length;
+ }
+
+ /**
+ * Check monitored values.
+ *
+ * @param other other monitored values
+ * @return {@code true}, if other monitored values differ,
+ * {@code false}, if other monitored values are equal.
+ */
+ private boolean check(MonitoredValues other) {
+ return lastModified != other.lastModified || length != other.length;
+ }
+ }
+
+ /**
+ * File to monitor.
+ */
+ private final File file;
+ /**
+ * Last monitored values when reading the file.
+ */
+ private volatile MonitoredValues values;
+
+ /**
+ * Create file monitor.
+ *
+ * @param name name of file to monitor
+ */
+ public FileMonitor(String name) {
+ this(new File(name));
+ }
+
+ /**
+ * Create file monitor.
+ *
+ * @param file file to monitor
+ */
+ public FileMonitor(File file) {
+ this.file = file;
+ this.values = readMonitoredValues();
+ }
+
+ /**
+ * Read monitored values.
+ *
+ * @return monitored values.
+ */
+ private MonitoredValues readMonitoredValues() {
+ long length = file.length();
+ long lastModified = file.lastModified();
+ return new MonitoredValues(lastModified, length);
+ }
+
+ @Override
+ public void checkForUpdate(SystemResourceCheckReady ready) {
+ MonitoredValues values = readMonitoredValues();
+ if (this.values.check(values)) {
+ LOGGER.info("File {} changed!", file);
+ update(values, ready);
+ } else {
+ LOGGER.info("File {} unchanged.", file);
+ ready.ready(false);
+ }
+ }
+
+ /**
+ * Report update ready.
+ *
+ * @param values monitored values passed to {@link #update}.
+ * {@code null}, if monitored values should not be updated.
+ */
+ protected void ready(MonitoredValues values) {
+ if (values != null) {
+ this.values = values;
+ }
+ }
+
+ /**
+ * Called, when monitored values differs.
+ *
+ * @param values different monitored values
+ * @param ready callback to report finished update
+ */
+ protected abstract void update(MonitoredValues values, SystemResourceCheckReady ready);
+ }
+
+}
diff --git a/element-connector/src/test/java/org/eclipse/californium/elements/runner/TestRepeater.java b/element-connector/src/test/java/org/eclipse/californium/elements/runner/TestRepeater.java
index c6cdcf876d..6a7f15edec 100644
--- a/element-connector/src/test/java/org/eclipse/californium/elements/runner/TestRepeater.java
+++ b/element-connector/src/test/java/org/eclipse/californium/elements/runner/TestRepeater.java
@@ -20,6 +20,7 @@
import java.util.concurrent.atomic.AtomicInteger;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+import org.eclipse.californium.elements.util.StringUtil;
import org.junit.runner.Description;
import org.junit.runner.Runner;
import org.junit.runner.notification.Failure;
@@ -58,7 +59,7 @@ public class TestRepeater {
* Maximum number of repeats.
*
* 0 := repeat until failure. May be set via property
- * "org.eclipse.californium.runner.TestRepeater.repeats". Default
+ * "org.eclipse.californium.elements.runner.TestRepeater.repeats". Default
* {@link #DEFAULT_MAXIMUM_REPEATS}.
*/
private final long maximumRepeats;
@@ -66,7 +67,7 @@ public class TestRepeater {
* Interval for alive logging in milliseconds.
*
* 0 := disabled. May be set via property
- * "org.eclipse.californium.runner.TestRepeater.alive". Default
+ * "org.eclipse.californium.elements.runner.TestRepeater.alive". Default
* {@link #DEFAULT_ALIVE_INTERVAL_IN_MILLISECONDS}.
*/
private final int aliveIntervalInMilliseconds;
@@ -75,29 +76,24 @@ public class TestRepeater {
* Create new test repeater.
*/
public TestRepeater() {
- Integer value = getProperty(TestRepeater.class.getName() + ".repeats");
- maximumRepeats = null == value ? DEFAULT_MAXIMUM_REPEATS : value;
- value = getProperty(TestRepeater.class.getName() + ".alive");
- aliveIntervalInMilliseconds = null == value ? DEFAULT_ALIVE_INTERVAL_IN_MILLISECONDS : value;
- }
-
- /**
- * Get integer value from property with provided name.
- *
- * @param name name of property
- * @return value, of {@code null}, if property is not defined or value is no
- * integer number.
- */
- private Integer getProperty(String name) {
- String value = System.getProperty(name);
- if (null != value) {
- try {
- return Integer.valueOf(value);
- } catch (NumberFormatException ex) {
- LOGGER.error("value for ''{}'' := ''{}'' is no number!", name, value);
- }
+ String name = TestRepeater.class.getName() + ".repeats";
+ Long value = StringUtil.getConfigurationLong(name);
+ if (value == null) {
+ LOGGER.info("Use default {} for {}", DEFAULT_MAXIMUM_REPEATS, name);
+ maximumRepeats = DEFAULT_MAXIMUM_REPEATS;
+ } else {
+ LOGGER.info("Use {} for {}", value, name);
+ maximumRepeats = value;
+ }
+ name = TestRepeater.class.getName() + ".alive";
+ value = StringUtil.getConfigurationLong(name);
+ if (value == null) {
+ LOGGER.info("Use default {} for {}", DEFAULT_ALIVE_INTERVAL_IN_MILLISECONDS, name);
+ aliveIntervalInMilliseconds = DEFAULT_ALIVE_INTERVAL_IN_MILLISECONDS;
+ } else {
+ LOGGER.info("Use {} for {}", value, name);
+ aliveIntervalInMilliseconds = value.intValue();
}
- return null;
}
/**
diff --git a/legal/licenses/NOTICE.md b/legal/licenses/NOTICE.md
index 3c3d837bdc..fdd0e6dc37 100644
--- a/legal/licenses/NOTICE.md
+++ b/legal/licenses/NOTICE.md
@@ -29,23 +29,23 @@ SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
The project maintains the following source code repositories:
-* https://github.com/eclipse/californium
-* https://github.com/eclipse/californium.tools
-* https://github.com/eclipse/californium.actinium
+* https://github.com/eclipse-californium/californium
+* https://github.com/eclipse-californium/californium.tools
+* https://github.com/eclipse-californium/californium.actinium
## Third-party Content
This project leverages the following third party content.
-Apache HttpClient (5.1)
+Apache HttpClient (5.1.3)
* License: Apache-2.0
-Apache HttpComponents Core (5.1.1)
+Apache HttpComponents Core (5.1.3)
* License: Apache License 2.0
-ASM (5.0.1)
+ASM (9.4)
* License: New BSD license
@@ -88,7 +88,7 @@ Google Guava (30.0-android)
* License: Apache License, 2.0
-gson (2.8.9)
+gson (2.10)
* License: Apache-2.0
@@ -96,7 +96,7 @@ javassist (3.22.0)
* License: Apache-2.0
-Javax.annotation (1.3)
+Javax.annotation (1.3.2)
* License: CDDL
@@ -122,7 +122,7 @@ logback-android (1.1.1)
* Project: https://github.com/tony19/logback-android
* Source: https://github.com/tony19/logback-android/archive/master.zip
-Netty (4.1.79)
+Netty (4.1.87)
* License: Apache-2.0 AND BSD-3-Clause AND MIT
* Project: https://netty.io/
@@ -146,7 +146,7 @@ slf4j-jdk14 (1.7.36)
* License: MIT
-picocli (4.6.3)
+picocli (4.7.0)
* License: Apache License, 2.0
* Project: https://picocli.info
@@ -158,7 +158,7 @@ ed25519-java (0.3.0)
* Project: https://github.com/str4d/ed25519-java
* Source: https://github.com/str4d/ed25519-java/archive/refs/tags/v0.3.0.zip
-openssl (1.1.1) used for interoperability tests only
+openssl (1.1.1, 3.2.0) used for interoperability tests only
* License: Apache License, 2.0
* Project: https://www.openssl.org/
diff --git a/legal/pom.xml b/legal/pom.xml
index 1afee15144..d2207c6af8 100644
--- a/legal/pom.xml
+++ b/legal/pom.xml
@@ -3,7 +3,7 @@
org.eclipse.californium
parent
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
californium-legal
diff --git a/license_header_template.txt b/license_header_template.txt
index f0ad4c9f19..8c868cb742 100644
--- a/license_header_template.txt
+++ b/license_header_template.txt
@@ -1,17 +1,16 @@
-/*******************************************************************************
- * Copyright (c) <(company) name> and others.
+/********************************************************************************
+ * Copyright (c) {date} Contributors to the Eclipse Foundation
*
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Eclipse Public License v2.0
- * and Eclipse Distribution License v1.0 which accompany this distribution.
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
*
- * The Eclipse Public License is available at
- * http://www.eclipse.org/legal/epl-v20.html
- * and the Eclipse Distribution License is available at
- * http://www.eclipse.org/org/documents/edl-v10.html.
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * https://www.eclipse.org/legal/epl-2.0, or the Eclipse Distribution License
+ * v1.0 which is available at
+ * https://www.eclipse.org/org/documents/edl-v10.php.
*
- * Contributors:
- * <(company) name> - initial creation
- ******************************************************************************/
+ * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
+ ********************************************************************************/
-Please replace all tags with the information proper for you!
+Please replace {date} with the year of the contribution!
diff --git a/pom.xml b/pom.xml
index 0a956f6036..aac47cff83 100644
--- a/pom.xml
+++ b/pom.xml
@@ -8,7 +8,7 @@
org.eclipse.californium
parent
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
pom
Californium (Cf) Parent
@@ -110,7 +110,7 @@
1.7
true
none
- 3.7.0
+ RELEASE
@@ -364,12 +364,12 @@
org.revapi
revapi-maven-plugin
- 0.14.6
+ 0.15.0
org.revapi
revapi-java
- 0.26.1
+ 0.28.1
@@ -557,19 +557,18 @@
-
-
true
java.class.externalClassExposedInAPI
- org\.slf4j
+ org.slf4j
Californium uses classes of slf4j in some case with scope protected.
-
-
true
- java.class.externalClassExposedInAPI
- io\.netty
+ java.field.enumConstantOrderChanged
+ org.eclipse.californium.scandium.dtls.cipher.CipherSuite
- Californium uses classes of io.netty in some case with scope protected.
+ Order in CipherSuite reflects the preference by intention.
+ ordinal() must not be used.
@@ -834,32 +833,31 @@
false
- jdk15to18
1.72
1.7.36
org.bouncycastle
- bcpkix-${bc.art}
+ bcpkix-jdk15to18
${bc.version}
test
org.bouncycastle
- bcprov-${bc.art}
+ bcprov-jdk15to18
${bc.version}
test
org.bouncycastle
- bctls-${bc.art}
+ bctls-jdk15to18
${bc.version}
test
org.bouncycastle
- bcutil-${bc.art}
+ bcutil-jdk15to18
${bc.version}
test
@@ -890,32 +888,31 @@
false
- jdk18on
1.72
1.7.36
org.bouncycastle
- bcpkix-${bc.art}
+ bcpkix-jdk18on
${bc.version}
test
org.bouncycastle
- bcprov-${bc.art}
+ bcprov-jdk18on
${bc.version}
test
org.bouncycastle
- bctls-${bc.art}
+ bctls-jdk18on
${bc.version}
test
org.bouncycastle
- bcutil-${bc.art}
+ bcutil-jdk18on
${bc.version}
test
diff --git a/scandium-core/README.md b/scandium-core/README.md
index 50319b7fdd..d4aeb60b99 100644
--- a/scandium-core/README.md
+++ b/scandium-core/README.md
@@ -119,7 +119,7 @@ See [Californium Project Plan](https://projects.eclipse.org/projects/iot.califor
org.eclipse.californium
scandium
- 3.7.0
+ 3.8.0
...
@@ -210,6 +210,19 @@ Also Starting with 3.0.0-RC1, a server may use a `X509KeyManager` in order to pr
- *TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384*
- *TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA*
+ARIA cipher suites since 3.9.0, requires support by JCE, e.g. BouncyCastle 1.72:
+- TLS_PSK_WITH_ARIA_128_GCM_SHA256
+- TLS_PSK_WITH_ARIA_256_GCM_SHA384
+- *TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256*
+- *TLS_PSK_WITH_ARIA_128_CBC_SHA256*
+- *TLS_PSK_WITH_ARIA_256_CBC_SHA384*
+- TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
+- TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
+- *TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256*
+- *TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384*
+- TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
+- TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
+
Note: the *CBC* cipher suites are not longer recommended for new deployments!
Note: *SHA378* in the cipher suite names are typos. It must be *SHA384*. The straight forward fix would break the API, therefore the fix is postponed to 4.0 (no schedule for now)!
@@ -246,6 +259,7 @@ Supported extensions:
- [RFC 6066 - TLS Extensions](https://tools.ietf.org/html/rfc6066)
- [RFC 6066 - Server Name Indication](https://tools.ietf.org/html/rfc6066#section-3)
- [RFC 6066 - Maximum Fragment Length Negotiation](https://tools.ietf.org/html/rfc6066#section-4)
+- [RFC 6209 - ARIA Cipher Suites](https://tools.ietf.org/html/rfc6209) (since 3.9.0)
- [RFC 7250 - Raw Public Keys](https://tools.ietf.org/html/rfc7250)
- [RFC 7627 - Extended Master Secret Extension](https://tools.ietf.org/html/rfc7627)
- [RFC 7748 - Elliptic Curves for Security](https://tools.ietf.org/html/rfc7748)
@@ -310,6 +324,19 @@ Starting with 3.0.0-RC1 an experimental support for using [Bouncy Castle](https:
And setup a environment variable `CALIFORNIUM_JCE_PROVIDER` using the value `BC` (see [JceProviderUtil](../element-connector/src/main/java/org/eclipse/californium/elements/util/JceProviderUtil.java) for more details) or use the java `System.property` `CALIFORNIUM_JCE_PROVIDER` to do so.
+environment variable on unix:
+
+```
+export CALIFORNIUM_JCE_PROVIDER=BC
+...
+java ...
+```
+java `System.property`:
+
+```
+java -DCALIFORNIUM_JCE_PROVIDER=BC
+```
+
Supporting Bouncy Castle for the unit test uncovers a couple of differences, which required to adapt the implementation. It is assumed, that more will be found and more adaption will be required. If you find some, don't hesitate to report issues, perhaps research and analysis, and fixes. On the other hand, the project Californium will for now not be able to provide support for Bouncy Castle questions with or without relation to Californium. You may create issues, but it may be not possible for us to answer them.
On issue seems to be the `SecureRandom` generator of BC. Dependent on the runtime environment, that is based on `SecureRandom.getInstanceStrong()`, which has blocking behaviour by default. If the platform your application runs on, has not enough entropy to start the `SecureRandom`, BC waits until that gets available. In common cases, that starts quite fast, but in some cases, that takes up to 60s (and more).
diff --git a/scandium-core/pom.xml b/scandium-core/pom.xml
index e6c31ba40c..c6c68fc944 100644
--- a/scandium-core/pom.xml
+++ b/scandium-core/pom.xml
@@ -4,7 +4,7 @@
org.eclipse.californium
cf-bom
- 3.8.0-SNAPSHOT
+ 3.9.0-SNAPSHOT
../bom
scandium
diff --git a/scandium-core/src/main/java/org/eclipse/californium/scandium/DTLSConnector.java b/scandium-core/src/main/java/org/eclipse/californium/scandium/DTLSConnector.java
index 23929c5b1d..7604f0c355 100644
--- a/scandium-core/src/main/java/org/eclipse/californium/scandium/DTLSConnector.java
+++ b/scandium-core/src/main/java/org/eclipse/californium/scandium/DTLSConnector.java
@@ -728,37 +728,39 @@ public void handshakeFailed(Handshaker handshaker, Throwable error) {
message.onError(error);
}
}
- Connection connection = handshaker.getConnection();
+ final Object peerAddress = StringUtil.toLog(handshaker.getPeerAddress());
+ final DTLSContext context = handshaker.getDtlsContext();
+ final Connection connection = handshaker.getConnection();
if (handshaker.isRemovingConnection()) {
connectionStore.remove(connection, false);
} else if (handshaker.isProbing()) {
- LOGGER.debug("Handshake with [{}] failed within probe!", handshaker.getPeerAddress());
- } else if (connection.getEstablishedDtlsContext() == handshaker.getDtlsContext()) {
+ LOGGER.debug("Handshake with [{}] failed within probe!", peerAddress);
+ } else if (connection.getEstablishedDtlsContext() == context) {
if (error instanceof HandshakeException) {
AlertMessage alert = ((HandshakeException) error).getAlert();
if (alert != null && alert.getDescription() == AlertDescription.CLOSE_NOTIFY) {
LOGGER.debug("Handshake with [{}] closed after session was established!",
- handshaker.getPeerAddress());
+ peerAddress);
} else {
LOGGER.warn("Handshake with [{}] failed after session was established! {}",
- handshaker.getPeerAddress(), alert);
+ peerAddress, alert);
}
} else {
// failure after established (last FINISH),
// but before completed (first data)
if (error instanceof ConnectionEvictedException) {
LOGGER.debug("Handshake with [{}] never get APPLICATION_DATA",
- handshaker.getPeerAddress(), error);
+ peerAddress, error);
} else {
LOGGER.warn("Handshake with [{}] failed after session was established!",
- handshaker.getPeerAddress(), error);
+ peerAddress, error);
}
}
} else if (connection.hasEstablishedDtlsContext()) {
LOGGER.warn("Handshake with [{}] failed, but has an established session!",
- handshaker.getPeerAddress());
+ peerAddress);
} else {
- LOGGER.debug("Handshake with [{}] aborted, connection preserved!", handshaker.getPeerAddress());
+ LOGGER.debug("Handshake with [{}] aborted, connection preserved!", peerAddress);
}
}
};
@@ -1822,6 +1824,9 @@ protected void processDatagram(DatagramPacket packet, InetSocketAddress router)
// other information. If not used, a value of zero is inserted.
DROP_LOGGER.trace("Discarding record with {} bytes from [{}] without source-port", packet.getLength(),
StringUtil.toLog(peerAddress));
+ if (datagramFilter instanceof DatagramFilterExtended) {
+ ((DatagramFilterExtended) datagramFilter).onDrop(packet);
+ }
if (health != null) {
health.receivingRecord(true);
}
@@ -1831,6 +1836,9 @@ protected void processDatagram(DatagramPacket packet, InetSocketAddress router)
if (!datagramFilter.onReceiving(packet)) {
DROP_LOGGER.trace("Filter out packet with {} bytes from [{}]", packet.getLength(),
StringUtil.toLog(peerAddress));
+ if (datagramFilter instanceof DatagramFilterExtended) {
+ ((DatagramFilterExtended) datagramFilter).onDrop(packet);
+ }
if (health != null) {
health.receivingRecord(true);
}
@@ -1845,6 +1853,9 @@ protected void processDatagram(DatagramPacket packet, InetSocketAddress router)
if (records.isEmpty()) {
DROP_LOGGER.trace("Discarding malicious record with {} bytes from [{}]", packet.getLength(),
StringUtil.toLog(peerAddress));
+ if (datagramFilter instanceof DatagramFilterExtended) {
+ ((DatagramFilterExtended) datagramFilter).onDrop(packet);
+ }
if (health != null) {
health.receivingRecord(true);
}
@@ -1856,6 +1867,9 @@ protected void processDatagram(DatagramPacket packet, InetSocketAddress router)
records.get(0).getType(), StringUtil.toLog(peerAddress));
LOGGER.debug("Execution shutdown while processing incoming records from peer: {}",
StringUtil.toLog(peerAddress));
+ if (datagramFilter instanceof DatagramFilterExtended) {
+ ((DatagramFilterExtended) datagramFilter).onDrop(packet);
+ }
if (health != null) {
health.receivingRecord(true);
}
@@ -1885,6 +1899,7 @@ protected void processRecords(final List records,
if (dtlsRole == DtlsRole.CLIENT_ONLY) {
DROP_LOGGER.trace("client-only, discarding {} CLIENT_HELLO from [{}]!", records.size(),
StringUtil.toLog(peerAddress));
+ informListenerOfRecordDrop(firstRecord);
if (health != null) {
health.receivingRecord(true);
}
@@ -1908,6 +1923,11 @@ public void run() {
onDequeueing();
}
}
+
+ @Override
+ public void onError(RejectedExecutionException ex) {
+ informListenerOfRecordDrop(firstRecord);
+ }
});
return;
}
@@ -1916,6 +1936,7 @@ public void run() {
final Connection connection = getConnection(peerAddress, connectionId, false);
if (connection == null) {
+ informListenerOfRecordDrop(firstRecord);
if (health != null) {
health.receivingRecord(true);
}
@@ -1935,7 +1956,6 @@ public void run() {
record.setAddress(peerAddress, router);
try {
if (!executeInbound(serialExecutor, peerAddress, new LimitedRunnable(pendingInboundJobsCountdown) {
-
@Override
public void run() {
try {
@@ -1946,6 +1966,11 @@ public void run() {
onDequeueing();
}
}
+
+ @Override
+ public void onError(RejectedExecutionException ex) {
+ informListenerOfRecordDrop(record);
+ }
})) {
break;
}
@@ -1996,6 +2021,8 @@ protected boolean executeInbound(Executor executor, InetSocketAddress peer, Limi
*/
@Override
public void processRecord(Record record, Connection connection) {
+ final int epoch = record.getEpoch();
+ final DTLSContext context = connection.getDtlsContext(epoch);
try {
// ensure, that connection is still related to record
@@ -2005,13 +2032,13 @@ public void processRecord(Record record, Connection connection) {
DROP_LOGGER.debug("Drop received record {}, connection changed address {} => {}! (shift {}ms)",
record.getType(), StringUtil.toLog(record.getPeerAddress()),
StringUtil.toLog(connection.getPeerAddress()), delay);
+ informListenerOfRecordDrop(record);
if (health != null) {
health.receivingRecord(true);
}
return;
}
- int epoch = record.getEpoch();
LOGGER.trace("Received DTLS record of type [{}], length: {}, [epoche:{},rseqn:{}]", record.getType(),
record.getFragmentLength(), epoch, record.getSequenceNumber());
@@ -2027,6 +2054,7 @@ public void processRecord(Record record, Connection connection) {
"Discarding {} record [epoch {}, rseqn {}] received from peer [{}], handshake expired!",
record.getType(), epoch, record.getSequenceNumber(),
StringUtil.toLog(record.getPeerAddress()));
+ informListenerOfRecordDrop(record);
if (health != null) {
health.receivingRecord(true);
}
@@ -2035,8 +2063,6 @@ public void processRecord(Record record, Connection connection) {
handshaker = null;
}
- final DTLSContext context = connection.getDtlsContext(epoch);
-
if (context == null) {
if (handshaker != null && handshaker.getDtlsContext().getReadEpoch() == 0 && epoch == 1) {
// future records, apply session after handshake finished.
@@ -2046,6 +2072,7 @@ public void processRecord(Record record, Connection connection) {
"Discarding {} record [epoch {}, rseqn {}] received from peer [{}] without an active dtls context",
record.getType(), epoch, record.getSequenceNumber(),
StringUtil.toLog(record.getPeerAddress()));
+ informListenerOfRecordDrop(record);
if (health != null) {
health.receivingRecord(true);
}
@@ -2071,6 +2098,7 @@ public void processRecord(Record record, Connection connection) {
record.getType(), epoch, record.getSequenceNumber(),
StringUtil.toLog(record.getPeerAddress()));
}
+ informListenerOfRecordDrop(record);
if (health != null) {
health.receivingRecord(true);
}
@@ -2082,6 +2110,7 @@ public void processRecord(Record record, Connection connection) {
if (epoch == 0) {
DROP_LOGGER.debug("Discarding TLS_CID record received from peer [{}] during handshake",
StringUtil.toLog(record.getPeerAddress()));
+ informListenerOfRecordDrop(record);
if (health != null) {
health.receivingRecord(true);
}
@@ -2090,6 +2119,7 @@ public void processRecord(Record record, Connection connection) {
} else if (epoch > 0 && connection.expectCid()) {
DROP_LOGGER.debug("Discarding record received from peer [{}], CID required!",
StringUtil.toLog(record.getPeerAddress()));
+ informListenerOfRecordDrop(record);
if (health != null) {
health.receivingRecord(true);
}
@@ -2101,6 +2131,7 @@ public void processRecord(Record record, Connection connection) {
if (!datagramFilter.onReceiving(record, connection)) {
DROP_LOGGER.trace("Filter out record with {} bytes from [{}]", record.size(),
StringUtil.toLog(record.getPeerAddress()));
+ informListenerOfRecordDrop(record);
if (health != null) {
health.receivingRecord(true);
}
@@ -2140,6 +2171,7 @@ public void processRecord(Record record, Connection connection) {
StringUtil.toLog(record.getPeerAddress()));
}
} catch (RuntimeException e) {
+ informListenerOfRecordDrop(record);
if (health != null) {
health.receivingRecord(true);
}
@@ -2147,10 +2179,10 @@ public void processRecord(Record record, Connection connection) {
StringUtil.toLog(record.getPeerAddress()), e);
terminateConnectionWithInternalError(connection);
} catch (InvalidMacException e) {
- DTLSContext dtlsContext = connection.getEstablishedDtlsContext();
- if (dtlsContext != null) {
+ String details = e.getMessage();
+ if (context != null) {
boolean close = false;
- dtlsContext.incrementMacErrors();
+ context.incrementMacErrors();
if (datagramFilter != null) {
close = datagramFilter.onMacError(record, connection);
}
@@ -2159,10 +2191,13 @@ public void processRecord(Record record, Connection connection) {
}
if (close) {
closeConnection(connection);
+ } else if (epoch > 0 && connection.hasOngoingHandshake()) {
+ details += checkForPskFailure(record, context);
}
}
DROP_LOGGER.debug("Discarding {} received from peer [{}] caused by {}", record.getType(),
- StringUtil.toLog(record.getPeerAddress()), e.getMessage());
+ StringUtil.toLog(record.getPeerAddress()), details);
+ informListenerOfRecordDrop(record);
if (health != null) {
if (health instanceof DtlsHealthExtended2) {
((DtlsHealthExtended2) health).receivingMacError();
@@ -2173,6 +2208,7 @@ public void processRecord(Record record, Connection connection) {
} catch (GeneralSecurityException e) {
DROP_LOGGER.debug("Discarding {} received from peer [{}] caused by {}", record.getType(),
StringUtil.toLog(record.getPeerAddress()), e.getMessage());
+ informListenerOfRecordDrop(record);
if (health != null) {
health.receivingRecord(true);
}
@@ -2230,6 +2266,7 @@ private void processApplicationDataRecord(final Record record, final Connection
if (useNewerRecordFilter && !newest) {
DROP_LOGGER.debug("Discarding reorderd {} record [epoch {}, rseqn {}] received from peer [{}]",
record.getType(), record.getEpoch(), record.getSequenceNumber(), StringUtil.toLog(record.getPeerAddress()));
+ informListenerOfRecordDrop(record);
if (health != null) {
health.receivingRecord(true);
}
@@ -2265,6 +2302,7 @@ private void processApplicationDataRecord(final Record record, final Connection
} else {
DROP_LOGGER.debug("Discarding APPLICATION_DATA record received from peer [{}]",
StringUtil.toLog(record.getPeerAddress()));
+ informListenerOfRecordDrop(record);
}
}
@@ -2858,6 +2896,20 @@ private void processExceptionDuringHandshake(Record record, Connection connectio
}
}
+ private String checkForPskFailure(Record record, DTLSContext context) {
+ if (context.getSession().getCipherSuite().isPskBased()) {
+ if (record != null) {
+ ContentType expected = context.getReadConnectionId() == null ? ContentType.HANDSHAKE
+ : ContentType.TLS12_CID;
+ if (record.getType() != expected) {
+ return "";
+ }
+ }
+ return " Wrong PSK secret?";
+ }
+ return "";
+ }
+
/**
* Handle alert internally.
*
@@ -3357,6 +3409,7 @@ public void dropReceivedRecord(Record record) {
DROP_LOGGER.debug("Discarding {} record [epoch {}, rseqn {}] dropped by handshaker for peer [{}]",
record.getType(), record.getEpoch(), record.getSequenceNumber(),
StringUtil.toLog(record.getPeerAddress()));
+ informListenerOfRecordDrop(record);
if (health != null) {
health.receivingRecord(true);
}
@@ -3830,6 +3883,7 @@ public final void setAlertHandler(AlertHandler handler) {
}
private void discardRecord(final Record record, final Throwable cause) {
+ informListenerOfRecordDrop(record);
if (health != null) {
health.receivingRecord(true);
}
@@ -3846,6 +3900,12 @@ private void discardRecord(final Record record, final Throwable cause) {
}
}
+ private void informListenerOfRecordDrop(Record droppedRecord) {
+ if (datagramFilter instanceof DatagramFilterExtended) {
+ ((DatagramFilterExtended) datagramFilter).onDrop(droppedRecord);
+ }
+ }
+
@Override
public String getProtocol() {
return "DTLS";
diff --git a/scandium-core/src/main/java/org/eclipse/californium/scandium/DatagramFilterExtended.java b/scandium-core/src/main/java/org/eclipse/californium/scandium/DatagramFilterExtended.java
new file mode 100644
index 0000000000..d9d3c2eb4f
--- /dev/null
+++ b/scandium-core/src/main/java/org/eclipse/californium/scandium/DatagramFilterExtended.java
@@ -0,0 +1,41 @@
+/*******************************************************************************
+ * Copyright (c) 2022 AVSystem and others.
+ *
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * and Eclipse Distribution License v1.0 which accompany this distribution.
+ *
+ * The Eclipse Public License is available at
+ * http://www.eclipse.org/legal/epl-v20.html
+ * and the Eclipse Distribution License is available at
+ * http://www.eclipse.org/org/documents/edl-v10.html.
+ *
+ * Contributors:
+ * Bartłomiej Wiśniewski (AVSystem) - initial creation
+ ******************************************************************************/
+package org.eclipse.californium.scandium;
+
+import org.eclipse.californium.elements.util.PublicAPIExtension;
+import org.eclipse.californium.scandium.dtls.Record;
+
+import java.net.DatagramPacket;
+
+/**
+ * Extension of DatagramFilter.
+ *
+ * @since 3.8
+ */
+@PublicAPIExtension(type = DatagramFilter.class)
+public interface DatagramFilterExtended {
+
+ /**
+ * Called when a datagram packed is dropped. Allows to inject packet based action in form of callback.
+ * @param packet the dropped datagram packet
+ */
+ void onDrop(DatagramPacket packet);
+ /**
+ * Called when a record is dropped. Allows to inject record based action in form of callback.
+ * @param record the dropped record
+ */
+ void onDrop(Record record);
+}
diff --git a/scandium-core/src/main/java/org/eclipse/californium/scandium/config/DtlsConfig.java b/scandium-core/src/main/java/org/eclipse/californium/scandium/config/DtlsConfig.java
index 64d3976d83..d306130a21 100644
--- a/scandium-core/src/main/java/org/eclipse/californium/scandium/config/DtlsConfig.java
+++ b/scandium-core/src/main/java/org/eclipse/californium/scandium/config/DtlsConfig.java
@@ -17,6 +17,7 @@
import java.net.DatagramSocket;
import java.util.ArrayList;
+import java.util.Arrays;
import java.util.List;
import java.util.concurrent.TimeUnit;
@@ -39,6 +40,7 @@
import org.eclipse.californium.scandium.config.DtlsConnectorConfig.Builder;
import org.eclipse.californium.scandium.dtls.CertificateMessage;
import org.eclipse.californium.scandium.dtls.CertificateRequest;
+import org.eclipse.californium.scandium.dtls.CertificateType;
import org.eclipse.californium.scandium.dtls.ExtendedMasterSecretMode;
import org.eclipse.californium.scandium.dtls.HelloVerifyRequest;
import org.eclipse.californium.scandium.dtls.MaxFragmentLengthExtension.Length;
@@ -471,6 +473,16 @@ protected List parseValue(String value) {
public static final BooleanDefinition DTLS_VERIFY_SERVER_CERTIFICATES_SUBJECT = new BooleanDefinition(
MODULE + "VERIFY_SERVER_CERTIFICATES_SUBJECT", "DTLS verifies the server certificate's subjects.", true);
+ /**
+ * Specify the supported certificate types.
+ *
+ * @since 3.8
+ */
+ public static final EnumListDefinition DTLS_CERTIFICATE_TYPES = new EnumListDefinition<>(
+ MODULE + "CERTIFICATE_TYPES", "DTLS supported certificate types ordered by preference.",
+ Arrays.asList(CertificateType.RAW_PUBLIC_KEY, CertificateType.X_509),
+ new CertificateType[] { CertificateType.RAW_PUBLIC_KEY, CertificateType.X_509 });
+
/**
* Specify the supported DTLS roles.
*/
@@ -1052,6 +1064,7 @@ public void applyDefinitions(Configuration config) {
config.set(DTLS_USE_MULTI_HANDSHAKE_MESSAGE_RECORDS, null);
config.set(DTLS_CLIENT_AUTHENTICATION_MODE, CertificateAuthenticationMode.NEEDED);
config.set(DTLS_VERIFY_SERVER_CERTIFICATES_SUBJECT, true);
+ config.set(DTLS_CERTIFICATE_TYPES, Arrays.asList(CertificateType.RAW_PUBLIC_KEY, CertificateType.X_509));
config.set(DTLS_ROLE, DtlsRole.BOTH);
config.set(DTLS_MAX_TRANSMISSION_UNIT, null);
config.set(DTLS_MAX_TRANSMISSION_UNIT_LIMIT, DEFAULT_MAX_TRANSMISSION_UNIT_LIMIT);
diff --git a/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/ClientHello.java b/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/ClientHello.java
index ef10eb9ea8..fe0b9ea7df 100644
--- a/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/ClientHello.java
+++ b/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/ClientHello.java
@@ -386,15 +386,7 @@ public List getCipherSuites() {
* @since 3.0
*/
public List getCommonCipherSuites(List serverCipherSuite) {
- List common = new ArrayList<>();
- for (CipherSuite cipherSuite : supportedCipherSuites) {
- // NEVER negotiate NULL cipher suite
- if (cipherSuite.isValidForNegotiation() &&
- serverCipherSuite.contains(cipherSuite)) {
- common.add(cipherSuite);
- }
- }
- return common;
+ return CipherSuite.preselectCipherSuites(serverCipherSuite, supportedCipherSuites);
}
/**
diff --git a/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/DTLSFlight.java b/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/DTLSFlight.java
index c1b4ae48e8..a32ea17387 100644
--- a/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/DTLSFlight.java
+++ b/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/DTLSFlight.java
@@ -192,7 +192,16 @@ public class DTLSFlight {
* Indicates, whether this flight needs retransmission. The very last flight
* (not every flight needs retransmission, e.g. Alert).
*/
- private boolean retransmissionNeeded = false;
+ private boolean retransmissionNeeded;
+
+ /**
+ * Indicates, whether this flight includes a {@link Finished} message, or
+ * not.
+ *
+ * @see #addDtlsMessage(int, DTLSMessage)
+ * @since 3.9
+ */
+ private boolean finishedIncluded;
/**
* Indicates, that the first handshake message of the response is received.
@@ -239,6 +248,9 @@ public DTLSFlight(DTLSContext context, int flightNumber, InetSocketAddress peer)
/**
* Adds a dtls message to this flight.
*
+ * Sets {@link #finishedIncluded} to {@code true}, if provided message is a
+ * {@link Finished} message.
+ *
* @param epoch the epoch of the dtls message.
* @param messageToAdd the dtls message to add.
* @since 2.4
@@ -247,6 +259,9 @@ public void addDtlsMessage(int epoch, DTLSMessage messageToAdd) {
if (messageToAdd == null) {
throw new NullPointerException("message must not be null!");
}
+ if (messageToAdd instanceof Finished) {
+ finishedIncluded = true;
+ }
dtlsMessages.add(new EpochMessage(epoch, messageToAdd));
}
@@ -704,6 +719,18 @@ public boolean isResponseCompleted() {
return responseCompleted;
}
+ /**
+ * Check, if this flight includes a {@link Finished} message.
+ *
+ * @return {@code true}, if {@link Finished} message is included,
+ * {@code false}, otherwise.
+ * @see #addDtlsMessage(int, DTLSMessage)
+ * @since 3.9
+ */
+ public boolean isFinishedIncluded() {
+ return finishedIncluded;
+ }
+
/**
* Schedule timeout or retransmission task.
*
diff --git a/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/Handshaker.java b/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/Handshaker.java
index eeff98c858..4f4a107377 100644
--- a/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/Handshaker.java
+++ b/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/Handshaker.java
@@ -2062,6 +2062,9 @@ private void handleTimeout(DTLSFlight flight) {
}
// inform handshaker
if (timeout) {
+ if (flight.isFinishedIncluded() && getSession().getCipherSuite().isPskBased()) {
+ message += " Wrong PSK identity or secret?";
+ }
handshaker.handshakeFailed(new DtlsHandshakeTimeoutException(
"Handshake flight " + flight.getFlightNumber() + " failed!" + message,
flight.getFlightNumber()));
@@ -2354,6 +2357,20 @@ public boolean isRemovingConnection() {
return !handshakeAborted && !connection.hasEstablishedDtlsContext();
}
+ /**
+ * Check, if the handshake is a full handshake.
+ *
+ * Note: a resumption handshake, may start as abbreviated handshake
+ * and may change to a full handshake.
+ *
+ * @return {@code true} for a full handshake, {@code false}, for an
+ * abbreviated handshake
+ * @since 3.9
+ */
+ public boolean isFullHandshake() {
+ return true;
+ }
+
/**
* Get cause of failure.
*
diff --git a/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/ResumingClientHandshaker.java b/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/ResumingClientHandshaker.java
index 4730cd61d2..fb62a739a2 100644
--- a/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/ResumingClientHandshaker.java
+++ b/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/ResumingClientHandshaker.java
@@ -112,7 +112,7 @@ public class ResumingClientHandshaker extends ClientHandshaker {
new HandshakeState(HandshakeType.FINISHED) };
// flag to indicate if we must do a full handshake or an abbreviated one
- private boolean fullHandshake = false;
+ private volatile boolean fullHandshake = false;
/**
* Creates a new handshaker for resuming an existing session with a server.
@@ -300,4 +300,9 @@ public void startHandshake() throws HandshakeException {
sendFlight(flight);
setExpectedStates(INIT);
}
+
+ @Override
+ public boolean isFullHandshake() {
+ return fullHandshake;
+ }
}
diff --git a/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/ResumingServerHandshaker.java b/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/ResumingServerHandshaker.java
index e13fcb0f46..2f37d98fd2 100644
--- a/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/ResumingServerHandshaker.java
+++ b/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/ResumingServerHandshaker.java
@@ -311,6 +311,11 @@ private void processResumingClientHello(ClientHello clientHello) throws Handshak
expectChangeCipherSpecMessage();
}
+ @Override
+ public boolean isFullHandshake() {
+ return fullHandshake;
+ }
+
/**
* Checks, if the session and client hello are valid for an resumption
* handshake.
diff --git a/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/ServerHandshaker.java b/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/ServerHandshaker.java
index 3a73b8a9c7..628def6145 100644
--- a/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/ServerHandshaker.java
+++ b/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/ServerHandshaker.java
@@ -1072,7 +1072,7 @@ private List getCommonCipherSuites(ClientHello clientHello) {
// resumption, limit handshake to use the same cipher suite
supported = Arrays.asList(sessionCipherSuite);
}
- return clientHello.getCommonCipherSuites(supported);
+ return CipherSuite.preselectCipherSuites(supported, clientHello.getCipherSuites());
}
private List getCommonClientCertificateTypes(
diff --git a/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/cipher/CipherSuite.java b/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/cipher/CipherSuite.java
index 7845258161..28eefac7de 100644
--- a/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/cipher/CipherSuite.java
+++ b/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/cipher/CipherSuite.java
@@ -56,12 +56,18 @@
/**
* A cipher suite defines a key exchange algorithm, a bulk cipher algorithm, a
* MAC algorithm, a pseudo random number (PRF) algorithm and a cipher type.
- *
+ *
+ * Note: {@code ordinal()} must not be used!
+ * The order of the cipher-suites reflects the intended default precedence.
+ * Extensions may therefore change the related {@code ordinal()} value.
+ *
+ *
* See RFC 5246
* for details.
* See
* Transport Layer Security Parameters for the official codes for the cipher
* suites.
+ *
*/
public enum CipherSuite {
@@ -115,28 +121,113 @@ public enum CipherSuite {
TLS_PSK_WITH_AES_128_CCM(0xC0A4, CertificateKeyAlgorithm.NONE, KeyExchangeAlgorithm.PSK, CipherSpec.AES_128_CCM, true),
TLS_PSK_WITH_AES_256_CCM(0xC0A5, CertificateKeyAlgorithm.NONE, KeyExchangeAlgorithm.PSK, CipherSpec.AES_256_CCM, true),
+ /**
+ * See RFC 6209 - PSK for details.
+ *
+ * @since 3.9.0
+ */
+ TLS_PSK_WITH_ARIA_128_GCM_SHA256(0xC06A, CertificateKeyAlgorithm.NONE, KeyExchangeAlgorithm.PSK,
+ CipherSpec.ARIA_128_GCM, true),
+ /**
+ * See RFC 6209 - PSK for details.
+ *
+ * @since 3.9.0
+ */
+ TLS_PSK_WITH_ARIA_256_GCM_SHA384(0xC06B, CertificateKeyAlgorithm.NONE, KeyExchangeAlgorithm.PSK,
+ CipherSpec.ARIA_256_GCM, true, PRFAlgorithm.TLS_PRF_SHA384),
+
/**See RFC 5489 for details*/
TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256(0xC037, CertificateKeyAlgorithm.NONE, KeyExchangeAlgorithm.ECDHE_PSK, CipherSpec.AES_128_CBC, MACAlgorithm.HMAC_SHA256, false),
TLS_PSK_WITH_AES_128_CBC_SHA256(0x00AE, CertificateKeyAlgorithm.NONE, KeyExchangeAlgorithm.PSK, CipherSpec.AES_128_CBC, MACAlgorithm.HMAC_SHA256, false),
+ /**
+ * See RFC 6209 - PSK for details.
+ *
+ * @since 3.9.0
+ */
+ TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256(0xC06C, CertificateKeyAlgorithm.NONE, KeyExchangeAlgorithm.ECDHE_PSK, CipherSpec.ARIA_128_CBC, MACAlgorithm.HMAC_SHA256, false),
+ /**
+ * See RFC 6209 - PSK for details.
+ *
+ * @since 3.9.0
+ */
+ TLS_PSK_WITH_ARIA_128_CBC_SHA256(0xC064, CertificateKeyAlgorithm.NONE, KeyExchangeAlgorithm.PSK, CipherSpec.ARIA_128_CBC, MACAlgorithm.HMAC_SHA256, false),
+ /**
+ * See RFC 6209 - PSK for details.
+ *
+ * @since 3.9.0
+ */
+ TLS_PSK_WITH_ARIA_256_CBC_SHA384(0xC065, CertificateKeyAlgorithm.NONE, KeyExchangeAlgorithm.PSK, CipherSpec.ARIA_256_CBC, MACAlgorithm.HMAC_SHA384, false, PRFAlgorithm.TLS_PRF_SHA384),
+
// Certificate cipher suites, ordered by default preference, see getCertificateCipherSuites or getEcdsaCipherSuites
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256(0xc02b, CertificateKeyAlgorithm.EC, KeyExchangeAlgorithm.EC_DIFFIE_HELLMAN, CipherSpec.AES_128_GCM, true),
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384(0xc02c, CertificateKeyAlgorithm.EC, KeyExchangeAlgorithm.EC_DIFFIE_HELLMAN, CipherSpec.AES_256_GCM, true, PRFAlgorithm.TLS_PRF_SHA384),
+ TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256(0xC02B, CertificateKeyAlgorithm.EC, KeyExchangeAlgorithm.EC_DIFFIE_HELLMAN, CipherSpec.AES_128_GCM, true),
+ TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384(0xC02C, CertificateKeyAlgorithm.EC, KeyExchangeAlgorithm.EC_DIFFIE_HELLMAN, CipherSpec.AES_256_GCM, true, PRFAlgorithm.TLS_PRF_SHA384),
TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8(0xC0AE, CertificateKeyAlgorithm.EC, KeyExchangeAlgorithm.EC_DIFFIE_HELLMAN, CipherSpec.AES_128_CCM_8, true),
TLS_ECDHE_ECDSA_WITH_AES_256_CCM_8(0xC0AF, CertificateKeyAlgorithm.EC, KeyExchangeAlgorithm.EC_DIFFIE_HELLMAN, CipherSpec.AES_256_CCM_8, true),
TLS_ECDHE_ECDSA_WITH_AES_128_CCM(0xC0AC, CertificateKeyAlgorithm.EC, KeyExchangeAlgorithm.EC_DIFFIE_HELLMAN, CipherSpec.AES_128_CCM, true),
TLS_ECDHE_ECDSA_WITH_AES_256_CCM(0xC0AD, CertificateKeyAlgorithm.EC, KeyExchangeAlgorithm.EC_DIFFIE_HELLMAN, CipherSpec.AES_256_CCM, true),
+
+ /**
+ * See RFC 6209 - GCM for details.
+ *
+ * @since 3.9.0
+ */
+ TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256(0xC05C, CertificateKeyAlgorithm.EC, KeyExchangeAlgorithm.EC_DIFFIE_HELLMAN, CipherSpec.ARIA_128_GCM, true),
+ /**
+ * See RFC 6209 - GCM for details.
+ *
+ * @since 3.9.0
+ */
+ TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384(0xC05D, CertificateKeyAlgorithm.EC, KeyExchangeAlgorithm.EC_DIFFIE_HELLMAN, CipherSpec.ARIA_256_GCM, true, PRFAlgorithm.TLS_PRF_SHA384),
+
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256(0xC023, CertificateKeyAlgorithm.EC, KeyExchangeAlgorithm.EC_DIFFIE_HELLMAN, CipherSpec.AES_128_CBC, MACAlgorithm.HMAC_SHA256, false),
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384(0xC024, CertificateKeyAlgorithm.EC, KeyExchangeAlgorithm.EC_DIFFIE_HELLMAN, CipherSpec.AES_256_CBC, MACAlgorithm.HMAC_SHA384, false, PRFAlgorithm.TLS_PRF_SHA384),
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA(0xC00A, CertificateKeyAlgorithm.EC, KeyExchangeAlgorithm.EC_DIFFIE_HELLMAN, CipherSpec.AES_256_CBC, MACAlgorithm.HMAC_SHA1, false),
+ /**
+ * See RFC 6209 - CBC for details.
+ *
+ * @since 3.9.0
+ */
+ TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256(0xC048, CertificateKeyAlgorithm.EC, KeyExchangeAlgorithm.EC_DIFFIE_HELLMAN, CipherSpec.ARIA_128_CBC, MACAlgorithm.HMAC_SHA256, false),
+ /**
+ * See RFC 6209 - CBC for details.
+ *
+ * @since 3.9.0
+ */
+ TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384(0xC049, CertificateKeyAlgorithm.EC, KeyExchangeAlgorithm.EC_DIFFIE_HELLMAN, CipherSpec.ARIA_256_CBC, MACAlgorithm.HMAC_SHA384, false, PRFAlgorithm.TLS_PRF_SHA384),
+
// RSA Certificates
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256(0xc02f, CertificateKeyAlgorithm.RSA, KeyExchangeAlgorithm.EC_DIFFIE_HELLMAN, CipherSpec.AES_128_GCM, true),
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384(0xc030, CertificateKeyAlgorithm.RSA, KeyExchangeAlgorithm.EC_DIFFIE_HELLMAN, CipherSpec.AES_256_GCM, true, PRFAlgorithm.TLS_PRF_SHA384),
+ TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256(0xC02F, CertificateKeyAlgorithm.RSA, KeyExchangeAlgorithm.EC_DIFFIE_HELLMAN, CipherSpec.AES_128_GCM, true),
+ TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384(0xC030, CertificateKeyAlgorithm.RSA, KeyExchangeAlgorithm.EC_DIFFIE_HELLMAN, CipherSpec.AES_256_GCM, true, PRFAlgorithm.TLS_PRF_SHA384),
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256(0xC027, CertificateKeyAlgorithm.RSA, KeyExchangeAlgorithm.EC_DIFFIE_HELLMAN, CipherSpec.AES_128_CBC, MACAlgorithm.HMAC_SHA256, false),
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384(0xC028, CertificateKeyAlgorithm.RSA, KeyExchangeAlgorithm.EC_DIFFIE_HELLMAN, CipherSpec.AES_256_CBC, MACAlgorithm.HMAC_SHA384, false, PRFAlgorithm.TLS_PRF_SHA384),
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA(0xC014, CertificateKeyAlgorithm.RSA, KeyExchangeAlgorithm.EC_DIFFIE_HELLMAN, CipherSpec.AES_256_CBC, MACAlgorithm.HMAC_SHA1, false),
+ /**
+ * See RFC 6209 - GCM for details.
+ *
+ * @since 3.9.0
+ */
+ TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256(0xC060, CertificateKeyAlgorithm.RSA, KeyExchangeAlgorithm.EC_DIFFIE_HELLMAN, CipherSpec.ARIA_128_GCM, true),
+ /**
+ * See RFC 6209 - GCM for details.
+ *
+ * @since 3.9.0
+ */
+ TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384(0xC061, CertificateKeyAlgorithm.RSA, KeyExchangeAlgorithm.EC_DIFFIE_HELLMAN, CipherSpec.ARIA_256_GCM, true, PRFAlgorithm.TLS_PRF_SHA384),
+
// Null cipher suite
TLS_NULL_WITH_NULL_NULL(0x0000),
/**
@@ -151,9 +242,12 @@ public enum CipherSuite {
* @see DtlsSecureRenegotiation
* @since 3.8 (before that only used for logging since 3.5)
*/
- TLS_EMPTY_RENEGOTIATION_INFO_SCSV(0x00ff)
+ TLS_EMPTY_RENEGOTIATION_INFO_SCSV(0x00FF),
;
+ // Logging ////////////////////////////////////////////////////////
+ private static final Logger LOGGER = LoggerFactory.getLogger(CipherSuite.class);
+
// DTLS-specific constants ////////////////////////////////////////
public static final int CIPHER_SUITE_BITS = 16;
@@ -177,9 +271,6 @@ public enum CipherSuite {
STRONG_ENCRYPTION_PREFERENCE = Collections.unmodifiableList(secureSuites);
}
- // Logging ////////////////////////////////////////////////////////
- private static final Logger LOGGER = LoggerFactory.getLogger(CipherSuite.class);
-
// Members ////////////////////////////////////////////////////////
private static int overallMaxCipherTextExpansion = 0;
@@ -684,7 +775,7 @@ public static List getCipherSuitesByKeyExchangeAlgorithm(boolean re
for (CipherSuite suite : values()) {
if (!recommendedCipherSuitesOnly || suite.recommendedCipherSuite) {
if (suite.isSupported() && keyExchange.equals(suite.keyExchange)) {
- list.add(suite);
+ ListUtils.addIfAbsent(list, suite);
}
}
}
@@ -693,7 +784,7 @@ public static List getCipherSuitesByKeyExchangeAlgorithm(boolean re
for (CipherSuite suite : values()) {
if (!recommendedCipherSuitesOnly || suite.recommendedCipherSuite) {
if (suite.isSupported() && keyExchangeAlgorithms.contains(suite.keyExchange)) {
- list.add(suite);
+ ListUtils.addIfAbsent(list, suite);
}
}
}
@@ -949,7 +1040,7 @@ public static List preselectCipherSuites(List cipherSu
}
List ordered = new ArrayList<>();
for (CipherSuite cipherSuite : preselect) {
- if (cipherSuites.contains(cipherSuite)) {
+ if (cipherSuite.isValidForNegotiation() && cipherSuites.contains(cipherSuite)) {
ordered.add(cipherSuite);
}
}
@@ -1155,8 +1246,12 @@ private enum CipherSpec {
AES_256_CCM_8(AeadBlockCipher.AES_CCM_NO_PADDING, CipherType.AEAD, 32, 4, 8, 8), // explicit nonce (record IV) length = 8
AES_128_CCM(AeadBlockCipher.AES_CCM_NO_PADDING, CipherType.AEAD, 16, 4, 8, 16), // explicit nonce (record IV) length = 8
AES_256_CCM(AeadBlockCipher.AES_CCM_NO_PADDING, CipherType.AEAD, 32, 4, 8, 16), // explicit nonce (record IV) length = 8
- AES_128_GCM("AES/GCM/NoPadding", CipherType.AEAD, 16, 4, 8, 16), // requires jvm implementation of AES/GCM
- AES_256_GCM("AES/GCM/NoPadding", CipherType.AEAD, 32, 4, 8, 16); // requires jvm implementation of AES/GCM
+ AES_128_GCM("AES/GCM/NoPadding", CipherType.AEAD, 16, 4, 8, 16), // requires jce implementation of AES/GCM
+ AES_256_GCM("AES/GCM/NoPadding", CipherType.AEAD, 32, 4, 8, 16), // requires jce implementation of AES/GCM
+ ARIA_128_CBC("ARIA/CBC/NoPadding", CipherType.BLOCK, 16, 0, 16), // requires jce implementation of ARIA/CBC
+ ARIA_256_CBC("ARIA/CBC/NoPadding", CipherType.BLOCK, 32, 0, 16), // requires jce implementation of ARIA/CBC
+ ARIA_128_GCM("ARIA/GCM/NoPadding", CipherType.AEAD, 16, 4, 8, 16), // requires jce implementation of ARIA/GCM
+ ARIA_256_GCM("ARIA/GCM/NoPadding", CipherType.AEAD, 32, 4, 8, 16); // requires jce implementation of ARIA/GCM
/**
* The transformation string of the corresponding Java Cryptography Architecture
diff --git a/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/cipher/InvalidMacException.java b/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/cipher/InvalidMacException.java
index 22ec2dbe54..f9339c8ea6 100644
--- a/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/cipher/InvalidMacException.java
+++ b/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/cipher/InvalidMacException.java
@@ -27,7 +27,7 @@
public class InvalidMacException extends GeneralSecurityException {
private static final long serialVersionUID = 1L;
- private static final String DEFAULT_MESSAGE = "MAC validation failed";
+ private static final String DEFAULT_MESSAGE = "MAC validation failed!";
private final byte[] expected;
private final byte[] actual;
diff --git a/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/pskstore/MultiPskFileStore.java b/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/pskstore/MultiPskFileStore.java
index 6b6ccde508..7a192445c0 100644
--- a/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/pskstore/MultiPskFileStore.java
+++ b/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/pskstore/MultiPskFileStore.java
@@ -40,6 +40,9 @@
import org.eclipse.californium.elements.util.EncryptedStreamUtil;
import org.eclipse.californium.elements.util.StandardCharsets;
import org.eclipse.californium.elements.util.StringUtil;
+import org.eclipse.californium.elements.util.SystemResourceMonitors.SystemResourceCheckReady;
+import org.eclipse.californium.elements.util.SystemResourceMonitors.SystemResourceMonitor;
+import org.eclipse.californium.elements.util.SystemResourceMonitors.FileMonitor;
import org.eclipse.californium.scandium.dtls.ConnectionId;
import org.eclipse.californium.scandium.dtls.HandshakeResultHandler;
import org.eclipse.californium.scandium.dtls.PskPublicInformation;
@@ -52,30 +55,360 @@
/**
* File based {@link AdvancedPskStore} implementation supporting multiple peers.
*
+ * Lines in format:
+ *
+ *
+ * identity = secret - key(base64)
+ *
+ *
+ * or
+ *
+ *
+ * identity = ":0x" secret-key (hex)
+ *
+ *
+ * Example:
+ *
+ *
+ * Client_identity=c2VjcmV0UFNL
+ * imei351358811124772=:0x736573616D65
+ *
+ *
+ *
+ * Base 64 "c2VjcmV0UFNL" := "secretPSK"
+ * Hex "736573616D65" := "sesame"
+ *
+ *
* @since 3.7
*/
public class MultiPskFileStore implements AdvancedPskStore, Destroyable {
private static final Logger LOGGER = LoggerFactory.getLogger(MultiPskFileStore.class);
- private final ReentrantReadWriteLock lock = new ReentrantReadWriteLock();
- /**
- * List of identities.
- */
- private final List identities = new ArrayList<>();
/**
- * Map of identities and keys.
+ * PSK credentials.
*/
- private final Map keys = new HashMap<>();
+ private static class Credentials implements Destroyable {
+
+ private final ReentrantReadWriteLock lock = new ReentrantReadWriteLock();
+
+ /**
+ * List of identities.
+ */
+ private final List identities = new ArrayList<>();
+ /**
+ * Map of identities and keys.
+ */
+ private final Map keys = new HashMap<>();
+
+ /**
+ * {@code true} if credentials are destroyed.
+ */
+ private volatile boolean destroyed;
+
+ /**
+ * Add entry.
+ *
+ * New entries are appended to the index. Updated entries do not change
+ * their index position.
+ *
+ * @param id PSK identity
+ * @param key PSK secret
+ */
+ private void add(PskPublicInformation id, SecretKey key) {
+ lock.writeLock().lock();
+ try {
+ if (keys.put(id, key) == null) {
+ identities.add(id);
+ }
+ } finally {
+ lock.writeLock().unlock();
+ }
+ }
+
+ /**
+ * Remove entry.
+ *
+ * @param id PSK identity
+ */
+ private void remove(PskPublicInformation id) {
+ lock.writeLock().lock();
+ try {
+ SecretKey key = keys.remove(id);
+ if (key != null) {
+ SecretUtil.destroy(key);
+ identities.remove(id);
+ }
+ } finally {
+ lock.writeLock().unlock();
+ }
+ }
+
+ /**
+ * Remove entry by index.
+ *
+ * The index is based on the order of
+ * {@link #add(PskPublicInformation, SecretKey)} new entries.
+ *
+ * @param index index of entry.
+ * @throws IndexOutOfBoundsException if index is out of bounds
+ */
+ private void remove(int index) {
+ lock.writeLock().lock();
+ try {
+ PskPublicInformation id = identities.remove(index);
+ if (id != null) {
+ SecretKey key = keys.remove(id);
+ if (key != null) {
+ SecretUtil.destroy(key);
+ }
+ }
+ } finally {
+ lock.writeLock().unlock();
+ }
+ }
+
+ /**
+ * Get PSK secret by PSK identity.
+ *
+ * @param id PSK identity
+ * @return PSK secret, {@code null}, if not available.
+ */
+ private SecretKey getSecret(PskPublicInformation id) {
+ SecretKey key = null;
+ lock.readLock().lock();
+ try {
+ key = keys.get(id);
+ } finally {
+ lock.readLock().unlock();
+ }
+ return SecretUtil.create(key);
+ }
+
+ /**
+ * Get PSK secret by index.
+ *
+ * The index is based on the order of
+ * {@link #add(PskPublicInformation, SecretKey)} new entries.
+ *
+ * @param index index of entry.
+ * @return PSK secret
+ * @throws IndexOutOfBoundsException if index is out of bounds
+ */
+ private SecretKey getSecret(int index) {
+ lock.readLock().lock();
+ try {
+ PskPublicInformation info = identities.get(index);
+ if (info != null) {
+ return getSecret(info);
+ }
+ return null;
+ } finally {
+ lock.readLock().unlock();
+ }
+ }
+
+ /**
+ * Get identity by index.
+ *
+ * The index is based on the order of
+ * {@link #add(PskPublicInformation, SecretKey)} new entries.
+ *
+ * @param index index of identity
+ * @return identity as string
+ * @throws IndexOutOfBoundsException if index is out of bounds
+ */
+ private String getIdentity(int index) {
+ PskPublicInformation info = null;
+ lock.readLock().lock();
+ try {
+ info = identities.get(index);
+ } finally {
+ lock.readLock().unlock();
+ }
+ if (info != null) {
+ return info.getPublicInfoAsString();
+ }
+ return null;
+ }
+
+ /**
+ * Number of entries.
+ *
+ * @return number of entries
+ */
+ private int size() {
+ lock.readLock().lock();
+ try {
+ return identities.size();
+ } finally {
+ lock.readLock().unlock();
+ }
+ }
+
+ /**
+ * Lines in format:
+ *
+ *
+ * identity = secret - key(base64)
+ *
+ *
+ * @param writer writer to save PSK credentials
+ * @throws IOException if an I/O error occurred
+ */
+ private void savePskCredentials(Writer writer) throws IOException {
+ for (PskPublicInformation identity : identities) {
+ SecretKey secretKey = keys.get(identity);
+ if (secretKey != null) {
+ byte[] key = secretKey.getEncoded();
+ char[] base64 = StringUtil.byteArrayToBase64CharArray(key);
+ Bytes.clear(key);
+ writer.write(identity.getPublicInfoAsString());
+ writer.write('=');
+ writer.write(base64);
+ writer.write(StringUtil.lineSeparator());
+ Arrays.fill(base64, '.');
+ }
+ }
+ }
+
+ /**
+ * Load PSK credentials store.
+ *
+ * Lines in format:
+ *
+ *
+ * identity = secret - key(base64)
+ *
+ *
+ * or
+ *
+ *
+ * identity = ":0x" secret-key (hex)
+ *
+ *
+ * The identity must not contain a {@code =}!
+ *
+ * The psk credentials store keeps the order of the credentials in the
+ * file. Index {@code 0} will contain the credential of the first line.
+ *
+ * @param reader reader for credentials store.
+ * @throws IOException if an I/O error occurred
+ */
+ private void loadPskCredentials(Reader reader) throws IOException {
+ BufferedReader lineReader = new BufferedReader(reader);
+ try {
+ int lineNumber = 0;
+ int errors = 0;
+ int comments = 0;
+ String line;
+ // readLine() reads the secret into a String,
+ // what may be considered to be a weak practice.
+ while ((line = lineReader.readLine()) != null) {
+ ++lineNumber;
+ try {
+ if (!line.isEmpty() && !line.startsWith("#")) {
+ String[] entry = line.split("=", 2);
+ if (entry.length == 2) {
+ byte[] secretBytes;
+ if (entry[1].startsWith(":0x")) {
+ secretBytes = StringUtil.hex2ByteArray(entry[1].substring(3));
+ } else {
+ secretBytes = StringUtil.base64ToByteArray(entry[1]);
+ }
+ if (secretBytes.length == 0) {
+ LOGGER.warn("{}: '{}' invalid base64 secret in psk-line!", lineNumber, line);
+ ++errors;
+ continue;
+ }
+ SecretKey key = SecretUtil.create(secretBytes, "PSK");
+ Bytes.clear(secretBytes);
+ PskPublicInformation id = new PskPublicInformation(entry[0]);
+ add(id, key);
+ } else {
+ ++errors;
+ LOGGER.warn("{}: '{}' invalid psk-line entries!", lineNumber, line);
+ }
+ } else {
+ ++comments;
+ }
+ } catch (IllegalArgumentException ex) {
+ ++errors;
+ LOGGER.warn("{}: '{}' invalid psk-line!", lineNumber, line, ex);
+ }
+ }
+ if (size() == 0 && errors > 0 && lineNumber == comments + errors) {
+ LOGGER.warn("read psk-store, only errors, wrong password?");
+ SecretUtil.destroy(this);
+ }
+ } catch (IOException e) {
+ if (e.getCause() instanceof GeneralSecurityException) {
+ LOGGER.warn("read psk-store, wrong password?", e);
+ SecretUtil.destroy(this);
+ } else {
+ throw e;
+ }
+ } finally {
+ try {
+ lineReader.close();
+ } catch (IOException e) {
+ }
+ }
+ LOGGER.info("read {} PSK credentials.", size());
+ }
+
+ @Override
+ public void destroy() throws DestroyFailedException {
+ lock.writeLock().lock();
+ try {
+ identities.clear();
+ for (SecretKey credentials : keys.values()) {
+ SecretUtil.destroy(credentials);
+ }
+ keys.clear();
+ destroyed = true;
+ } finally {
+ lock.writeLock().unlock();
+ }
+ }
+
+ @Override
+ public boolean isDestroyed() {
+ return destroyed;
+ }
+ }
+
/**
* Encryption utility for encrypted psk stores.
*/
private final EncryptedStreamUtil encryptionUtility = new EncryptedStreamUtil();
+
+ /**
+ * Credentials.
+ *
+ * @since 3.8
+ */
+ private volatile Credentials credentials = new Credentials();
+
/**
* {@code true} if psk store is destroyed.
*/
private volatile boolean destroyed;
+ /**
+ * Seed of last loaded file.
+ *
+ * The seed is a random header to ensure, that the encrypted file will be
+ * different, even if the same credentials are contained. Used to detect
+ * changes in encrypted file.
+ *
+ * @see #clearSeed()
+ * @see #loadPskCredentials(String, SecretKey)
+ * @see #loadPskCredentials(InputStream, SecretKey)
+ * @since 3.8
+ */
+ private byte[] seed;
+
/**
* Set algorithm and key size.
*
@@ -86,6 +419,51 @@ public void setCipher(String cipherAlgorithm, int keySizeBits) {
encryptionUtility.setCipher(cipherAlgorithm, keySizeBits);
}
+ /**
+ * Get resource monitor for automatic credentials reloading.
+ *
+ * @param file filename of credentials store.
+ * @param password password of credentials store. {@code null} to use
+ * {@link #loadPskCredentials(String)} instead of
+ * {@link #loadPskCredentials(String, SecretKey)}.
+ * @return resource monitor
+ * @since 3.8
+ */
+ public SystemResourceMonitor getMonitor(final String file, final SecretKey password) {
+
+ return new FileMonitor(file) {
+
+ private SecretKey monitorPassword = SecretUtil.create(password);
+
+ @Override
+ protected void update(MonitoredValues values, SystemResourceCheckReady ready) {
+ if (file != null) {
+ if (monitorPassword != null) {
+ loadPskCredentials(file, monitorPassword);
+ } else {
+ loadPskCredentials(file);
+ }
+ }
+ ready(values);
+ ready.ready(false);
+ }
+ };
+ }
+
+ /**
+ * Clear seed to force loading.
+ *
+ * The store keeps the "seed" of encrypted files in order to prevent
+ * reloading that same file. To force loading the file, clear the "seed".
+ *
+ * @see #loadPskCredentials(String, SecretKey)
+ * @see #loadPskCredentials(InputStream, SecretKey)
+ * @since 3.8
+ */
+ public void clearSeed() {
+ this.seed = null;
+ }
+
/**
* Load PSK credentials store.
*
@@ -146,10 +524,16 @@ public MultiPskFileStore loadPskCredentials(String file, SecretKey password) {
* @see #loadPskCredentials(Reader)
*/
public MultiPskFileStore loadPskCredentials(InputStream in, SecretKey password) {
- try (InputStream inEncrypted = encryptionUtility.prepare(in, password)) {
- loadPskCredentials(inEncrypted);
- } catch (IOException e) {
- LOGGER.warn("read psk-store:", e);
+ byte[] seed = encryptionUtility.readSeed(in);
+ if (this.seed == null && !Arrays.equals(this.seed, seed)) {
+ try (InputStream inEncrypted = encryptionUtility.prepare(seed, in, password)) {
+ loadPskCredentials(inEncrypted);
+ this.seed = seed;
+ } catch (IOException e) {
+ LOGGER.warn("read psk-store:", e);
+ }
+ } else {
+ LOGGER.debug("Encrypted PSK store no changed seed.");
}
return this;
}
@@ -163,6 +547,12 @@ public MultiPskFileStore loadPskCredentials(InputStream in, SecretKey password)
* identity = secret - key(base64)
*
*
+ * or
+ *
+ *
+ * identity = ":0x" secret-key (hex)
+ *
+ *
* The identity must not contain a {@code =}!
*
* The psk credentials store keeps the order of the credentials in the file.
@@ -173,52 +563,16 @@ public MultiPskFileStore loadPskCredentials(InputStream in, SecretKey password)
* @throws IOException if an I/O error occurred
*/
public MultiPskFileStore loadPskCredentials(Reader reader) throws IOException {
- BufferedReader lineReader = new BufferedReader(reader);
- try {
- int lineNumber = 0;
- String line;
- // readLine() reads the secret into a String,
- // what may be considered to be a weak practice.
- while ((line = lineReader.readLine()) != null) {
- ++lineNumber;
- try {
- if (!line.isEmpty() && !line.startsWith("#")) {
- String[] entry = line.split("=", 2);
- if (entry.length == 2) {
- byte[] secretBytes = StringUtil.base64ToByteArray(entry[1]);
- SecretKey key = SecretUtil.create(secretBytes, "PSK");
- Bytes.clear(secretBytes);
- PskPublicInformation id = new PskPublicInformation(entry[0]);
- lock.writeLock().lock();
- try {
- if (keys.put(id, SecretUtil.create(key)) == null) {
- identities.add(id);
- }
- } finally {
- lock.writeLock().unlock();
- }
- } else {
- LOGGER.warn("{}: '{}' invalid psk-line!", lineNumber, line);
- }
- }
- } catch (IllegalArgumentException ex) {
- LOGGER.warn("{}: '{}' invalid psk-line!", lineNumber, line);
- }
- }
- } catch (IOException e) {
- if (e.getCause() instanceof GeneralSecurityException) {
- LOGGER.warn("read psk-store, wrong password?:", e);
- SecretUtil.destroy(this);
- } else {
- throw e;
- }
- } finally {
- try {
- lineReader.close();
- } catch (IOException e) {
+ Credentials newCredentials = new Credentials();
+ newCredentials.loadPskCredentials(reader);
+ if (newCredentials.isDestroyed()) {
+ if (credentials.size() == 0) {
+ destroyed = true;
}
+ } else {
+ credentials = newCredentials;
+ this.seed = null;
}
- LOGGER.info("read {} PSK credentials.", identities.size());
return this;
}
@@ -282,7 +636,7 @@ public MultiPskFileStore savePskCredentials(String file, SecretKey password) {
* @see #savePskCredentials(Writer)
*/
public MultiPskFileStore savePskCredentials(OutputStream out, SecretKey password) {
- try (OutputStream outEncrypted = encryptionUtility.prepare(out, password)) {
+ try (OutputStream outEncrypted = encryptionUtility.prepare(seed, out, password)) {
savePskCredentials(outEncrypted);
} catch (IOException e) {
LOGGER.warn("write psk-store:", e);
@@ -304,19 +658,7 @@ public MultiPskFileStore savePskCredentials(OutputStream out, SecretKey password
* @throws IOException if an I/O error occurred
*/
public MultiPskFileStore savePskCredentials(Writer writer) throws IOException {
- for (PskPublicInformation identity : identities) {
- SecretKey secretKey = keys.get(identity);
- if (secretKey != null) {
- byte[] key = secretKey.getEncoded();
- char[] base64 = StringUtil.byteArrayToBase64CharArray(key);
- Bytes.clear(key);
- writer.write(identity.getPublicInfoAsString());
- writer.write('=');
- writer.write(base64);
- writer.write(StringUtil.lineSeparator());
- Arrays.fill(base64, '.');
- }
- }
+ credentials.savePskCredentials(writer);
return this;
}
@@ -332,14 +674,7 @@ public MultiPskFileStore addKey(PskPublicInformation identity, SecretKey secret)
if (identity.getPublicInfoAsString().indexOf('=') >= 0) {
throw new IllegalArgumentException("Identity must not contain '='!");
}
- lock.writeLock().lock();
- try {
- if (keys.put(identity, SecretUtil.create(secret)) == null) {
- identities.add(identity);
- }
- } finally {
- lock.writeLock().unlock();
- }
+ credentials.add(identity, SecretUtil.create(secret));
return this;
}
@@ -362,14 +697,7 @@ public MultiPskFileStore addKey(String identity, SecretKey secret) {
* @return the file based PSK store for chaining
*/
public MultiPskFileStore removeKey(PskPublicInformation identity) {
- lock.writeLock().lock();
- try {
- if (keys.remove(identity) != null) {
- identities.add(identity);
- }
- } finally {
- lock.writeLock().unlock();
- }
+ credentials.remove(identity);
return this;
}
@@ -381,15 +709,7 @@ public MultiPskFileStore removeKey(PskPublicInformation identity) {
* @throws IndexOutOfBoundsException if provided index is out of bounds
*/
public MultiPskFileStore removeKey(int index) {
- lock.writeLock().lock();
- try {
- PskPublicInformation id = identities.remove(index);
- if (id != null) {
- keys.remove(id);
- }
- } finally {
- lock.writeLock().unlock();
- }
+ credentials.remove(index);
return this;
}
@@ -411,13 +731,7 @@ public MultiPskFileStore removeKey(String identity) {
* @throws IndexOutOfBoundsException if provided index is out of bounds
*/
public String getIdentity(int index) {
- lock.readLock().lock();
- try {
- PskPublicInformation info = identities.get(index);
- return info != null ? info.getPublicInfoAsString() : null;
- } finally {
- lock.readLock().unlock();
- }
+ return credentials.getIdentity(index);
}
/**
@@ -428,16 +742,7 @@ public String getIdentity(int index) {
* @throws IndexOutOfBoundsException if provided index is out of bounds
*/
public SecretKey getSecret(int index) {
- lock.readLock().lock();
- try {
- PskPublicInformation info = identities.get(index);
- if (info != null) {
- return SecretUtil.create(keys.get(info));
- }
- return null;
- } finally {
- lock.readLock().unlock();
- }
+ return credentials.getSecret(index);
}
/**
@@ -457,12 +762,7 @@ public SecretKey getSecret(String identity) {
* @return secret key for identity. {@code null} if not available.
*/
public SecretKey getSecret(PskPublicInformation identity) {
- lock.readLock().lock();
- try {
- return SecretUtil.create(keys.get(identity));
- } finally {
- lock.readLock().unlock();
- }
+ return credentials.getSecret(identity);
}
/**
@@ -471,22 +771,13 @@ public SecretKey getSecret(PskPublicInformation identity) {
* @return number of identity and key pairs.
*/
public int size() {
- return identities.size();
+ return credentials.size();
}
@Override
public void destroy() throws DestroyFailedException {
- lock.writeLock().lock();
- try {
- identities.clear();
- for (SecretKey credentials : keys.values()) {
- SecretUtil.destroy(credentials);
- }
- keys.clear();
- destroyed = true;
- } finally {
- lock.writeLock().unlock();
- }
+ credentials.destroy();
+ destroyed = true;
}
@Override
@@ -503,12 +794,7 @@ public boolean hasEcdhePskSupported() {
public PskSecretResult requestPskSecretResult(ConnectionId cid, ServerNames serverName,
PskPublicInformation identity, String hmacAlgorithm, SecretKey otherSecret, byte[] seed,
boolean useExtendedMasterSecret) {
- lock.readLock().lock();
- try {
- return new PskSecretResult(cid, identity, SecretUtil.create(keys.get(identity)));
- } finally {
- lock.readLock().unlock();
- }
+ return new PskSecretResult(cid, identity, credentials.getSecret(identity));
}
@Override
diff --git a/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/x509/AsyncKeyManagerCertificateProvider.java b/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/x509/AsyncKeyManagerCertificateProvider.java
index ccdab6ec33..34ba6f49e8 100644
--- a/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/x509/AsyncKeyManagerCertificateProvider.java
+++ b/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/x509/AsyncKeyManagerCertificateProvider.java
@@ -25,6 +25,7 @@
import org.eclipse.californium.elements.util.DaemonThreadFactory;
import org.eclipse.californium.elements.util.ExecutorsUtil;
import org.eclipse.californium.elements.util.NamedThreadFactory;
+import org.eclipse.californium.scandium.config.DtlsConfig;
import org.eclipse.californium.scandium.dtls.CertificateIdentityResult;
import org.eclipse.californium.scandium.dtls.CertificateType;
import org.eclipse.californium.scandium.dtls.ConnectionId;
@@ -37,7 +38,8 @@
import org.slf4j.LoggerFactory;
/**
- * Asynchronous test implementation based on {@link KeyManagerCertificateProvider}.
+ * Asynchronous test implementation based on
+ * {@link KeyManagerCertificateProvider}.
*
* Use {@code 0} or negative delays for test with synchronous blocking behavior.
* And positive delays for test with asynchronous none-blocking behavior.
@@ -51,7 +53,8 @@ public class AsyncKeyManagerCertificateProvider extends KeyManagerCertificatePro
/**
* Thread factory.
*/
- private static final NamedThreadFactory THREAD_FACTORY = new DaemonThreadFactory("AsyncKeyManagerCertProvider#", NamedThreadFactory.SCANDIUM_THREAD_GROUP);
+ private static final NamedThreadFactory THREAD_FACTORY = new DaemonThreadFactory("AsyncKeyManagerCertProvider#",
+ NamedThreadFactory.SCANDIUM_THREAD_GROUP);
/**
* Executor for asynchronous behaviour.
*/
@@ -74,13 +77,12 @@ public class AsyncKeyManagerCertificateProvider extends KeyManagerCertificatePro
*
* @param keyManager key manager with certificates and private keys
* @param supportedCertificateTypes array of supported certificate types
- * ordered by preference
+ * ordered by preference.
* @throws NullPointerException if the key manager is {@code null}
* @throws IllegalArgumentException if list of certificate types is empty or
* contains unsupported types.
*/
- public AsyncKeyManagerCertificateProvider(X509KeyManager keyManager,
- CertificateType... supportedCertificateTypes) {
+ public AsyncKeyManagerCertificateProvider(X509KeyManager keyManager, CertificateType... supportedCertificateTypes) {
super(keyManager, supportedCertificateTypes);
this.executorService = ExecutorsUtil.newSingleThreadScheduledExecutor(THREAD_FACTORY); // $NON-NLS-1$
}
@@ -90,7 +92,8 @@ public AsyncKeyManagerCertificateProvider(X509KeyManager keyManager,
*
* @param keyManager key manager with certificates and private keys
* @param supportedCertificateTypes list of supported certificate types
- * ordered by preference
+ * ordered by preference. Intended to use
+ * {@link DtlsConfig#DTLS_CERTIFICATE_TYPES} as input.
* @throws NullPointerException if the key manager is {@code null}
* @throws IllegalArgumentException if list of certificate types is empty or
* contains unsupported types.
@@ -124,7 +127,8 @@ public AsyncKeyManagerCertificateProvider(String defaultAlias, X509KeyManager ke
* @param defaultAlias default alias. May be {@code null}.
* @param keyManager key manager with certificates and private keys
* @param supportedCertificateTypes list of supported certificate types
- * ordered by preference
+ * ordered by preference. Intended to use
+ * {@link DtlsConfig#DTLS_CERTIFICATE_TYPES} as input.
* @throws NullPointerException if the key manager is {@code null}
* @throws IllegalArgumentException if list of certificate types is empty or
* contains unsupported types.
@@ -175,7 +179,8 @@ public void shutdown() {
@Override
public CertificateIdentityResult requestCertificateIdentity(final ConnectionId cid, final boolean client,
- final List issuers, final ServerNames serverNames, final List certificateKeyAlgorithms,
+ final List issuers, final ServerNames serverNames,
+ final List certificateKeyAlgorithms,
final List signatureAndHashAlgorithms, final List curves) {
if (delayMillis <= 0) {
@@ -185,15 +190,16 @@ public CertificateIdentityResult requestCertificateIdentity(final ConnectionId c
} catch (InterruptedException e) {
}
}
- return super.requestCertificateIdentity(cid, client, issuers, serverNames, certificateKeyAlgorithms, signatureAndHashAlgorithms,
- curves);
+ return super.requestCertificateIdentity(cid, client, issuers, serverNames, certificateKeyAlgorithms,
+ signatureAndHashAlgorithms, curves);
} else {
executorService.schedule(new Runnable() {
@Override
public void run() {
- CertificateIdentityResult result = AsyncKeyManagerCertificateProvider.super.requestCertificateIdentity(cid,
- client, issuers, serverNames, certificateKeyAlgorithms, signatureAndHashAlgorithms, curves);
+ CertificateIdentityResult result = AsyncKeyManagerCertificateProvider.super.requestCertificateIdentity(
+ cid, client, issuers, serverNames, certificateKeyAlgorithms, signatureAndHashAlgorithms,
+ curves);
resultHandler.apply(result);
}
}, delayMillis, TimeUnit.MILLISECONDS);
diff --git a/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/x509/KeyManagerCertificateProvider.java b/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/x509/KeyManagerCertificateProvider.java
index 88eb3ccd0b..9d991a968e 100644
--- a/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/x509/KeyManagerCertificateProvider.java
+++ b/scandium-core/src/main/java/org/eclipse/californium/scandium/dtls/x509/KeyManagerCertificateProvider.java
@@ -34,6 +34,7 @@
import org.eclipse.californium.elements.util.Asn1DerDecoder;
import org.eclipse.californium.elements.util.CertPathUtil;
import org.eclipse.californium.elements.util.JceProviderUtil;
+import org.eclipse.californium.scandium.config.DtlsConfig;
import org.eclipse.californium.scandium.dtls.CertificateIdentityResult;
import org.eclipse.californium.scandium.dtls.CertificateType;
import org.eclipse.californium.scandium.dtls.ConnectionId;
@@ -127,7 +128,8 @@ public KeyManagerCertificateProvider(X509KeyManager keyManager, CertificateType.
*
* @param keyManager key manager with certificates and private keys
* @param supportedCertificateTypes list of supported certificate types
- * ordered by preference
+ * ordered by preference. Intended to use
+ * {@link DtlsConfig#DTLS_CERTIFICATE_TYPES} as input.
* @throws NullPointerException if the key manager is {@code null}
* @throws IllegalArgumentException if list of certificate types is empty or
* contains unsupported types.
@@ -158,7 +160,8 @@ public KeyManagerCertificateProvider(String defaultAlias, X509KeyManager keyMana
* @param defaultAlias default alias. May be {@code null}.
* @param keyManager key manager with certificates and private keys
* @param supportedCertificateTypes list of supported certificate types
- * ordered by preference
+ * ordered by preference. Intended to use
+ * {@link DtlsConfig#DTLS_CERTIFICATE_TYPES} as input.
* @throws NullPointerException if the key manager is {@code null}
* @throws IllegalArgumentException if list of certificate types is empty or
* contains unsupported types.
diff --git a/scandium-core/src/main/java/org/eclipse/californium/scandium/util/ListUtils.java b/scandium-core/src/main/java/org/eclipse/californium/scandium/util/ListUtils.java
index 41975c766a..7815df6a6e 100644
--- a/scandium-core/src/main/java/org/eclipse/californium/scandium/util/ListUtils.java
+++ b/scandium-core/src/main/java/org/eclipse/californium/scandium/util/ListUtils.java
@@ -34,24 +34,44 @@ public class ListUtils {
* @throws IllegalArgumentException if duplicate items are contained
*/
public static List init(List values) {
+ return init(values, false);
+ }
+
+ /**
+ * Initialize ordered values, testing for contained item duplicates.
+ *
+ * @param element type of list
+ * @param values list of values. May be {@code null}.
+ * @param remove {@code true} remove duplicates, {@code false} throw
+ * IllegalArgumentException
+ * @return unmodifiable list with unique items, or {@code null}, if values
+ * is {@code null}.
+ * @throws IllegalArgumentException if duplicate items are contained and
+ * remove is {@code false}.
+ * @since 3.8
+ */
+ public static List init(List values, boolean remove) {
if (values == null) {
return null;
}
+ if (values.isEmpty()) {
+ return Collections.emptyList();
+ }
+ List result = new ArrayList<>(values.size());
+ result.add(values.get(0));
if (values.size() > 1) {
for (int index = 1; index < values.size(); ++index) {
T item = values.get(index);
- for (int search = 0; search < index; ++search) {
- T first = values.get(search);
- if (first.equals(item)) {
- throw new IllegalArgumentException(
- "Item " + item + "[" + index + "] is already contained at index [" + search + "]!");
- }
+ int first = result.indexOf(item);
+ if (first < 0) {
+ result.add(item);
+ } else if (!remove) {
+ throw new IllegalArgumentException(
+ "Item " + item + "[" + index + "] is already contained at index [" + first + "]!");
}
}
}
- // though the input List is unspecific,
- // ensure not to chain unmodifiables
- return Collections.unmodifiableList(new ArrayList<>(values));
+ return Collections.unmodifiableList(result);
}
/**
diff --git a/scandium-core/src/test/java/org/eclipse/californium/scandium/DTLSConnectorHandshakeTest.java b/scandium-core/src/test/java/org/eclipse/californium/scandium/DTLSConnectorHandshakeTest.java
index 7008b4182c..e423bc9de4 100644
--- a/scandium-core/src/test/java/org/eclipse/californium/scandium/DTLSConnectorHandshakeTest.java
+++ b/scandium-core/src/test/java/org/eclipse/californium/scandium/DTLSConnectorHandshakeTest.java
@@ -455,7 +455,7 @@ private void startServer() throws IOException, GeneralSecurityException {
if (incompleteConfig.get(DtlsConfig.DTLS_USE_SERVER_NAME_INDICATION)) {
serverBuilder.setCertificateIdentityProvider(new KeyManagerCertificateProvider(DtlsTestTools.SERVER_NAME,
- DtlsTestTools.getDtlsServerKeyManager(), CertificateType.RAW_PUBLIC_KEY, CertificateType.X_509));
+ DtlsTestTools.getDtlsServerKeyManager(), incompleteConfig.get(DtlsConfig.DTLS_CERTIFICATE_TYPES)));
}
if (incompleteConfig.get(DtlsConfig.DTLS_CLIENT_AUTHENTICATION_MODE) != CertificateAuthenticationMode.NONE) {
if (incompleteConfig.getAdvancedCertificateVerifier() == null) {
diff --git a/scandium-core/src/test/java/org/eclipse/californium/scandium/dtls/pskstore/MultiPskFileStoreTest.java b/scandium-core/src/test/java/org/eclipse/californium/scandium/dtls/pskstore/MultiPskFileStoreTest.java
index 509607e97d..21da49b573 100644
--- a/scandium-core/src/test/java/org/eclipse/californium/scandium/dtls/pskstore/MultiPskFileStoreTest.java
+++ b/scandium-core/src/test/java/org/eclipse/californium/scandium/dtls/pskstore/MultiPskFileStoreTest.java
@@ -15,12 +15,12 @@
import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.CoreMatchers.not;
+import static org.hamcrest.CoreMatchers.nullValue;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.Assert.assertArrayEquals;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
-import java.io.InputStream;
import javax.crypto.SecretKey;
@@ -39,10 +39,22 @@
public class MultiPskFileStoreTest {
/**
- * {@code me=secret},{@code you=public}.
+ * {@code me=secret}, {@code you=public}, {@code it=hex} .
*/
- private static final byte[] DATA = ("me=c2VjcmV0" + StringUtil.lineSeparator + "you=cHVibGlj"
- + StringUtil.lineSeparator).getBytes();
+ private static final byte[] DATA = (
+ "me=c2VjcmV0" + StringUtil.lineSeparator +
+ "you=cHVibGlj" + StringUtil.lineSeparator +
+ "it=:0x686578" + StringUtil.lineSeparator
+ ).getBytes();
+
+ /**
+ * {@code me=secret}, {@code you=public}, {@code it=hex} .
+ */
+ private static final byte[] DATA_STRICT_BASE64 = (
+ "me=c2VjcmV0" + StringUtil.lineSeparator +
+ "you=cHVibGlj" + StringUtil.lineSeparator +
+ "it=aGV4" + StringUtil.lineSeparator
+ ).getBytes();
@Rule
public LoggingRule logging = new LoggingRule();
@@ -57,25 +69,42 @@ public void setUp() throws Exception {
}
@After
- public void tearDownp() throws Exception {
+ public void tearDown() throws Exception {
store.destroy();
SecretUtil.destroy(secret);
}
@Test
public void testLoadPlainPskStore() {
- InputStream in = new ByteArrayInputStream(DATA);
- store.loadPskCredentials(in);
- assertThat(store.size(), is(2));
+ store.loadPskCredentials(new ByteArrayInputStream(DATA));
+ assertThat(store.size(), is(3));
- SecretKey key = store.getSecret("me");
SecretKey expected = SecretUtil.create("secret".getBytes(), PskSecretResult.ALGORITHM_PSK);
+ SecretKey key = store.getSecret("me");
+ assertThat(key, is(expected));
+ SecretUtil.destroy(key);
+
+ key = store.getSecret(0);
assertThat(key, is(expected));
SecretUtil.destroy(key);
SecretUtil.destroy(expected);
- key = store.getSecret("you");
expected = SecretUtil.create("public".getBytes(), PskSecretResult.ALGORITHM_PSK);
+ key = store.getSecret("you");
+ assertThat(key, is(expected));
+ SecretUtil.destroy(key);
+
+ key = store.getSecret(1);
+ assertThat(key, is(expected));
+ SecretUtil.destroy(key);
+ SecretUtil.destroy(expected);
+
+ expected = SecretUtil.create("hex".getBytes(), PskSecretResult.ALGORITHM_PSK);
+ key = store.getSecret("it");
+ assertThat(key, is(expected));
+ SecretUtil.destroy(key);
+
+ key = store.getSecret(2);
assertThat(key, is(expected));
SecretUtil.destroy(key);
SecretUtil.destroy(expected);
@@ -83,21 +112,19 @@ public void testLoadPlainPskStore() {
@Test
public void testSavePlainPskStore() {
- InputStream in = new ByteArrayInputStream(DATA);
- store.loadPskCredentials(in);
- assertThat(store.size(), is(2));
+ store.loadPskCredentials(new ByteArrayInputStream(DATA));
+ assertThat(store.size(), is(3));
ByteArrayOutputStream out = new ByteArrayOutputStream();
store.savePskCredentials(out);
- assertArrayEquals(DATA, out.toByteArray());
+ assertArrayEquals(DATA_STRICT_BASE64, out.toByteArray());
}
@Test
public void testSaveAndLoadEncryptedPskStore() {
- InputStream in = new ByteArrayInputStream(DATA);
- store.loadPskCredentials(in);
- assertThat(store.size(), is(2));
+ store.loadPskCredentials(new ByteArrayInputStream(DATA));
+ assertThat(store.size(), is(3));
ByteArrayOutputStream out = new ByteArrayOutputStream();
store.savePskCredentials(out, secret);
@@ -116,9 +143,8 @@ public void testSaveAndLoadEncryptedPskStore() {
@Test
public void testSaveAndLoadEncryptedPskStoreWithWrongPassword() {
- InputStream in = new ByteArrayInputStream(DATA);
- store.loadPskCredentials(in);
- assertThat(store.size(), is(2));
+ store.loadPskCredentials(new ByteArrayInputStream(DATA));
+ assertThat(store.size(), is(3));
ByteArrayOutputStream out = new ByteArrayOutputStream();
store.savePskCredentials(out, secret);
@@ -138,4 +164,26 @@ public void testSaveAndLoadEncryptedPskStoreWithWrongPassword() {
SecretUtil.destroy(key2);
}
+ @Test
+ public void testPskStoreRemove() {
+ store.loadPskCredentials(new ByteArrayInputStream(DATA));
+ assertThat(store.size(), is(3));
+
+ store.removeKey("me");
+ assertThat(store.size(), is(2));
+ assertThat(store.getSecret("me"), is(nullValue()));
+
+ store.removeKey("you");
+ assertThat(store.size(), is(1));
+ assertThat(store.getSecret("your"), is(nullValue()));
+
+
+ store.loadPskCredentials(new ByteArrayInputStream(DATA));
+ assertThat(store.size(), is(3));
+
+ store.removeKey(0);
+ assertThat(store.size(), is(2));
+ assertThat(store.getSecret("me"), is(nullValue()));
+ }
+
}