Skip to content

Add 8.19 transport version for IdP Extension Attr #129233

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 13, 2025
Merged

Add 8.19 transport version for IdP Extension Attr #129233

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1fa84bd
Add 8.19 transport version for IdP Extension Attr
tvernum Jun 10, 2025
bbc1c9b
Merge branch 'main' into backport/prepare/128805-idp-extension
tvernum Jun 13, 2025
0db9631
Use single element in test
tvernum Jun 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions server/src/main/java/org/elasticsearch/TransportVersions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,7 @@ static TransportVersion def(int id) {
public static final TransportVersion SEARCH_SOURCE_EXCLUDE_VECTORS_PARAM_8_19 = def(8_841_0_46);
public static final TransportVersion ML_INFERENCE_MISTRAL_CHAT_COMPLETION_ADDED_8_19 = def(8_841_0_47);
public static final TransportVersion ML_INFERENCE_ELASTIC_RERANK_ADDED_8_19 = def(8_841_0_48);
public static final TransportVersion IDP_CUSTOM_SAML_ATTRIBUTES_ALLOW_LIST_8_19 = def(8_841_0_49);
public static final TransportVersion V_9_0_0 = def(9_000_0_09);
public static final TransportVersion INITIAL_ELASTICSEARCH_9_0_1 = def(9_000_0_10);
public static final TransportVersion INITIAL_ELASTICSEARCH_9_0_2 = def(9_000_0_11);
Expand Down
7 changes: 5 additions & 2 deletions ...ovider/src/main/java/org/elasticsearch/xpack/idp/saml/sp/SamlServiceProviderDocument.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
import java.util.function.BiConsumer;

import static org.elasticsearch.TransportVersions.IDP_CUSTOM_SAML_ATTRIBUTES_ALLOW_LIST;
import static org.elasticsearch.TransportVersions.IDP_CUSTOM_SAML_ATTRIBUTES_ALLOW_LIST_8_19;

/**
* This class models the storage of a {@link SamlServiceProvider} as an Elasticsearch document.
Expand Down Expand Up @@ -276,7 +277,8 @@ public SamlServiceProviderDocument(StreamInput in) throws IOException {
attributeNames.name = in.readOptionalString();
attributeNames.roles = in.readOptionalString();

if (in.getTransportVersion().onOrAfter(IDP_CUSTOM_SAML_ATTRIBUTES_ALLOW_LIST)) {
if (in.getTransportVersion().isPatchFrom(IDP_CUSTOM_SAML_ATTRIBUTES_ALLOW_LIST_8_19)
|| in.getTransportVersion().onOrAfter(IDP_CUSTOM_SAML_ATTRIBUTES_ALLOW_LIST)) {
attributeNames.extensions = in.readCollectionAsImmutableSet(StreamInput::readString);
}

Expand Down Expand Up @@ -305,7 +307,8 @@ public void writeTo(StreamOutput out) throws IOException {
out.writeOptionalString(attributeNames.name);
out.writeOptionalString(attributeNames.roles);

if (out.getTransportVersion().onOrAfter(IDP_CUSTOM_SAML_ATTRIBUTES_ALLOW_LIST)) {
if (out.getTransportVersion().isPatchFrom(IDP_CUSTOM_SAML_ATTRIBUTES_ALLOW_LIST_8_19)
|| out.getTransportVersion().onOrAfter(IDP_CUSTOM_SAML_ATTRIBUTES_ALLOW_LIST)) {
out.writeStringCollection(attributeNames.extensions);
}

Expand Down
31 changes: 30 additions & 1 deletion ...r/src/test/java/org/elasticsearch/xpack/idp/saml/sp/SamlServiceProviderDocumentTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
import java.util.Set;

import static org.elasticsearch.test.hamcrest.ElasticsearchAssertions.assertToXContentEquivalent;
import static org.hamcrest.Matchers.empty;
import static org.hamcrest.Matchers.emptyIterable;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.not;
Expand Down Expand Up @@ -90,6 +91,31 @@ public void testStreamRoundTripWithAllFields() throws Exception {
assertThat(assertSerializationRoundTrip(doc2), equalTo(doc1));
}

public void testSerializationBeforeExtensionAttributes() throws Exception {
final SamlServiceProviderDocument original = createFullDocument();
final TransportVersion version = randomBoolean()
? TransportVersionUtils.randomVersionBetween(
random(),
TransportVersions.V_9_0_0,
TransportVersionUtils.getPreviousVersion(TransportVersions.IDP_CUSTOM_SAML_ATTRIBUTES_ALLOW_LIST)
)
: TransportVersionUtils.randomVersionBetween(
random(),
TransportVersions.V_8_0_0,
TransportVersionUtils.getPreviousVersion(TransportVersions.IDP_CUSTOM_SAML_ATTRIBUTES_ALLOW_LIST_8_19)
);
final SamlServiceProviderDocument copy = copyWriteable(
original,
new NamedWriteableRegistry(List.of()),
SamlServiceProviderDocument::new,
version
);
assertThat(copy.attributeNames.extensions, empty());

copy.attributeNames.setExtensions(original.attributeNames.extensions);
assertThat(copy, equalTo(original));
}

private SamlServiceProviderDocument createFullDocument() throws GeneralSecurityException, IOException {
final List<X509Credential> credentials = readCredentials();
final List<X509Certificate> certificates = credentials.stream().map(X509Credential::getEntityCertificate).toList();
Expand Down Expand Up @@ -121,6 +147,9 @@ private SamlServiceProviderDocument createFullDocument() throws GeneralSecurityE
doc1.attributeNames.setEmail("urn:" + randomAlphaOfLengthBetween(4, 8) + "." + randomAlphaOfLengthBetween(4, 8));
doc1.attributeNames.setName("urn:" + randomAlphaOfLengthBetween(4, 8) + "." + randomAlphaOfLengthBetween(4, 8));
doc1.attributeNames.setRoles("urn:" + randomAlphaOfLengthBetween(4, 8) + "." + randomAlphaOfLengthBetween(4, 8));
doc1.attributeNames.setExtensions(
randomList(0, 3, () -> "urn:" + randomAlphaOfLengthBetween(4, 8) + "." + randomAlphaOfLengthBetween(4, 8))
Copy link
Contributor

@slobodanadamovic slobodanadamovic Jun 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The testStreamRoundTripWithAllFields now fails randomly in assertToXContentEquivalent. The problem seem to be with the ordering of extensions items:

java.lang.AssertionError: Error when comparing xContent.
                           acs: same [https://cEtrLOYX.LakSo/saml/acs]
                    attributes: 
                           email: same [urn:hAVRt.inLOJA]
                      extensions: 
                                 0: expected String [urn:pDeptYdD.rehxgHP] but was String [urn:BeZmekTl.QhNbhUns]
                                 1: expected String [urn:BeZmekTl.QhNbhUns] but was String [urn:pDeptYdD.rehxgHP]

Copy link
Contributor Author

@tvernum tvernum Jun 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I'll just make it a single element then.

);
return doc1;
}

Expand Down Expand Up @@ -162,7 +191,7 @@ private SamlServiceProviderDocument assertXContentRoundTrip(SamlServiceProviderD
private SamlServiceProviderDocument assertSerializationRoundTrip(SamlServiceProviderDocument doc) throws IOException {
final TransportVersion version = TransportVersionUtils.randomVersionBetween(
random(),
TransportVersions.V_8_0_0,
TransportVersions.IDP_CUSTOM_SAML_ATTRIBUTES_ALLOW_LIST,
TransportVersion.current()
);
final SamlServiceProviderDocument read = copyWriteable(
Expand Down