Spring/spring-security
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Start with LDAP Jackson2 mixins

Browse Source 
Issue gh-9263
This commit is contained in:
Markus Heiden
2020-12-04 21:27:52 +01:00
committed by Eleftheria Stein
parent 74e3abc992
commit 7cfd415cb5
11 changed files with 472 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
ldap/src/main/java/org/springframework/security/ldap/jackson2/InetOrgPersonMixin.java Normal file
View File

@@ -0,0 +1,46 @@
/*
* Copyright 2015-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.security.ldap.jackson2;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import org.springframework.security.jackson2.SecurityJackson2Modules;
/**
* This is a Jackson mixin class helps in serialize/deserialize
* {@link org.springframework.security.ldap.userdetails.InetOrgPerson} class. To use this
* class you need to register it with {@link com.fasterxml.jackson.databind.ObjectMapper}.
*
* <pre>
* ObjectMapper mapper = new ObjectMapper();
* mapper.registerModule(new LdapJackson2Module());
* </pre>
*
* <i>Note: This class will save full class name into a property called @class</i>
*
* @see LdapJackson2Module
* @see SecurityJackson2Modules
*/
@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY)
@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE,
isGetterVisibility = JsonAutoDetect.Visibility.NONE)
@JsonIgnoreProperties(ignoreUnknown = true)
abstract class InetOrgPersonMixin {
}

62
ldap/src/main/java/org/springframework/security/ldap/jackson2/LdapAuthorityMixin.java Normal file
View File

@@ -0,0 +1,62 @@
/*
* Copyright 2015-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.security.ldap.jackson2;
import java.util.List;
import java.util.Map;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import org.springframework.security.jackson2.SecurityJackson2Modules;
/**
* This is a Jackson mixin class helps in serialize/deserialize
* {@link org.springframework.security.ldap.userdetails.LdapAuthority} class. To use this
* class you need to register it with {@link com.fasterxml.jackson.databind.ObjectMapper}.
*
* <pre>
* ObjectMapper mapper = new ObjectMapper();
* mapper.registerModule(new LdapJackson2Module());
* </pre>
*
* <i>Note: This class will save full class name into a property called @class</i>
*
* @see LdapJackson2Module
* @see SecurityJackson2Modules
*/
@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY)
@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE)
@JsonIgnoreProperties(ignoreUnknown = true)
abstract class LdapAuthorityMixin {
/**
* Constructor used by Jackson to create object of
* {@link org.springframework.security.ldap.userdetails.LdapAuthority}.
* @param role
* @param dn
* @param attributes
*/
@JsonCreator
LdapAuthorityMixin(@JsonProperty("role") String role, @JsonProperty("dn") String dn,
@JsonProperty("attributes") Map<String, List<String>> attributes) {
}
}

60
ldap/src/main/java/org/springframework/security/ldap/jackson2/LdapJackson2Module.java Normal file
View File

@@ -0,0 +1,60 @@
/*
* Copyright 2015-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.security.ldap.jackson2;
import com.fasterxml.jackson.core.Version;
import com.fasterxml.jackson.databind.module.SimpleModule;
import org.springframework.security.jackson2.SecurityJackson2Modules;
import org.springframework.security.ldap.userdetails.InetOrgPerson;
import org.springframework.security.ldap.userdetails.LdapAuthority;
import org.springframework.security.ldap.userdetails.LdapUserDetailsImpl;
import org.springframework.security.ldap.userdetails.Person;
/**
* Jackson module for spring-security-ldap. This module registers
* {@link LdapAuthorityMixin}, {@link LdapUserDetailsImplMixin}, {@link PersonMixin},
* {@link InetOrgPersonMixin}. If no default typing enabled by default then it'll enable
* it because typing info is needed to properly serialize/deserialize objects. In order to
* use this module just add this module into your ObjectMapper configuration.
*
* <pre>
* ObjectMapper mapper = new ObjectMapper();
* mapper.registerModule(new LdapJackson2Module());
* </pre>
*
* <b>Note: use {@link SecurityJackson2Modules#getModules(ClassLoader)} to get list of all
* security modules.</b>
*
* @see SecurityJackson2Modules
*/
public class LdapJackson2Module extends SimpleModule {
public LdapJackson2Module() {
super(LdapJackson2Module.class.getName(), new Version(1, 0, 0, null, null, null));
}
@Override
public void setupModule(SetupContext context) {
SecurityJackson2Modules.enableDefaultTyping(context.getOwner());
context.setMixInAnnotations(LdapAuthority.class, LdapAuthorityMixin.class);
context.setMixInAnnotations(LdapUserDetailsImpl.class, LdapUserDetailsImplMixin.class);
context.setMixInAnnotations(Person.class, PersonMixin.class);
context.setMixInAnnotations(InetOrgPerson.class, InetOrgPersonMixin.class);
}
}

47
ldap/src/main/java/org/springframework/security/ldap/jackson2/LdapUserDetailsImplMixin.java Normal file
View File

@@ -0,0 +1,47 @@
/*
* Copyright 2015-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.security.ldap.jackson2;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import org.springframework.security.jackson2.SecurityJackson2Modules;
/**
* This is a Jackson mixin class helps in serialize/deserialize
* {@link org.springframework.security.ldap.userdetails.LdapUserDetailsImpl} class. To use
* this class you need to register it with
* {@link com.fasterxml.jackson.databind.ObjectMapper}.
*
* <pre>
* ObjectMapper mapper = new ObjectMapper();
* mapper.registerModule(new LdapJackson2Module());
* </pre>
*
* <i>Note: This class will save full class name into a property called @class</i>
*
* @see LdapJackson2Module
* @see SecurityJackson2Modules
*/
@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY)
@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE,
isGetterVisibility = JsonAutoDetect.Visibility.NONE)
@JsonIgnoreProperties(ignoreUnknown = true)
abstract class LdapUserDetailsImplMixin {
}

46
ldap/src/main/java/org/springframework/security/ldap/jackson2/PersonMixin.java Normal file
View File

@@ -0,0 +1,46 @@
/*
* Copyright 2015-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.security.ldap.jackson2;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import org.springframework.security.jackson2.SecurityJackson2Modules;
/**
* This is a Jackson mixin class helps in serialize/deserialize
* {@link org.springframework.security.ldap.userdetails.Person} class. To use this class
* you need to register it with {@link com.fasterxml.jackson.databind.ObjectMapper}.
*
* <pre>
* ObjectMapper mapper = new ObjectMapper();
* mapper.registerModule(new LdapJackson2Module());
* </pre>
*
* <i>Note: This class will save full class name into a property called @class</i>
*
* @see LdapJackson2Module
* @see SecurityJackson2Modules
*/
@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY)
@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE,
isGetterVisibility = JsonAutoDetect.Visibility.NONE)
@JsonIgnoreProperties(ignoreUnknown = true)
abstract class PersonMixin {
}