接口规范 2. 登录认证

2.登录认证

客户端调用流媒体服务器接口，首先要做的是身份认证，认证通过后才可以调用流媒体服务器的接口。
服务器和客户端通过“挑战->应答”方式（challenge-response）进行身份认证交互，在这个过程中，客户端需要调用两次接口向服务器证明身份。认证过程中不需要传递密码，密码用于签名验证。
身份认证的过如下：
1）客户端使用“用户名”作为参数调用“login1”接口，向服务器发出身份认证请求
1.1）服务器确认用户是否是有效的用户：
1.2）若不是，则不做进一步处理，返回错误信息
1.3）若是，服务器产生一个“随机数（挑战字符串）”发送给客户端
2）客户端使用“用户密码”和“随机数（挑战字符串）”作为输入，按约定的算法生成一个hash值，用该hash值作为 调用“login2”接口的参数，请求login2接口。
2.1）服务器用收到的hash值与自己的计算结果比较，若二者相同，则通过认证；否则，认证失败
2.2）若认证通过，服务器返回“token”给客户端，否者返回错误信息。

2.1.login1接口

• 用途
  客户端向服务器申请进行身份认证，服务器返回“挑战字符串”给客户端。
• 请求
  userAuth/?request=login1&username=admin
  username 登录服务器的用户名。
• 响应

  {
  "code":0,
  "err_desc":"auha3gik9m48l1mh"
  }

  code 等于0，表示用户有效，此时 err_desc 的内容是返回的挑战字符串（challenge_code）。
  code 不等于0，其他值表示错误，此时 err_desc 的内容是错误描述。
  返回的挑战字符（challenge_code）串用于下一步认证。

2.2.login2接口

• 用途
  对login1接口返回“挑战字符串”进行hash运算，将运算结果提交给服务器，进行身份合法性认证。
• 请求
  userAuth/?request=login2&username=admin&hash=8c96202be3da1b23a96c4c838eb34d93
  username 登录服务器的用户名。
  hash是使用用户密码和挑战字符串作为输入计算出的md5摘要值(hash)，算法如下：
  hash=md5(md5(password)+challenge_code)
  算法描述：首先计算出密码的hash值，然后在生成的密码hash值尾部拼接上挑战字符串形成新的字符串，最后计算这个新字符串的hash值。
  hash算法采用md5算法，生成的摘要采用16进制编码，编码生成的字符采用小写字母。
  例如，字符串111111的hash值是 96e79218965eb72c92a549dd5a330112
• 响应

  {
  "code":0,
  "err_desc":"g2ow17rfyf4nxbkg"
  }

  code 0 表示登录成功，此时 err_desc 的内容是token值，用于后续接口的通信认证。
  code >0 其他值表示错误，此时 err_desc 的内容是错误描述。

2.3.logout接口

• 用途
  退出登录，服务器销毁用户登录信息，作废“token”。
  建议客户端在退出系统时总是调用该接口。
• 请求
  userAuth/?request=logout&token=vvkphp5ca79c538n
• 响应

  {
  "code":0,
  }