Merge pull request #12 from laincloud/audit

add audit

Author: bibaijin

.gitignore

@@ -3,3 +3,28 @@ entry.iml
 *.pyc
 test.py
 test_client.py
+vendor/
+prod.json
+
+# React
+# See https://help.github.com/ignore-files/ for more about ignoring files.
+
+# dependencies
+frontend/node_modules/
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

Godeps/Godeps.json

@@ -10,20 +10,30 @@
 ## Licensing
 Entry is released under [MIT](https://github.com/laincloud/entry/blob/master/LICENSE) license.
 
-## 打包上传到 PyPI
+## 部署
 
-### 依赖
+### 配置
+
+请参考 [example.json](example.json) 编写配置文件，并上传到 lvault：
 
 ```
-pip install twine  # 上传工具
-pip install wheel  # 打包工具
+lain secret add ${LAIN-Domain} web /lain/app/prod.json -f example.json
 ```
 
-### 打包上传
+> - `smtp.address` 需要包含端口，如：${mail-address}:25
+> - `smtp.password` 可选，为空时不使用 auth
+
+## 审计
+
+## 开发
+
+### 由 `swagger.yml` 生成代码
 
 ```
-rm -rf dist/  # 清空以前的构建
-python setup.py sdist  # 打包源代码
-python setup.py bdist_wheel  # 构建 wheel
-twine upload dist/*  # 上传
+go get -u github.com/go-swagger/go-swagger/cmd/swagger  # 安装 swagger
+swagger generate server -f ./swagger.yml -t server/gen  # 生成代码
 ```
+
+- `server/gen` 下除 `server/gen/restapi/configure_entry.go` 外均由 `go-swagger` 生成，请不要手动修改
+- `server/gen/restapi/configure_entry.go` 包含初始化逻辑以及后端 API 配置
+- `server/handler` 包含后端 API 的实际逻辑

Godeps/Readme

@@ -0,0 +1,18 @@
+# TODOs
+
+* TODO lain.yaml 里的前端编译
+* DONE 前端：sessions 的获取
+  CLOSED: [2018-03-05 Mon 20:58]
+* DONE 前端：commands 标签页
+  CLOSED: [2018-03-06 Tue 16:50]
+* DONE 前端：登录验证
+  CLOSED: [2018-03-08 Thu 19:14]
+* DONE 前端：commands content
+  CLOSED: [2018-03-09 Fri 20:16]
+* DONE 前端：sessions -> commands 跳转
+  CLOSED: [2018-03-22 Thu 17:48]
+* DONE 后端：会话记录
+  CLOSED: [2018-03-22 Thu 17:48]
+* DONE 前端：会话重放
+  CLOSED: [2018-03-22 Thu 17:48]
+* TODO 后端：监控报警

README.md

@@ -0,0 +1,16 @@
+digraph G {
+  rankdir=LR;
+
+  lainAdmin [label="Admin"];
+  bastion [label="Bastion"];
+  lainNode [label="LAIN Node"];
+  allContainers [label="All containers"];
+  appOwner [label="App Owner"]
+  ordinaryContainers [label="Containers other than entry"]
+
+  lainAdmin -> bastion;
+  bastion -> lainNode [label="audit"];
+  lainNode -> allContainers [label="docker exec"];
+
+  appOwner -> ordinaryContainers [label="Authentication, authorize, proxy and audit by entry"];
+}