config-api does not populate displayName if backend MySQL #1482

devrimyatar · 2022-05-31T12:50:37Z

Describe the bug
config-api does not populate displayName if backend MySQL

To Reproduce

intall jans with MySQL backend
request list of OpenID Connect Clients

displayName exists in customAttributes, but in swagger yaml we marked it required.

Here is MySQL Backend output

[{
	"dn": "inum=1800.d694e30e-55f2-4f94-bd45-241a190ee498,ou=clients,o=jans",
	"deletable": false,
	"clientSecret": "7zQgHJcqBACk",
	"frontChannelLogoutUri": "null",
	"frontChannelLogoutSessionRequired": false,
	"redirectUris": ["https://snap.gluu.org/admin-ui", "http://localhost:4100"],
	"claimRedirectUris": [],
	"responseTypes": ["code"],
	"grantTypes": ["authorization_code", "refresh_token", "client_credentials"],
	"applicationType": "web",
	"contacts": [],
	"clientName": {},
	"logoUri": {},
	"clientUri": {},
	"policyUri": {},
	"tosUri": {},
	"subjectType": "pairwise",
	"idTokenSignedResponseAlg": "RS256",
	"tokenEndpointAuthMethod": "client_secret_basic",
	"requireAuthTime": false,
	"defaultAcrValues": [],
	"postLogoutRedirectUris": [],
	"requestUris": [],
	"scopes": ["inum=C4F7,ou=scopes,o=jans", "inum=1200.3D1C5D,ou=scopes,o=jans", "inum=1200.3D52BA,ou=scopes,o=jans", "inum=1800.EA9682,ou=scopes,o=jans", "inum=1800.79538B,ou=scopes,o=jans", "inum=1800.649FD3,ou=scopes,o=jans", "inum=1800.BD5769,ou=scopes,o=jans", "inum=1800.D1823E,ou=scopes,o=jans", "inum=1800.9F362F,ou=scopes,o=jans", "inum=1800.B1D789,ou=scopes,o=jans", "inum=1800.295886,ou=scopes,o=jans", "inum=1800.30DEB1,ou=scopes,o=jans", "inum=1800.E0106C,ou=scopes,o=jans", "inum=1800.BAC7A7,ou=scopes,o=jans", "inum=1800.6DC9DD,ou=scopes,o=jans", "inum=1800.B4C6FC,ou=scopes,o=jans", "inum=1800.DE963B,ou=scopes,o=jans", "inum=1800.7152B2,ou=scopes,o=jans", "inum=1800.D1E58D,ou=scopes,o=jans", "inum=1800.B69195,ou=scopes,o=jans", "inum=1800.4751A8,ou=scopes,o=jans", "inum=1800.5C0100,ou=scopes,o=jans", "inum=1800.A52841,ou=scopes,o=jans", "inum=1800.D52B0C,ou=scopes,o=jans", "inum=1800.9B0ECF,ou=scopes,o=jans", "inum=1800.ACFBC4,ou=scopes,o=jans", "inum=1800.57212F,ou=scopes,o=jans", "inum=1800.00B2F1,ou=scopes,o=jans", "inum=1800.3E3A82,ou=scopes,o=jans", "inum=1800.D59360,ou=scopes,o=jans", "inum=1800.43F09D,ou=scopes,o=jans", "inum=1800.352199,ou=scopes,o=jans", "inum=1800.028326,ou=scopes,o=jans", "inum=1800.22AEE4,ou=scopes,o=jans", "inum=1800.7853D5,ou=scopes,o=jans", "inum=1800.CBBF71,ou=scopes,o=jans", "inum=1800.E96131,ou=scopes,o=jans", "inum=1800.1A5F12,ou=scopes,o=jans", "inum=1800.902DE2,ou=scopes,o=jans", "inum=1800.933C63,ou=scopes,o=jans", "inum=1800.C07EDC,ou=scopes,o=jans", "inum=1800.A9C6F5,ou=scopes,o=jans", "inum=1800.194B4E,ou=scopes,o=jans", "inum=1800.B1FB43,ou=scopes,o=jans", "inum=1800.306E42,ou=scopes,o=jans", "inum=1800.E29799,ou=scopes,o=jans", "inum=1800.659275,ou=scopes,o=jans", "inum=1800.221CAA,ou=scopes,o=jans", "inum=1800.75841E,ou=scopes,o=jans", "inum=1800.F76355,ou=scopes,o=jans", "inum=1800.00225E,ou=scopes,o=jans", "inum=1800.BF5ABF,ou=scopes,o=jans"],
	"claims": [],
	"trustedClient": false,
	"persistClientAuthorizations": true,
	"includeClaimsInIdToken": false,
	"customAttributes": [{
		"name": "displayName",
		"multiValued": false,
		"values": ["Jans Config Api Client"],
		"displayValue": "Jans Config Api Client",
		"value": "Jans Config Api Client"
	}],
	"rptAsJwt": false,
	"accessTokenAsJwt": false,
	"accessTokenSigningAlg": "RS256",
	"disabled": false,
	"authorizedOrigins": [],
	"attributes": {
		"runIntrospectionScriptBeforeAccessTokenAsJwtCreationAndIncludeClaims": false,
		"keepClientAuthorizationAfterExpiration": false,
		"allowSpontaneousScopes": false,
		"backchannelLogoutSessionRequired": false,
		"parLifetime": 600,
		"requirePar": false,
		"jansDefaultPromptLogin": false
	},
	"authenticationMethod": "client_secret_basic",
	"tokenBindingSupported": false,
	"baseDn": "inum=1800.d694e30e-55f2-4f94-bd45-241a190ee498,ou=clients,o=jans",
	"inum": "1800.d694e30e-55f2-4f94-bd45-241a190ee498"
}]

And here is OpenDJ backend output

[{
	"dn": "inum=1800.c30e5c61-f636-4daa-a811-426a80a9a6c9,ou=clients,o=jans",
	"deletable": false,
	"clientSecret": "kF4IAZf5ZQda",
	"frontChannelLogoutSessionRequired": false,
	"redirectUris": ["https://snap.gluu.org/admin-ui", "http://localhost:4100"],
	"responseTypes": ["code"],
	"grantTypes": ["authorization_code", "refresh_token", "client_credentials"],
	"applicationType": "web",
	"clientName": {
		"values": {
			"": "Jans Config Api Client"
		},
		"languageTags": [""],
		"value": "Jans Config Api Client"
	},
	"logoUri": {},
	"clientUri": {},
	"policyUri": {},
	"tosUri": {},
	"subjectType": "pairwise",
	"idTokenSignedResponseAlg": "RS256",
	"tokenEndpointAuthMethod": "client_secret_basic",
	"requireAuthTime": false,
	"scopes": ["inum=C4F7,ou=scopes,o=jans", "inum=1200.98A667,ou=scopes,o=jans", "inum=1200.6F7D71,ou=scopes,o=jans", "inum=1800.7E44C0,ou=scopes,o=jans", "inum=1800.03463A,ou=scopes,o=jans", "inum=1800.5B4F12,ou=scopes,o=jans", "inum=1800.6BF022,ou=scopes,o=jans", "inum=1800.4092DB,ou=scopes,o=jans", "inum=1800.C2BA9E,ou=scopes,o=jans", "inum=1800.02960D,ou=scopes,o=jans", "inum=1800.36C81B,ou=scopes,o=jans", "inum=1800.07CDC6,ou=scopes,o=jans", "inum=1800.4F58B2,ou=scopes,o=jans", "inum=1800.78490D,ou=scopes,o=jans", "inum=1800.7DCB01,ou=scopes,o=jans", "inum=1800.09B41C,ou=scopes,o=jans", "inum=1800.3C71D6,ou=scopes,o=jans", "inum=1800.80B393,ou=scopes,o=jans", "inum=1800.D17859,ou=scopes,o=jans", "inum=1800.F7FE05,ou=scopes,o=jans", "inum=1800.3DE769,ou=scopes,o=jans", "inum=1800.620199,ou=scopes,o=jans", "inum=1800.2C3024,ou=scopes,o=jans", "inum=1800.1BAC79,ou=scopes,o=jans", "inum=1800.F64DAE,ou=scopes,o=jans", "inum=1800.537E5C,ou=scopes,o=jans", "inum=1800.6D9311,ou=scopes,o=jans", "inum=1800.6B3A8F,ou=scopes,o=jans", "inum=1800.A7F4C4,ou=scopes,o=jans", "inum=1800.227696,ou=scopes,o=jans", "inum=1800.C3F5E8,ou=scopes,o=jans", "inum=1800.020D36,ou=scopes,o=jans", "inum=1800.95A0BB,ou=scopes,o=jans", "inum=1800.BE2CAF,ou=scopes,o=jans", "inum=1800.76D31B,ou=scopes,o=jans", "inum=1800.678F7C,ou=scopes,o=jans", "inum=1800.6440F0,ou=scopes,o=jans", "inum=1800.286F13,ou=scopes,o=jans", "inum=1800.859769,ou=scopes,o=jans", "inum=1800.7EEBCD,ou=scopes,o=jans", "inum=1800.F2A2FF,ou=scopes,o=jans", "inum=1800.0C8D82,ou=scopes,o=jans", "inum=1800.40F161,ou=scopes,o=jans", "inum=1800.CA0556,ou=scopes,o=jans", "inum=1800.CE96CE,ou=scopes,o=jans", "inum=1800.E00FAB,ou=scopes,o=jans", "inum=1800.91E946,ou=scopes,o=jans", "inum=1800.1F4288,ou=scopes,o=jans", "inum=1800.C0B2F8,ou=scopes,o=jans", "inum=1800.D89FEC,ou=scopes,o=jans", "inum=1800.0E4BBA,ou=scopes,o=jans", "inum=1800.E001EE,ou=scopes,o=jans"],
	"trustedClient": false,
	"persistClientAuthorizations": true,
	"includeClaimsInIdToken": false,
	"customAttributes": [{
		"name": "displayName",
		"multiValued": false,
		"values": ["Jans Config Api Client"],
		"displayValue": "Jans Config Api Client",
		"value": "Jans Config Api Client"
	}],
	"customObjectClasses": ["top"],
	"rptAsJwt": false,
	"accessTokenAsJwt": false,
	"accessTokenSigningAlg": "RS256",
	"disabled": false,
	"attributes": {
		"runIntrospectionScriptBeforeAccessTokenAsJwtCreationAndIncludeClaims": false,
		"keepClientAuthorizationAfterExpiration": false,
		"allowSpontaneousScopes": false,
		"backchannelLogoutSessionRequired": false,
		"parLifetime": 600,
		"requirePar": false,
		"jansDefaultPromptLogin": false
	},
	"displayName": "Jans Config Api Client",
	"authenticationMethod": "client_secret_basic",
	"tokenBindingSupported": false,
	"baseDn": "inum=1800.c30e5c61-f636-4daa-a811-426a80a9a6c9,ou=clients,o=jans",
	"inum": "1800.c30e5c61-f636-4daa-a811-426a80a9a6c9"
}]

The text was updated successfully, but these errors were encountered:

pujavs · 2022-05-31T16:10:27Z

@yurem this issue seems to be because of difference in attribute name and object property name. Request you to please chk
https://github.com/JanssenProject/jans/blob/main/jans-auth-server/common/src/main/java/io/jans/as/common/model/registration/Client.java#L81

qbert2k · 2022-06-08T20:51:30Z

Hello @pujavs

Sorry for the inconvenients, I have added a new feature for language metadata for client_name (displayName), logo_uri (jansLogoURI), client_uri (jansClntURI), policy_uri (jansPolicyURI), and tos_uri (jansTosURI). This feature is the reason of the issue reported here.

There are more details at: #1057

pujavs · 2022-06-13T08:31:46Z

@qbert2k, no worries, do i have have to make any change in config-api code to handle this?

duttarnab · 2022-07-05T13:32:33Z

Hi @pujavs @yurem @qbert2k , could you please provide an update on this issue.
The admin-ui oidc client not working as expected due to this issue.

pujavs · 2022-07-12T08:57:25Z

@yurem @qbert2k
There are three issues related to LocalizedString

The values of LocalizedString needs to be returned in String format rather than object.
I need to fix these issues today, In config-api I have only one option that is to create a new covering DTO for Client.java which will be a overhead.

Can we have new getter and setter to take and return value in String format directly in Client.java ?

pujavs · 2022-08-18T15:41:40Z

Fix being worked by @qbert2k, details in 1765

yurem · 2022-10-27T14:49:46Z

We have issue with indexes for @LanguageTag in CB/Spanner/MySQL/PostgresSQL too.

According to output above we store them in next format:

	"clientName": {
		"values": {
			"": "Jans Config Api Client"
		},
		"languageTags": [""],
		"value": "Jans Config Api Client"
	},

It's possible to add indexes for such JSON values (except Spanner). But we need to use another definitions than for multi-values attributes now.
Also our filter API build queries for multivalues attributes for all DB. But case with@LanguageTagwe should handle separately.

yurem · 2022-10-27T14:55:24Z

From my point of view clientName should be simple attribute.
If we need to store localized client names we can use another attribute like:

    @AttributeName(name = "displayNameLocalized")
    @JsonObject
    private LocalizedString clientNameLocalized = new LocalizedString();

ORM in this case should convert LocalizedString object from object to JSON and back automatically without additional code.

Alternative idea is to store them as customAttribute. In this case it will be application responsibility to convert them to string/json

yurem · 2022-10-27T14:57:51Z

Third option is to fix @LanguageTag implementation and resolve issues mentioned above

yurem · 2022-10-27T15:02:44Z

Link to original issue: #1057

pujavs · 2023-01-17T07:18:08Z

@devrimyatar , this seem to have resolved, below is the test evidence from my-sql environment.
Request you to please verify and reopen the issue if required

devrimyatar added kind-bug Issue or PR is a bug in existing functionality comp-jans-config-api Component affected by issue or PR labels May 31, 2022

devrimyatar assigned pujavs May 31, 2022

pujavs assigned yurem May 31, 2022

yurem mentioned this issue May 31, 2022

feat: auth Server should Support Client Registration Language Metadata #1057

Closed

moabu added this to the 1.0.1 milestone Jun 15, 2022

moabu modified the milestones: 1.0.1, 1.0.2 Jul 8, 2022

moabu modified the milestones: 1.0.2, 1.0.3 Aug 30, 2022

This was referenced Oct 5, 2022

fix: localized String should be converted to JSON #2542

Merged

fix: unable to insert oidc client #2455

Closed

pujavs assigned qbert2k Oct 5, 2022

duttarnab mentioned this issue Oct 7, 2022

fix(admin-ui): hindrance on client scope assignment GluuFederation/flex#502

Closed

pujavs mentioned this issue Oct 13, 2022

fix:(jans-cli) unable to update openid client getting error #2421

Closed

moabu modified the milestones: 1.0.3, 1.0.4 Nov 3, 2022

yuriyz mentioned this issue Nov 4, 2022

Jans auth server client registration language metadata fix tests #2864

Closed

5 tasks

moabu modified the milestones: 1.0.4, 1.0.5 Nov 14, 2022

pujavs mentioned this issue Nov 22, 2022

fix:(jans-config) getting error while create openid client #2946

Closed

moabu modified the milestones: 1.0.5, 1.0.6 Dec 1, 2022

ossdhaval unassigned qbert2k Dec 20, 2022

moabu modified the milestones: 1.0.6, 1.0.7 Jan 9, 2023

pujavs assigned devrimyatar Jan 17, 2023

pujavs closed this as completed Jan 17, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

config-api does not populate displayName if backend MySQL #1482

config-api does not populate displayName if backend MySQL #1482

devrimyatar commented May 31, 2022 •

edited

Loading

pujavs commented May 31, 2022

qbert2k commented Jun 8, 2022

pujavs commented Jun 13, 2022

duttarnab commented Jul 5, 2022

pujavs commented Jul 12, 2022 •

edited

Loading

pujavs commented Aug 18, 2022

yurem commented Oct 27, 2022

yurem commented Oct 27, 2022 •

edited

Loading

yurem commented Oct 27, 2022

yurem commented Oct 27, 2022

pujavs commented Jan 17, 2023 •

edited

Loading

config-api does not populate displayName if backend MySQL #1482

config-api does not populate displayName if backend MySQL #1482

Comments

devrimyatar commented May 31, 2022 • edited Loading

pujavs commented May 31, 2022

qbert2k commented Jun 8, 2022

pujavs commented Jun 13, 2022

duttarnab commented Jul 5, 2022

pujavs commented Jul 12, 2022 • edited Loading

pujavs commented Aug 18, 2022

yurem commented Oct 27, 2022

yurem commented Oct 27, 2022 • edited Loading

yurem commented Oct 27, 2022

yurem commented Oct 27, 2022

pujavs commented Jan 17, 2023 • edited Loading

devrimyatar commented May 31, 2022 •

edited

Loading

pujavs commented Jul 12, 2022 •

edited

Loading

yurem commented Oct 27, 2022 •

edited

Loading

pujavs commented Jan 17, 2023 •

edited

Loading