API 文档

API 文档

Api 列表

资产列表

http://192.168.244.144/api/v1/assets/assets/

资产详情

http://192.168.244.144/api/v1/assets/assets/2c56fd37-db65-40ed-b787-b65a98635f12/

Api 访问地址

Version	Access method	example
< 2.0.0	`http://<url>/docs`	`http://192.168.244.144/docs`
>=2.0.0	`http://<url>/api/docs/`	`http://192.168.244.144/api/docs/`
>=2.6.0	`http://<url>/api/docs/`	`http://192.168.244.144/api/docs/`

版本小于 v2.6 需要打开 debug 模式

vi config.yml

...
# 如果版本更低的话，配置文件是 config.py
# Debug = true
DEBUG: true

API认证

JumpServer Api 支持的认证有以下几种方式

Session         登录后可以直接使用 session_id 作为认证方式  
Token           获取一次性 Token，该 Token 有有效期, 过期作废  
Private Token   永久 Token  
Access Key      对 Http Header 进行签名

Session

用户通过页面后登录，cookie 中会存在 sessionid, 请求时同样把 sessionid 放到 cookie 中

Token

使用账号密码调用 Api 获取 token，如果启用了 MFA，则需要两步验证

curl -X POST http://localhost/api/v1/authentication/auth/ \
     -H 'Content-Type: application/json' \
     -d '{"username": "admin", "password": "admin"}'

代码:

import requests
import json
def get_token():
    url = 'https://demo.jumpserver.org/api/v1/authentication/auth/'
    query_args = {
        "username": "admin",
        "password": "admin"
    }
    response = requests.post(url, data=query_args)
    return json.loads(response.text)['token']
def get_user_info():
    url = 'https://demo.jumpserver.org/api/v1/users/users/'
    token = get_token()
    header_info = { "Authorization": 'Bearer ' + token }
    response = requests.get(url, headers=header_info)
    print(json.loads(response.text))
get_user_info()

Private Token

docker exec -it jms_core /bin/bash
cd /opt/jumpserver/apps
python manage.py shell
from users.models import User
u = User.objects.get(username='admin')
u.create_private_token()

已经存在 private_token, 可以直接获取即可

u.private_token

以 PrivateToken: 937b38011acf499eb474e2fecb424ab3 为例:

curl -H 'Authorization: Token 937b38011acf499eb474e2fecb424ab3' \
     -H "Content-Type:application/json" http://demo.jumpserver.org/api/v1/users/users/

Access Key

Access key 签名机制是为了安全， IETF 发布的法案详见此处认证的原理是:

用户有一个 access key, key有ID(keyId)和密钥(keySecret), 这个key是预生成的，请求者和服务器都知晓
用户请求时 将请求的 地址、请求方法、时间等使用 密钥(某种对称算法)进行加密，作为签名 连同 keyId 一同放到 header 中发给服务器
Authorization: Signature keyId="Test",algorithm="rsa-sha256",
signature="jKyvPcxB4JbmYY4mByyBY7cZfNl4OW9HpFQlG7N4YcJPteKTu4MW
CLyk+gIr0wDgqtLWf9NLpMAMimdfsH7FSWGfbMFSrsVTHNTk0rK3usrfFnti1dx
sM4jl0kYJCKTGI/UWkqiaxwNiKqGcdlEDrTcUhhsFsOIo8VhddmZTZ8w="
服务器收到请求后，根据 keyId从数据库中取到keySecret, 解密签名，比对 签名内容和请求的字段是否一致，如果一致，认证成功，否则失败

python 使用 requests 请求示例

安装依赖

pip install requests drf-httpsig
python

代码

import requests
from httpsig.requests_auth import HTTPSignatureAuth
KEY_ID = 'su-key'
SECRET = 'my secret string'
signature_headers = ['(request-target)', 'accept', 'date']
headers = {
  'Accept': 'application/json',
  'Date': "Mon, 17 Feb 2020 06:11:05 GMT"
}
auth = HTTPSignatureAuth(key_id=KEY_ID, secret=SECRET,
                       algorithm='hmac-sha256',
                       headers=signature_headers)
req = requests.get('http://localhost/api/v1/users/users/',
                 auth=auth, headers=headers)
print(req.content)

API文档

API 文档

Api 列表

Api 访问地址

API认证