# virtual-ldap

**Repository Path**: fglterry/virtual-ldap

## Basic Information

- **Project Name**: virtual-ldap
- **Description**: 利用钉钉通讯录同步搭建LDAP服务，支持通讯录变更回调
- **Primary Language**: C#
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 21
- **Created**: 2022-04-28
- **Last Updated**: 2022-05-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 基于钉钉通讯录搭建LDAP服务

## 流程

<img src="screenshots/workflow.png" alt="workflow"  />

## 钉钉中应用效果

### 修改个人密码

![](screenshots/dingding_domainaccount1.png)
![](screenshots/dingding_domainaccount2.png)
### 员工账号管理
**注意：管理员仅可查看所在部门下属员工**
![](screenshots/dingding_domainaccount3.png)
![](screenshots/dingding_domainaccount4.png)



## 同步策略

- Web服务端

  启动后等待30秒，从钉钉开放平台获取部门、人员数据

  若部门/人员新增，本地数据库中不存在，则同步至数据库中，并同步部门人员关系

  - 默认同步后，若人员为该组织的管理人员或部门管理人员，则在服务端中是管理员身份，可查看当前部门及下属部门人员信息，为下属部门人员开通账号。
- 默认同步后的人员账号，根据姓名生成；如 `张三` ，生成的账号为 `zhangsan` ，**若非管理员身份，账号默认禁用** ，需要上级管理人员为该账号开通。
  - 开通后的账号，可在钉钉自建H5应用中修改密码，只有修改了密码，该账号方可在各平台使用。
  - 当钉钉通讯录中发生变更时，由钉钉开发者平台回调，向Web服务端推送相关事件消息，处理相关逻辑。

- LDAP

  - 每一分钟从服务端同步一次部门/人员数据
  - 若服务端无法正常访问，则使用最近一次同步数据
  - 默认只同步开通账号的人员，开通后，若需要在各平台正常使用，需要在钉钉自建H5应用中修改初始密码

## 钉钉回调事件配置

<img src="screenshots/dingding_event.png" alt="dingding_callback_event"  />

## 源码运行

``` bash
# 1、进入相关目录
cd docker-compose

# 2、修改configs目录下appsettings.json中钉钉相关配置

# 3、使用docker compose运行
docker compose up -d

```


## Jenkins
### 使用Docker运行jenkins

``` bash
# 使用docker运行jenkins，并设置插件源为清华大学
# Windows下运行，请将每后结尾的 \ 替换为 ^
docker run -itd  --name jenkins --privileged --restart always --privileged=true \
-e TZ=Asia/Shanghai \
-e JENKINS_UC_DOWNLOAD=https://mirrors.tuna.tsinghua.edu.cn/jenkins/updates/update-center.json \
-p 9999:8080 -p 50000:50000 \
-v /d/ldap-docker-config/jenkins:/var/jenkins_home \
jenkins/jenkins:lts-jdk11

```

打开浏览器进入jenkins界面 http://localhost:9999    
输入密码

``` bash
# 进入jenkins容器
docker exec -it jenkins bash

# 查看jenkins默认密码，使用默认密码登录jenkins
more /var/jenkins_home/secrets/initialAdminPassword


```
<img src="screenshots/view-jenkins-default-password.png" alt="ldap browse" width="878" />

### 安装LDAP插件

- 初次进入自由选择插件时选择

<img src="screenshots/jenkins-plugins-ldap.png" alt="ldap browse"   />
- 进入Jenkins后选择
<img src="screenshots/jenkins-plugins-ldap2.png" alt="ldap browse"   />


### Jenkins设置LDAP

- Server : IP:389
- root DN : dc=example,dc=com
- Group search base : ou=Staff, ou=Groups, o=demo
- Manager DN : cn=jenkins, dc=example, dc=com
- Display Name LDAP attribute : cn
- Email Address LDAP attribute : uid

<img src="screenshots/jenkins-ldap-settings.png" alt="ldap browse"   />

## 参考

ldap-server源码参考 [xiaoquqi](https://github.com/xiaoquqi)/**[virtual-ldap](https://github.com/xiaoquqi/virtual-ldap)**