wechat-mp-sdk 0.3.0

WeChat Mini Program SDK for Rust
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
//! WeChat Authentication API
//!
//! Provides login and authentication related APIs.

use std::fmt;
use std::sync::Arc;

use serde::{Deserialize, Serialize};

use crate::api::r#trait::{WechatApi, WechatContext};
use crate::error::WechatError;

/// Login response from code2Session API
#[non_exhaustive]
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct LoginResponse {
    /// User's unique ID under the Mini Program
    #[serde(default)]
    pub openid: String,
    /// Session key for decrypting user data
    #[serde(default)]
    pub session_key: String,
    /// User's unique ID across WeChat platform (optional)
    #[serde(default)]
    pub unionid: Option<String>,
    /// Error code (0 means success)
    #[serde(default)]
    pub(crate) errcode: i32,
    /// Error message
    #[serde(default)]
    pub(crate) errmsg: String,
}

impl LoginResponse {
    /// Create a new LoginResponse with the given fields.
    ///
    /// Sets errcode to 0 and errmsg to empty string (success).
    pub fn new(
        openid: impl Into<String>,
        session_key: impl Into<String>,
        unionid: Option<String>,
    ) -> Self {
        Self {
            openid: openid.into(),
            session_key: session_key.into(),
            unionid,
            errcode: 0,
            errmsg: String::new(),
        }
    }

    /// Check if the response indicates success
    pub fn is_success(&self) -> bool {
        self.errcode == 0
    }

    pub fn errcode(&self) -> i32 {
        self.errcode
    }

    pub fn errmsg(&self) -> &str {
        &self.errmsg
    }
}

#[derive(Clone, Serialize)]
struct StableAccessTokenRequest {
    grant_type: String,
    appid: String,
    secret: String,
    force_refresh: bool,
}

impl fmt::Debug for StableAccessTokenRequest {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("StableAccessTokenRequest")
            .field("grant_type", &self.grant_type)
            .field("appid", &self.appid)
            .field("secret", &"[REDACTED]")
            .field("force_refresh", &self.force_refresh)
            .finish()
    }
}

/// Response from getStableAccessToken
#[non_exhaustive]
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct StableAccessTokenResponse {
    /// The stable access token
    #[serde(default)]
    pub access_token: String,
    /// Token expiry in seconds
    #[serde(default)]
    pub expires_in: i64,
    /// Error code (0 means success)
    #[serde(default)]
    pub(crate) errcode: i32,
    /// Error message
    #[serde(default)]
    pub(crate) errmsg: String,
}

#[derive(Clone, Serialize)]
struct CheckSessionKeyRequest {
    openid: String,
    signature: String,
    sig_method: String,
}

impl fmt::Debug for CheckSessionKeyRequest {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("CheckSessionKeyRequest")
            .field("openid", &self.openid)
            .field("signature", &"[REDACTED]")
            .field("sig_method", &self.sig_method)
            .finish()
    }
}

#[derive(Clone, Serialize)]
struct ResetUserSessionKeyRequest {
    openid: String,
    signature: String,
    sig_method: String,
}

impl fmt::Debug for ResetUserSessionKeyRequest {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("ResetUserSessionKeyRequest")
            .field("openid", &self.openid)
            .field("signature", &"[REDACTED]")
            .field("sig_method", &self.sig_method)
            .finish()
    }
}

/// Response from resetUserSessionKey
#[non_exhaustive]
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct ResetSessionKeyResponse {
    #[serde(default)]
    pub openid: String,
    #[serde(default)]
    pub session_key: String,
    #[serde(default)]
    pub(crate) errcode: i32,
    #[serde(default)]
    pub(crate) errmsg: String,
}

#[derive(Debug, Clone, Deserialize)]
struct BaseApiResponse {
    #[serde(default)]
    errcode: i32,
    #[serde(default)]
    errmsg: String,
}

pub struct AuthApi {
    context: Arc<WechatContext>,
}

impl AuthApi {
    /// Create a new AuthApi instance
    pub fn new(context: Arc<WechatContext>) -> Self {
        Self { context }
    }

    /// Login with code from wx.login()
    ///
    /// Calls the code2Session API to exchange a login code for user info.
    ///
    /// # Arguments
    /// * `js_code` - The code obtained from wx.login() on the client
    ///
    /// # Returns
    /// LoginResponse containing openid, session_key, and optionally unionid
    pub async fn login(&self, js_code: &str) -> Result<LoginResponse, WechatError> {
        let path = "/sns/jscode2session";
        let query = [
            ("appid", self.context.client.appid()),
            ("secret", self.context.client.secret()),
            ("js_code", js_code),
            ("grant_type", "authorization_code"),
        ];

        let response: LoginResponse = self.context.client.get(path, &query).await?;

        WechatError::check_api(response.errcode, &response.errmsg)?;

        Ok(response)
    }

    /// Get a stable access token
    ///
    /// POST /cgi-bin/stable_token
    ///
    /// This endpoint does NOT use an existing access_token. It authenticates
    /// directly with appid + secret in the request body.
    ///
    /// # Arguments
    /// * `force_refresh` - Whether to force refresh the token
    pub async fn get_stable_access_token(
        &self,
        force_refresh: bool,
    ) -> Result<StableAccessTokenResponse, WechatError> {
        let path = "/cgi-bin/stable_token";
        let body = StableAccessTokenRequest {
            grant_type: "client_credential".to_string(),
            appid: self.context.client.appid().to_string(),
            secret: self.context.client.secret().to_string(),
            force_refresh,
        };
        let response: StableAccessTokenResponse = self.context.client.post(path, &body).await?;
        WechatError::check_api(response.errcode, &response.errmsg)?;
        Ok(response)
    }

    /// Check if a session key is still valid
    ///
    /// POST /wxa/checksession?access_token=ACCESS_TOKEN
    pub async fn check_session_key(
        &self,
        openid: &str,
        signature: &str,
        sig_method: &str,
    ) -> Result<(), WechatError> {
        let body = CheckSessionKeyRequest {
            openid: openid.to_string(),
            signature: signature.to_string(),
            sig_method: sig_method.to_string(),
        };
        let response: BaseApiResponse =
            self.context.authed_post("/wxa/checksession", &body).await?;
        WechatError::check_api(response.errcode, &response.errmsg)?;
        Ok(())
    }

    /// Reset user session key
    ///
    /// POST /wxa/resetusersessionkey?access_token=ACCESS_TOKEN
    pub async fn reset_user_session_key(
        &self,
        openid: &str,
        signature: &str,
        sig_method: &str,
    ) -> Result<ResetSessionKeyResponse, WechatError> {
        let body = ResetUserSessionKeyRequest {
            openid: openid.to_string(),
            signature: signature.to_string(),
            sig_method: sig_method.to_string(),
        };
        let response: ResetSessionKeyResponse = self
            .context
            .authed_post("/wxa/resetusersessionkey", &body)
            .await?;
        WechatError::check_api(response.errcode, &response.errmsg)?;
        Ok(response)
    }
}

impl WechatApi for AuthApi {
    fn context(&self) -> &WechatContext {
        &self.context
    }

    fn api_name(&self) -> &'static str {
        "auth"
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_login_response_success_parse() {
        let json = r#"{
            "openid": "oABC123xyz",
            "session_key": "test_session_key_abc",
            "errcode": 0,
            "errmsg": "ok"
        }"#;

        let response: LoginResponse = serde_json::from_str(json).unwrap();
        assert_eq!(response.openid, "oABC123xyz");
        assert_eq!(response.session_key, "test_session_key_abc");
        assert!(response.is_success());
        assert!(response.unionid.is_none());
    }

    #[test]
    fn test_login_response_with_unionid() {
        let json = r#"{
            "openid": "oABC123xyz",
            "session_key": "test_session_key_abc",
            "unionid": "uABC123union",
            "errcode": 0,
            "errmsg": "ok"
        }"#;

        let response: LoginResponse = serde_json::from_str(json).unwrap();
        assert_eq!(response.openid, "oABC123xyz");
        assert_eq!(response.session_key, "test_session_key_abc");
        assert_eq!(response.unionid, Some("uABC123union".to_string()));
        assert!(response.is_success());
    }

    #[test]
    fn test_login_response_error_parse() {
        let json = r#"{
            "errcode": 40013,
            "errmsg": "invalid appid"
        }"#;

        let response: LoginResponse = serde_json::from_str(json).unwrap();
        assert_eq!(response.errcode, 40013);
        assert_eq!(response.errmsg, "invalid appid");
        assert!(!response.is_success());
        assert!(response.openid.is_empty());
        assert!(response.session_key.is_empty());
    }

    #[test]
    fn test_is_success_true_for_zero() {
        let response = LoginResponse {
            openid: "test".to_string(),
            session_key: "test".to_string(),
            unionid: None,
            errcode: 0,
            errmsg: "ok".to_string(),
        };
        assert!(response.is_success());
    }

    #[test]
    fn test_is_success_false_for_nonzero() {
        let response = LoginResponse {
            openid: "test".to_string(),
            session_key: "test".to_string(),
            unionid: None,
            errcode: -1,
            errmsg: "system error".to_string(),
        };
        assert!(!response.is_success());
    }

    #[test]
    fn test_stable_access_token_response_parse() {
        let json = r#"{
            "access_token": "stable_token_abc123",
            "expires_in": 7200,
            "errcode": 0,
            "errmsg": "ok"
        }"#;

        let response: StableAccessTokenResponse = serde_json::from_str(json).unwrap();
        assert_eq!(response.access_token, "stable_token_abc123");
        assert_eq!(response.expires_in, 7200);
        assert_eq!(response.errcode, 0);
    }

    #[test]
    fn test_stable_access_token_response_defaults() {
        let json = r#"{"errcode": 0, "errmsg": "ok"}"#;
        let response: StableAccessTokenResponse = serde_json::from_str(json).unwrap();
        assert!(response.access_token.is_empty());
        assert_eq!(response.expires_in, 0);
    }

    #[test]
    fn test_reset_session_key_response_parse() {
        let json = r#"{
            "openid": "oABC123xyz",
            "session_key": "new_session_key_abc",
            "errcode": 0,
            "errmsg": "ok"
        }"#;

        let response: ResetSessionKeyResponse = serde_json::from_str(json).unwrap();
        assert_eq!(response.openid, "oABC123xyz");
        assert_eq!(response.session_key, "new_session_key_abc");
        assert_eq!(response.errcode, 0);
    }

    #[test]
    fn test_reset_session_key_response_defaults() {
        let json = r#"{"errcode": 0, "errmsg": "ok"}"#;
        let response: ResetSessionKeyResponse = serde_json::from_str(json).unwrap();
        assert!(response.openid.is_empty());
        assert!(response.session_key.is_empty());
    }

    #[test]
    fn test_stable_access_token_request_debug_redacts_secret() {
        let request = StableAccessTokenRequest {
            grant_type: "client_credential".to_string(),
            appid: "wx1234567890abcdef".to_string(),
            secret: "top-secret-value".to_string(),
            force_refresh: false,
        };

        let output = format!("{:?}", request);
        assert!(output.contains("secret"));
        assert!(output.contains("[REDACTED]"));
        assert!(!output.contains("top-secret-value"));
    }

    #[test]
    fn test_check_session_key_request_debug_redacts_signature() {
        let request = CheckSessionKeyRequest {
            openid: "o123".to_string(),
            signature: "sensitive-signature".to_string(),
            sig_method: "hmac_sha256".to_string(),
        };

        let output = format!("{:?}", request);
        assert!(output.contains("signature"));
        assert!(output.contains("[REDACTED]"));
        assert!(!output.contains("sensitive-signature"));
    }

    #[test]
    fn test_reset_user_session_key_request_debug_redacts_signature() {
        let request = ResetUserSessionKeyRequest {
            openid: "o123".to_string(),
            signature: "another-sensitive-signature".to_string(),
            sig_method: "hmac_sha256".to_string(),
        };

        let output = format!("{:?}", request);
        assert!(output.contains("signature"));
        assert!(output.contains("[REDACTED]"));
        assert!(!output.contains("another-sensitive-signature"));
    }
}