webapi服務端對接app


目前移動端流行  ,本文章主要介紹本人(新手) 開發 與app對接服務端 進行分享 。不足之處請指正

與app對接  一般的站點接口 需映射外網(即外部網絡可以直接訪問該接口項目),那么  這就要考慮到項目的數據保密性和一些驗證。

目前 我做的接口中所用到了 如下技術:

1:數據的加密/解密:  數據在傳輸過程中  需要進行加解密操作  才能有效的保護數據的安全性 (我的項目中采用.net framwork 自帶的aes 加解密)

     數據加密  可采用自定的加密方式(如 AES  DES )等  這里就不貼代碼了。

2:簽名驗證:即 app端將數據進行 不可逆加密  然后  放在http請求的header中  ,服務端  獲取到  數據  采用相同的不可逆加密方式進行獲得 密文 ,將app的密文和服務端解析的密文進行匹配 (可在一定程度上保護數據不被篡改)

 

3:時間戳驗證:app端 在http請求中 加入時間戳 數據 ,服務端獲取時間戳 ,去驗證 app的時間戳  與服務器端  設定的時間戳  ,防止重放攻擊

 

4:登錄時效驗證:在每次登錄時 產生一個唯一的token驗證碼 存儲在數據庫中  ,並將該 token返回至APP  ,app每次請求數據  去驗證 token是否 已過時,如果過時 重新登錄

 

在 項目開發過程中   對於以上的驗證  建議統一處理

1:在請求數據進入時 統一進行  參數的解密和驗證 

  方法:統一解密  webapi 項目 可以繼承類  MessageProcessingHandler  並重寫 ProcessRequest 和  ProcessResponse 方法

  在該ProcessRequest 方法中進行數據的解密 

  在該ProcessResponse 方法中進行數據的加密

2.數據驗證 繼承 類 DelegatingHandler ,並重寫 SendAsync 方法  進行  數據的相關驗證, 一般 如果驗證 通過    結果直接 return base.SendAsync(request, token);  即 最終的效果為 將消息分發到 對應的接口中 進行處理

 如果驗證不通過   可 直接采用如下方式直接  返回信息

/// <summary>
/// 返回客戶端錯誤信息
/// </summary>
/// <param name="request">http請求</param>
/// <param name="needEncrypt">是否加密響應信息</param>
/// <param name="errorMessage">錯誤信息</param>
/// <returns>
/// 異步方式返回的錯誤消息
/// </returns>
private Task<HttpResponseMessage> GenerateErrorResponse(HttpRequestMessage request,
bool needEncrypt,
string errorMessage = "請求參數錯誤")
{
// 記錄錯誤的請求日志
LogErrorRequest(request);

// 生成錯誤響應消息
var response = new HttpResponseMessage();
var error = JsonConvert.SerializeObject(new ApiResult() { Message = errorMessage });
response.Content = new StringContent(error, Encoding.GetEncoding("UTF-8"), "application/json");
response.StatusCode = System.Net.HttpStatusCode.OK;
if(needEncrypt)
response.Content.Headers.Add("toencrypt", "");

return Task<HttpResponseMessage>.Factory.StartNew(() => response);
}

 

 

下面就到  代碼 showTime:    以下  兩個類創建之后 在 global 中注冊即可

/// <summary>
    /// 處理請求參數和響應消息的加解密
    /// </summary>
    public class MessageHandler : MessageProcessingHandler
    {
        #region Private Fields & Const

        private readonly TelemetryClient _client;

        #endregion

        #region Constructor

        /// <summary>
        /// Constructor
        /// </summary>
        public MessageHandler()
        {
            _client = new TelemetryClient();
        }

        #endregion


        #region Override Methods

        /// <summary>
        /// 處理request
        /// 1、消息解密
        /// </summary>
        /// <param name="request">Http 請求</param>
        /// <param name="cancellationToken">cancellation token</param>
        /// <returns>處理后的http request</returns>
        protected override HttpRequestMessage ProcessRequest(HttpRequestMessage request, 
                                                             CancellationToken cancellationToken)
        {
            // 過濾swagger請求
            if (request.RequestUri.Segments.Contains("swagger"))
                return request;

            try
            {
                var method = request.Method.Method.ToLowerInvariant();
                if ("get" == method || "delete" == method)
                {
                    if (request.RequestUri.Query.Length <= 0)
                        return request;

                    var encryptedStr = request.RequestUri.Query?.Substring(1, request.RequestUri.Query.Length - 1);
                    if (!string.IsNullOrEmpty(encryptedStr))
                    {
                        var parameters = HandlerUtility.AES128Decrypt(encryptedStr);
                        var url = $"{request.RequestUri.AbsoluteUri.Split('?')[0]}?{ parameters }";
                        request.RequestUri = new Uri($"{request.RequestUri.AbsoluteUri.Split('?')[0]}?{ parameters }");
                    }
                }
                else
                {
 /// <summary>
    /// Message handler to validate and decrypt request parameter
    /// </summary>
    public class AuthenticationHandler : DelegatingHandler
    {
        #region Private Fields

        private readonly TelemetryClient _client;

        #endregion

        #region Constructor

        /// <summary>
        /// Constructor
        /// </summary>
        public AuthenticationHandler()
        {
            _client = new TelemetryClient();
        }

        #endregion

        #region Override Methods

        /// <summary>
        /// 驗證請求參數
        /// </summary>
        /// <param name="request">http請求</param>
        /// <param name="token">cancellation token</param>
        /// <returns>
        /// HttpResponseMessage
        /// </returns>
        protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request,
                                                               CancellationToken token)
        {


            try
            {
                // 檢查時間戳
                 if (!CheckTimestamp(request.Headers))
                     return GenerateErrorResponse(request, true);

                // 檢查簽名
                 var parameters = GetParameters(request);
                 if (!CheckSignature(request.Headers, parameters))
                     return GenerateErrorResponse(request, true);
            }
            catch (Exception ex)
            {
               
                return GenerateErrorResponse(request, true, "請求失敗!");
            }

            return base.SendAsync(request, token);
        }

        #endregion

        #region Private Methods


        /// <summary>
        /// 獲取請求參數
        /// </summary>
        /// <param name="request">http 請求</param>
        /// <returns>請求參數</returns>
        private static string GetParameters(HttpRequestMessage request)
        {
            if (request == null)
                return string.Empty;

            string parameters = null;
            if ("get".Equals(request.Method.Method, StringComparison.InvariantCultureIgnoreCase) ||
                "delete".Equals(request.Method.Method, StringComparison.InvariantCultureIgnoreCase))
            {
                if (!string.IsNullOrEmpty(request.RequestUri.OriginalString) &&
                   request.RequestUri.OriginalString.Length > 1)
                {
                    var urlArray = request.RequestUri.OriginalString.Split('?');
                    if (urlArray != null && urlArray.Length > 1)
                        parameters = urlArray[1];
                }
            }
            else
            {
                // post/put/delete
                parameters = request.Content.ReadAsStringAsync().Result;
            }

            return parameters;
        }

        /// <summary>
        /// 返回客戶端錯誤信息
        /// </summary>
        /// <param name="request">http請求</param>
        /// <param name="needEncrypt">是否加密響應信息</param>
        /// <param name="errorMessage">錯誤信息</param>
        /// <returns>
        /// 異步方式返回的錯誤消息
        /// </returns>
        private Task<HttpResponseMessage> GenerateErrorResponse(HttpRequestMessage request,
                                                                bool needEncrypt,
                                                                string errorMessage = "請求參數錯誤")
        {
            // 記錄錯誤的請求日志
            LogErrorRequest(request);

            // 生成錯誤響應消息
            var response = new HttpResponseMessage();
            var error = JsonConvert.SerializeObject(new ApiResult() { Message = errorMessage });
            response.Content = new StringContent(error, Encoding.GetEncoding("UTF-8"), "application/json");
            response.StatusCode = System.Net.HttpStatusCode.OK;
            if(needEncrypt)
                response.Content.Headers.Add("toencrypt", "");

            return Task<HttpResponseMessage>.Factory.StartNew(() => response);
        }

        /// <summary>
        /// 驗證錯誤的請求記錄日志
        /// </summary>
        /// <param name="request">http請求</param>
        private void LogErrorRequest(HttpRequestMessage request)
        {
            if (request == null)
                return;

            // 記錄請求參數
            var method = request.Method.Method.ToLowerInvariant();
            if ("get" == method || "delete" == method)
            {
                //記錄下相關日志   以備查看
            }
            else
            {
                request.Content.ReadAsStreamAsync().Result.Seek(0, SeekOrigin.Begin);
                var body = request.Content.ReadAsStringAsync().Result;

            }


        }

        /// <summary>
        /// 驗證時間戳
        /// </summary>
        /// <param name="headers">請求頭信息</param>
        /// <returns>
        /// true表示驗證成功
        /// false表示驗證失敗
        /// </returns>
        private static bool CheckTimestamp(HttpRequestHeaders headers)
        {
            if (headers == null)
                return false;

            long timestamp = 0;
            if (headers.Contains("timestamp"))
                long.TryParse(headers.GetValues("timestamp").FirstOrDefault(), out timestamp);

            // 請求URL的有效期為15分鍾,防止重放攻擊
            return GetTotalMillisecondsSince1970() - timestamp < 15 * 60 * 1000;
        }

        /// <summary>
        /// 驗證簽名
        /// </summary>
        /// <param name="headers">請求頭信息</param>
        /// <param name="parameters">
        /// 解密后的請求參數
        /// 對於get/delete請求,parameter為querystring
        /// 對於post/put/patch, paramters為json字符串
        /// </param>
        /// <returns>
        /// true 表示驗證成功
        /// false表示驗證失敗
        /// </returns>
        private static bool CheckSignature(HttpRequestHeaders headers, string parameters)
        {
            if (headers == null ||
               !headers.Contains("sign") ||
               !headers.Contains("timestamp") ||
               !headers.Contains("random"))
                return false;

            // 客戶端傳過來的簽名
            var sign = headers.GetValues("sign")?.FirstOrDefault();

            // 服務器重新計算簽名
            string computedSign = null;
            var timestamp = headers.GetValues("timestamp")?.FirstOrDefault();
            var random = headers.GetValues("random")?.FirstOrDefault();
            computedSign = HandlerUtility.SHA256Encode(parameters + timestamp + random);

            // 簽名不一致,參數被篡改
            var base64Sign = sign.Replace("$", "+").Replace("*", "=");
            return string.Equals(base64Sign, computedSign, StringComparison.InvariantCulture);
        }


        #endregion
    }

  

// post/put/patch var encryptedStr = request.Content.ReadAsStringAsync().Result; if (!string.IsNullOrEmpty(encryptedStr)) { var parameters = HandlerUtility.AES128Decrypt(encryptedStr);//加解密自定義方法 request.Content = new StringContent(parameters); request.Content.Headers.ContentLength = parameters.Length; request.Content.Headers.ContentType = new MediaTypeHeaderValue("application/json"); } } } catch (Exception ex) { _client.TrackException(ex); } return request; } /// <summary> /// 處理response /// 1、消息加密 /// </summary> /// <param name="response">明文響應消息</param> /// <param name="cancellationToken">cancelation token</param> /// <returns>密文響應消息</returns> protected override HttpResponseMessage ProcessResponse(HttpResponseMessage response, CancellationToken cancellationToken) { if (response.Content != null) { var contentType = response.Content.Headers.GetValues("content-type").FirstOrDefault(); if (response.Content.Headers.Contains("toencrypt")) { var plaintext = response.Content.ReadAsStringAsync().Result; response.Content = new StringContent(HandlerUtility.AES128Encrypt(plaintext)); response.Content.Headers.Remove("toencrypt"); } } return response; } #endregion }

  


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM