Skip to content
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

Jump to bottom

Add new authenticator property. #664

Closed
wants to merge 2 commits into from
Closed

Add new authenticator property. #664

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
86e184d
Add new authenticator property.
Thisara-Welmilla Sep 14, 2024
2efd814
Add new authenticator property: authenticationType.
Thisara-Welmilla Oct 2, 2024
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
6 changes: 6 additions & 0 deletions ...er/application/management/v1/core/functions/application/UpdateAuthenticationSequence.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@
import org.wso2.carbon.identity.application.common.model.ServiceProvider;
import org.wso2.carbon.identity.application.common.model.script.AuthenticationScriptConfig;
import org.wso2.carbon.identity.application.mgt.ApplicationConstants;
import org.wso2.carbon.identity.base.AuthenticatorPropertiesConstant.AuthenticationType;
import org.wso2.carbon.identity.base.AuthenticatorPropertiesConstant.DefinedByType;

import java.util.ArrayList;
import java.util.Collections;
Expand Down Expand Up @@ -160,11 +162,15 @@ private AuthenticationStep buildAuthenticationStep(AuthenticationStepModel stepM
LocalAuthenticatorConfig localAuthOption = new LocalAuthenticatorConfig();
localAuthOption.setEnabled(true);
localAuthOption.setName(option.getAuthenticator());
localAuthOption.setDefinedByType(DefinedByType.SYSTEM);
localAuthOption.setAuthenticationType(AuthenticationType.IDENTIFICATION);
localAuthOptions.add(localAuthOption);
} else {
FederatedAuthenticatorConfig federatedAuthConfig = new FederatedAuthenticatorConfig();
federatedAuthConfig.setEnabled(true);
federatedAuthConfig.setName(option.getAuthenticator());
federatedAuthConfig.setDefinedByType(DefinedByType.SYSTEM);
federatedAuthConfig.setAuthenticationType(AuthenticationType.IDENTIFICATION);

IdentityProvider federatedIdp = new IdentityProvider();
federatedIdp.setIdentityProviderName(option.getIdp());
Expand Down
110 changes: 109 additions & 1 deletion ...c/gen/java/org/wso2/carbon/identity/api/server/authenticators/v1/model/Authenticator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,74 @@ public class Authenticator {
private String displayName;
private Boolean isEnabled;

@XmlType(name="DefinedByEnum")
@XmlEnum(String.class)
public enum DefinedByEnum {

@XmlEnumValue("SYSTEM") SYSTEM(String.valueOf("SYSTEM")), @XmlEnumValue("USER") USER(String.valueOf("USER"));


private String value;

DefinedByEnum(String v) {
value = v;
}

public String value() {
return value;
}

@Override
public String toString() {
return String.valueOf(value);
}

public static DefinedByEnum fromValue(String value) {
for (DefinedByEnum b : DefinedByEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}

private DefinedByEnum definedBy;

@XmlType(name="AuthenticationTypeEnum")
@XmlEnum(String.class)
public enum AuthenticationTypeEnum {

@XmlEnumValue("IDENTIFICATION") IDENTIFICATION(String.valueOf("IDENTIFICATION")), @XmlEnumValue("VERIFICATION_ONLY") VERIFICATION_ONLY(String.valueOf("VERIFICATION_ONLY")), @XmlEnumValue("REQUEST_PATH") REQUEST_PATH(String.valueOf("REQUEST_PATH"));


private String value;

AuthenticationTypeEnum(String v) {
value = v;
}

public String value() {
return value;
}

@Override
public String toString() {
return String.valueOf(value);
}

public static AuthenticationTypeEnum fromValue(String value) {
for (AuthenticationTypeEnum b : AuthenticationTypeEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}

private AuthenticationTypeEnum authenticationType;

@XmlType(name="TypeEnum")
@XmlEnum(String.class)
public enum TypeEnum {
Expand Down Expand Up @@ -148,6 +216,42 @@ public void setIsEnabled(Boolean isEnabled) {
this.isEnabled = isEnabled;
}

/**
**/
public Authenticator definedBy(DefinedByEnum definedBy) {

this.definedBy = definedBy;
return this;
}

@ApiModelProperty(value = "")
@JsonProperty("definedBy")
@Valid
public DefinedByEnum getDefinedBy() {
return definedBy;
}
public void setDefinedBy(DefinedByEnum definedBy) {
this.definedBy = definedBy;
}

/**
**/
public Authenticator authenticationType(AuthenticationTypeEnum authenticationType) {

this.authenticationType = authenticationType;
return this;
}

@ApiModelProperty(value = "")
@JsonProperty("authenticationType")
@Valid
public AuthenticationTypeEnum getAuthenticationType() {
return authenticationType;
}
public void setAuthenticationType(AuthenticationTypeEnum authenticationType) {
this.authenticationType = authenticationType;
}

/**
**/
public Authenticator type(TypeEnum type) {
Expand Down Expand Up @@ -262,6 +366,8 @@ public boolean equals(java.lang.Object o) {
Objects.equals(this.name, authenticator.name) &&
Objects.equals(this.displayName, authenticator.displayName) &&
Objects.equals(this.isEnabled, authenticator.isEnabled) &&
Objects.equals(this.definedBy, authenticator.definedBy) &&
Objects.equals(this.authenticationType, authenticator.authenticationType) &&
Objects.equals(this.type, authenticator.type) &&
Objects.equals(this.image, authenticator.image) &&
Objects.equals(this.description, authenticator.description) &&
Expand All @@ -271,7 +377,7 @@ public boolean equals(java.lang.Object o) {

@Override
public int hashCode() {
return Objects.hash(id, name, displayName, isEnabled, type, image, description, tags, self);
return Objects.hash(id, name, displayName, isEnabled, definedBy, authenticationType, type, image, description, tags, self);
}

@Override
Expand All @@ -284,6 +390,8 @@ public String toString() {
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" displayName: ").append(toIndentedString(displayName)).append("\n");
sb.append(" isEnabled: ").append(toIndentedString(isEnabled)).append("\n");
sb.append(" definedBy: ").append(toIndentedString(definedBy)).append("\n");
sb.append(" authenticationType: ").append(toIndentedString(authenticationType)).append("\n");
sb.append(" type: ").append(toIndentedString(type)).append("\n");
sb.append(" image: ").append(toIndentedString(image)).append("\n");
sb.append(" description: ").append(toIndentedString(description)).append("\n");
Expand Down
12 changes: 12 additions & 0 deletions ...rbon/identity/api/server/authenticators/v1/core/ServerAuthenticatorManagementService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
import org.wso2.carbon.identity.application.common.model.IdentityProvider;
import org.wso2.carbon.identity.application.common.model.LocalAuthenticatorConfig;
import org.wso2.carbon.identity.application.common.model.RequestPathAuthenticatorConfig;
import org.wso2.carbon.identity.base.AuthenticatorPropertiesConstant.DefinedByType;
import org.wso2.carbon.identity.base.IdentityException;
import org.wso2.carbon.identity.core.model.ExpressionNode;
import org.wso2.carbon.identity.core.model.FilterTreeBuilder;
Expand Down Expand Up @@ -417,10 +418,18 @@ private void addIdp(IdentityProvider identityProvider, List<Authenticator> authe
} else {
authenticator.setDisplayName(identityProvider.getIdentityProviderName());
}
authenticator.setAuthenticationType(Authenticator.AuthenticationTypeEnum.IDENTIFICATION);
authenticator.setIsEnabled(identityProvider.isEnable());
authenticator.setType(Authenticator.TypeEnum.FEDERATED);
authenticator.setImage(identityProvider.getImageUrl());
authenticator.setDescription(identityProvider.getIdentityProviderDescription());
if (identityProvider.getFederatedAuthenticatorConfigs().length == 1) {
DefinedByType definedByType =
identityProvider.getFederatedAuthenticatorConfigs()[0].getDefinedByType();
authenticator.definedBy(Authenticator.DefinedByEnum.valueOf(definedByType.toString()));
} else {
authenticator.definedBy(Authenticator.DefinedByEnum.SYSTEM);
}
if (CollectionUtils.isNotEmpty(configTagsListDistinct)) {
authenticator.setTags(configTagsListDistinct);
}
Expand Down Expand Up @@ -512,6 +521,9 @@ private Authenticator addLocalAuthenticator(LocalAuthenticatorConfig config) {
authenticator.setDisplayName(config.getDisplayName());
authenticator.setIsEnabled(config.isEnabled());
authenticator.setType(Authenticator.TypeEnum.LOCAL);
authenticator.definedBy(Authenticator.DefinedByEnum.valueOf(config.getDefinedByType().toString()));
authenticator.setAuthenticationType(
Authenticator.AuthenticationTypeEnum.valueOf(config.getAuthenticationType().toString()));
String[] tags = config.getTags();
if (ArrayUtils.isNotEmpty(tags)) {
authenticator.setTags(Arrays.asList(tags));
Expand Down
11 changes: 11 additions & 0 deletions ....wso2.carbon.identity.api.server.authenticators.v1/src/main/resources/authenticators.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,17 @@ components:
isEnabled:
type: boolean
example: true
definedBy:
type: string
enum:
- SYSTEM
- USER
authenticationType:
type: string
enum:
- IDENTIFICATION
- VERIFICATION_ONLY
- REQUEST_PATH
type:
type: string
enum:
Expand Down
110 changes: 109 additions & 1 deletion ...s.v1/src/gen/java/org/wso2/carbon/identity/api/server/configs/v1/model/Authenticator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,74 @@ public class Authenticator {
private String displayName;
private Boolean isEnabled = true;

@XmlType(name="DefinedByEnum")
@XmlEnum(String.class)
public enum DefinedByEnum {

@XmlEnumValue("SYSTEM") SYSTEM(String.valueOf("SYSTEM")), @XmlEnumValue("USER") USER(String.valueOf("USER"));


private String value;

DefinedByEnum(String v) {
value = v;
}

public String value() {
return value;
}

@Override
public String toString() {
return String.valueOf(value);
}

public static DefinedByEnum fromValue(String value) {
for (DefinedByEnum b : DefinedByEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}

private DefinedByEnum definedBy;

@XmlType(name="AuthenticationTypeEnum")
@XmlEnum(String.class)
public enum AuthenticationTypeEnum {

@XmlEnumValue("IDENTIFICATION") IDENTIFICATION(String.valueOf("IDENTIFICATION")), @XmlEnumValue("VERIFICATION_ONLY") VERIFICATION_ONLY(String.valueOf("VERIFICATION_ONLY")), @XmlEnumValue("REQUEST_PATH") REQUEST_PATH(String.valueOf("REQUEST_PATH"));


private String value;

AuthenticationTypeEnum(String v) {
value = v;
}

public String value() {
return value;
}

@Override
public String toString() {
return String.valueOf(value);
}

public static AuthenticationTypeEnum fromValue(String value) {
for (AuthenticationTypeEnum b : AuthenticationTypeEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
}

private AuthenticationTypeEnum authenticationType;

@XmlType(name="TypeEnum")
@XmlEnum(String.class)
public enum TypeEnum {
Expand Down Expand Up @@ -152,6 +220,42 @@ public void setIsEnabled(Boolean isEnabled) {
this.isEnabled = isEnabled;
}

/**
**/
public Authenticator definedBy(DefinedByEnum definedBy) {

this.definedBy = definedBy;
return this;
}

@ApiModelProperty(value = "")
@JsonProperty("definedBy")
@Valid
public DefinedByEnum getDefinedBy() {
return definedBy;
}
public void setDefinedBy(DefinedByEnum definedBy) {
this.definedBy = definedBy;
}

/**
**/
public Authenticator authenticationType(AuthenticationTypeEnum authenticationType) {

this.authenticationType = authenticationType;
return this;
}

@ApiModelProperty(value = "")
@JsonProperty("authenticationType")
@Valid
public AuthenticationTypeEnum getAuthenticationType() {
return authenticationType;
}
public void setAuthenticationType(AuthenticationTypeEnum authenticationType) {
this.authenticationType = authenticationType;
}

/**
**/
public Authenticator type(TypeEnum type) {
Expand Down Expand Up @@ -238,14 +342,16 @@ public boolean equals(java.lang.Object o) {
Objects.equals(this.name, authenticator.name) &&
Objects.equals(this.displayName, authenticator.displayName) &&
Objects.equals(this.isEnabled, authenticator.isEnabled) &&
Objects.equals(this.definedBy, authenticator.definedBy) &&
Objects.equals(this.authenticationType, authenticator.authenticationType) &&
Objects.equals(this.type, authenticator.type) &&
Objects.equals(this.tags, authenticator.tags) &&
Objects.equals(this.properties, authenticator.properties);
}

@Override
public int hashCode() {
return Objects.hash(id, name, displayName, isEnabled, type, tags, properties);
return Objects.hash(id, name, displayName, isEnabled, definedBy, authenticationType, type, tags, properties);
}

@Override
Expand All @@ -258,6 +364,8 @@ public String toString() {
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" displayName: ").append(toIndentedString(displayName)).append("\n");
sb.append(" isEnabled: ").append(toIndentedString(isEnabled)).append("\n");
sb.append(" definedBy: ").append(toIndentedString(definedBy)).append("\n");
sb.append(" authenticationType: ").append(toIndentedString(authenticationType)).append("\n");
sb.append(" type: ").append(toIndentedString(type)).append("\n");
sb.append(" tags: ").append(toIndentedString(tags)).append("\n");
sb.append(" properties: ").append(toIndentedString(properties)).append("\n");
Expand Down
Loading
Loading