Skip to content

About

The LDAP Server Base on Netty. 基于netty编写的ldap服务器

Topics

Resources

Stars

15 stars

Watchers

1 watching

Forks

Latest commit

 

History

29 Commits

Folders and files

Repository files navigation

ldap4Netty

The LDAP Server Base on Netty. 基于netty编写的ldap服务器

目标

使用Netty异步通信框架编写的LDAP服务器,根据RFC上关于LDAP协议的要求,提供了基本的LDAP访问方式,以及SSL支持。后续会加入LDAP搜索解析。

如何使用

LDAP Proxy

ldap-server 模块提供轻量 LDAP Proxy,可用于本地调试、迁移观测和访问日志审计。Proxy 默认采用 1:1 客户端到上游连接模型,bind/search 请求会转发到上游 LDAP,并把上游响应按原 messageId 返回给客户端。

import priv.sarom.ldap4Netty.ldap.proxy.LDAPProxyServer;
import priv.sarom.ldap4Netty.ldap.proxy.ProxyConfig;
import priv.sarom.ldap4Netty.ldap.proxy.interceptor.AccessLogInterceptor;

import java.util.concurrent.TimeUnit;

public class ProxyExample {
    public static void main(String[] args) throws Exception {
        ProxyConfig config = ProxyConfig.builder()
                .listenPort(6389)
                .upstreamHost("localhost")
                .upstreamPort(389)
                .connectTimeoutMillis(5000)
                .build()
                .validate();

        LDAPProxyServer proxyServer = new LDAPProxyServer(config)
                .addInterceptor(new AccessLogInterceptor());

        proxyServer.startAsync();
        proxyServer.awaitReady(5, TimeUnit.SECONDS);

        Runtime.getRuntime().addShutdownHook(new Thread(proxyServer::stop));
    }
}

也可以直接运行 ProxyApp:

java -cp ldap-server/target/ldap-server-1.0-SNAPSHOT.jar priv.sarom.ldap4Netty.ProxyApp 6389 localhost 389

Proxy interceptor 按 order() 从小到大处理请求,按相反顺序处理响应。interceptor 返回 null 表示丢弃当前消息并停止后续处理。内置 AccessLogInterceptor 记录连接、操作类型、messageId、结果和耗时;simple bind 密码不会写入访问日志。

Static Mock Directory

LDAPSearchHandler 可接入静态内存目录,用于本地开发和 CI 中模拟 LDAP 查询。当前支持 base object、one-level、subtree scope,以及 equality / presence filter。只读 mock 场景下,LDAPModifyHandler(sessionMap, true) 会对 modify 返回 UNWILLING_TO_PERFORM。

import priv.sarom.ldap4Netty.ldap.LDAPServer;
import priv.sarom.ldap4Netty.ldap.codec.LDAPDecoder;
import priv.sarom.ldap4Netty.ldap.codec.LDAPEncoder;
import priv.sarom.ldap4Netty.ldap.directory.InMemoryDirectory;
import priv.sarom.ldap4Netty.ldap.directory.StaticDirectoryEntry;
import priv.sarom.ldap4Netty.ldap.entity.LDAPSession;
import priv.sarom.ldap4Netty.ldap.handler.LDAPBindHandler;
import priv.sarom.ldap4Netty.ldap.handler.LDAPExceptionHandler;
import priv.sarom.ldap4Netty.ldap.handler.LDAPModifyHandler;
import priv.sarom.ldap4Netty.ldap.handler.LDAPSearchHandler;
import priv.sarom.ldap4Netty.ldap.handler.LDAPSessionRequiredHandler;

import java.util.Arrays;
import java.util.concurrent.ConcurrentHashMap;

public class MockDirectoryExample {
    public static void main(String[] args) throws Exception {
        ConcurrentHashMap<String, LDAPSession> sessionMap = new ConcurrentHashMap<>(100);
        InMemoryDirectory directory = new InMemoryDirectory(Arrays.asList(
                StaticDirectoryEntry.builder()
                        .dn("ou=people,dc=example,dc=com")
                        .attribute("objectClass", "organizationalUnit")
                        .attribute("ou", "people")
                        .build(),
                StaticDirectoryEntry.builder()
                        .dn("uid=alice,ou=people,dc=example,dc=com")
                        .attribute("objectClass", "inetOrgPerson")
                        .attribute("uid", "alice")
                        .attribute("cn", "Alice")
                        .attribute("mail", "alice@example.com")
                        .build()
        ));

        new LDAPServer(6389)
                .appendEncoder(LDAPEncoder.class)
                .appendDecoder(LDAPDecoder.class)
                .appendHandler(new LDAPBindHandler(sessionMap, null))
                .appendHandler(new LDAPSessionRequiredHandler(sessionMap, false))
                .appendHandler(new LDAPModifyHandler(sessionMap, true))
                .appendHandler(new LDAPSearchHandler(sessionMap, directory))
                .appendHandler(new LDAPExceptionHandler())
                .init(null, null)
                .start();
    }
}
  1. 启动LDAP服务端,位于ldap-server模块下,有现成的启动代码App.java

    package priv.sarom.ldap4Netty;
    
    import org.apache.logging.log4j.Level;
    import org.apache.logging.log4j.core.config.Configurator;
    import priv.sarom.ldap4Netty.ldap.LDAPServer;
    import priv.sarom.ldap4Netty.ldap.codec.LDAPDecoder;
    import priv.sarom.ldap4Netty.ldap.codec.LDAPEncoder;
    import priv.sarom.ldap4Netty.ldap.entity.LDAPSession;
    import priv.sarom.ldap4Netty.ldap.handler.LDAPAbandonHandler;
    import priv.sarom.ldap4Netty.ldap.handler.LDAPBindHandler;
    import priv.sarom.ldap4Netty.ldap.handler.LDAPExceptionHandler;
    import priv.sarom.ldap4Netty.ldap.handler.LDAPModifyHandler;
    import priv.sarom.ldap4Netty.ldap.handler.LDAPSessionRequiredHandler;
    
    import java.util.HashMap;
    
    public class App {
        public static void main(String[] args) throws Exception {
    
            Configurator.setRootLevel(Level.DEBUG);
    
            LDAPServer ldapServer = new LDAPServer(6666);
            HashMap<String, LDAPSession> sessionMap = new HashMap<>(100);
    
            ldapServer.appendEncoder(LDAPEncoder.class)
                    .appendDecoder(LDAPDecoder.class)
                    .appendHandler(new LDAPBindHandler(sessionMap, null))
                    .appendHandler(new LDAPSessionRequiredHandler(sessionMap, false))
                    .appendHandler(new LDAPAbandonHandler())
                    .appendHandler(new LDAPModifyHandler(sessionMap))
                    .appendHandler(new LDAPExceptionHandler())
    
                    //非ssl模式下sslContext和sslEngineMap非必需 , nullable
                    .init(null, null)
                    .start();
    
        }
    }
  2. 启动LDAP客户端,同样,位于ldap-client模块下,有启动代码App.java

    package priv.sarom.ldap4Netty;
    
    import org.apache.directory.api.ldap.model.entry.DefaultAttribute;
    import org.apache.directory.api.ldap.model.exception.LdapInvalidDnException;
    import org.apache.directory.api.ldap.model.message.BindRequest;
    import org.apache.directory.api.ldap.model.message.BindRequestImpl;
    import org.apache.directory.api.ldap.model.message.Message;
    import org.apache.directory.api.ldap.model.message.ModifyRequest;
    import org.apache.directory.api.ldap.model.message.ModifyRequestImpl;
    import org.apache.directory.api.ldap.model.name.Dn;
    import org.apache.directory.api.ldap.model.name.Rdn;
    import org.apache.logging.log4j.Level;
    import org.apache.logging.log4j.core.config.Configurator;
    import priv.sarom.ldap4Netty.ldap.LDAPClient;
    import priv.sarom.ldap4Netty.ldap.codec.LDAPDecoder;
    import priv.sarom.ldap4Netty.ldap.codec.LDAPEncoder;
    import priv.sarom.ldap4Netty.ldap.exception.LDAPException;
    import priv.sarom.ldap4Netty.ldap.handler.LDAPOperationHandler;
    import priv.sarom.ldap4Netty.ldap.handler.LDAPOperationHandler;
    
    import java.io.IOException;
    import java.security.KeyManagementException;
    import java.security.KeyStoreException;
    import java.security.NoSuchAlgorithmException;
    import java.security.UnrecoverableKeyException;
    import java.security.cert.CertificateException;
    import java.util.ArrayList;
    import java.util.List;
    
    public class App {
        public static void main(String[] args) throws InterruptedException, LdapInvalidDnException, CertificateException, UnrecoverableKeyException, NoSuchAlgorithmException, IOException, KeyManagementException, KeyStoreException, LDAPException {
    
            Configurator.setRootLevel(Level.DEBUG);
    
            // 待发送的消息列表
            List<Message> messages = new ArrayList<>();
    
            String name = "cn=accout";
            Dn rdns = new Dn(new Rdn(name));
    
            //build a BindRequest
            BindRequest bindRequest = new BindRequestImpl();
            bindRequest.setMessageId(1);
            bindRequest.setVersion3(true);
            bindRequest.setDn(rdns);
            bindRequest.setName(name);
            bindRequest.setCredentials("123456");
    
            messages.add(bindRequest);
    
            //bind a ModifyRequest
            ModifyRequest modifyRequest = new ModifyRequestImpl();
            modifyRequest.setMessageId(3);
            modifyRequest.setName(rdns);
    
            DefaultAttribute attribute = new DefaultAttribute("userCertificate;binary", "testdemo".getBytes());
            modifyRequest.add(attribute);
    
            messages.add(modifyRequest);
    
    
            LDAPClient client = new LDAPClient("localhost", 6666);
    
            client.appendEncoder(LDAPEncoder.class)
                    .appendDecoder(LDAPDecoder.class)
                    .appendHandler(new LDAPResponseHandler())
                    .appendHandler(new LDAPRequestHandler(messages))
                    .init(null, null)
                    .start();
        }
    }
  3. 开启SSL支持,即采用LDAPS协议,通过ldap-util模块下的SSLHelper和SSLInitializer实现

    1. SSLHelper根据KeyStore,为TCP链接创建Security Socket Layer,目前使用JKSJava Key Store软证书提供证书信任体系
    2. SSLInitializer 依赖SSLHelper提供的SSLContext的同时,也维护了自己的SSL session,即根据tcp链接缓存了对应的SSL状态,仅用于提供证书certificate的获取,便于作客户端的身份校验和鉴权
  4. 使用Java8自带的KeyTool工具,创建SSL所需的相关证书。
    一般来说,ssl通信双方的身份,应该由具有公信力的第三方(RA,Registry Authentication)负责审核确认,并颁发由第三方管理机构(CA,Registry Authentication)背书的数字证书
    为了简化流程,以下将以相互添加信任证书的方式,相互信任对方

    1. 创建JKS文件,生成自己用于签名的密钥对,命令如下:

      keytool -keystore 生成jks文件的路径 
      -storepass 密钥库密码 
      -keypass 密钥对密码 
      -genkey 
      -keyalg 非对称公钥算法默认rsa 
      -keysize 密钥对长度推荐2048
      -alias 密钥(也算证书,自签)或证书别名,便于操作
      

      然后根据提示输入相应的证书信息,最后按Y确认证书信息

      create_jks

    2. 导出公钥证书,命令如下:

      keytool -keystore jks文件的路径 
      -storepass 密钥库密码
      -export
      -file 导出的证书文件路径
      -alias 需要导出的证书别名
      
    3. 将客户端证书导入服务端的JKS文件中,服务端证书同理操作:

      keytool -keystore jks文件的路径 
      -storepass 密钥库密码
      -import
      -file 需要导入的证书文件路径
      -alias 需要导入的证书别名
      

      需要注意的一点是,证书的导入导出操作是根据别名alias的。即理应区分不同证书在同一密钥库Key Store中的别名alias的唯一性

About

The LDAP Server Base on Netty. 基于netty编写的ldap服务器

Topics

Resources

Stars

15 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages