OASystem.API.xml 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>OASystem.API</name>
  5. </assembly>
  6. <members>
  7. <member name="T:OASystem.API.Controllers.AuthController">
  8. <summary>
  9. 鉴权相关
  10. </summary>
  11. </member>
  12. <member name="M:OASystem.API.Controllers.AuthController.LoginAsync(OASystem.Domain.Dtos.LoginDto)">
  13. <summary>
  14. 用户登录
  15. </summary>
  16. <param name="dto"></param>
  17. <returns></returns>
  18. </member>
  19. <member name="M:OASystem.API.Controllers.AuthController.TestToken(OASystem.Domain.Dtos.LoginDto)">
  20. <summary>
  21. 测试auth
  22. </summary>
  23. <param name="dto"></param>
  24. <returns></returns>
  25. </member>
  26. <member name="T:OASystem.API.Controllers.ControllerBase">
  27. <summary>
  28. 控制器基类
  29. </summary>
  30. </member>
  31. <member name="F:OASystem.API.CMBPayBusiness.BaseConfig.Version">
  32. <summary>
  33. 版本号
  34. </summary>
  35. </member>
  36. <member name="F:OASystem.API.CMBPayBusiness.BaseConfig.Encoding">
  37. <summary>
  38. 编码方式
  39. </summary>
  40. </member>
  41. <member name="F:OASystem.API.CMBPayBusiness.BaseConfig.SignMethod">
  42. <summary>
  43. 签名方法 SM2
  44. </summary>
  45. </member>
  46. <member name="F:OASystem.API.CMBPayBusiness.BaseConfig.MER_ID">
  47. <summary>
  48. 招商银行商户号
  49. </summary>
  50. </member>
  51. <member name="F:OASystem.API.CMBPayBusiness.BaseConfig.USER_ID">
  52. <summary>
  53. 招商银行收银员
  54. </summary>
  55. </member>
  56. <member name="F:OASystem.API.CMBPayBusiness.BaseConfig.APPID">
  57. <summary>
  58. header中的APPID
  59. </summary>
  60. </member>
  61. <member name="F:OASystem.API.CMBPayBusiness.BaseConfig.APP_SECRET">
  62. <summary>
  63. 用于生成header中的APISign
  64. </summary>
  65. </member>
  66. <member name="F:OASystem.API.CMBPayBusiness.BaseConfig.SM2_KEY_TITLE">
  67. <summary>
  68. 国密标准公钥头(固定值)
  69. </summary>
  70. </member>
  71. <member name="F:OASystem.API.CMBPayBusiness.BaseConfig.SM_USER_ID">
  72. <summary>
  73. 国密局推荐 ID(固定值)
  74. </summary>
  75. </member>
  76. <member name="F:OASystem.API.CMBPayBusiness.BaseConfig.SM_PRIVATE_KEY">
  77. <summary>
  78. 国密私钥
  79. </summary>
  80. </member>
  81. <member name="F:OASystem.API.CMBPayBusiness.BaseConfig.SM_PUBLIC_KEY">
  82. <summary>
  83. 国密公钥 base64
  84. </summary>
  85. </member>
  86. <member name="F:OASystem.API.CMBPayBusiness.UrlConfig.NotifyUrl">
  87. <summary>
  88. 通知地址
  89. </summary>
  90. </member>
  91. <member name="F:OASystem.API.CMBPayBusiness.UrlConfig.CollectionQRCode">
  92. <summary>
  93. 收款码申请
  94. </summary>
  95. </member>
  96. <member name="F:OASystem.API.CMBPayBusiness.UrlConfig.OrderqueryUrl">
  97. <summary>
  98. 支付结果查询
  99. </summary>
  100. </member>
  101. <member name="F:OASystem.API.CMBPayBusiness.UrlConfig.RefundUrl">
  102. <summary>
  103. 发起退款申请
  104. </summary>
  105. </member>
  106. <member name="F:OASystem.API.CMBPayBusiness.UrlConfig.RefundqueryUrl">
  107. <summary>
  108. 退款申请查询
  109. </summary>
  110. </member>
  111. <member name="F:OASystem.API.CMBPayBusiness.UrlConfig.ZFBQRCodeUrl">
  112. <summary>
  113. 支付宝native支付
  114. </summary>
  115. </member>
  116. <member name="M:OASystem.API.CMBPayBusiness.Common.GetBeijingTime">
  117. <summary>
  118. 返回网络时间 --北京时间
  119. </summary>
  120. <returns></returns>
  121. </member>
  122. <member name="M:OASystem.API.CMBPayBusiness.Common.CombinImage(System.Drawing.Image,System.String)">
  123. <summary>
  124. 调用此函数后使此两种图片合并,类似相册,有个
  125. 背景图,中间贴自己的目标图片
  126. </summary>
  127. <param name="imgBack">粘贴的源图片</param>
  128. <param name="destImg">粘贴的目标图片</param>
  129. </member>
  130. <member name="M:OASystem.API.CMBPayBusiness.Common.KiResizeImage(System.Drawing.Image,System.Int32,System.Int32,System.Int32)">
  131. <summary>
  132. Resize图片
  133. </summary>
  134. <param name="bmp">原始Bitmap</param>
  135. <param name="newW">新的宽度</param>
  136. <param name="newH">新的高度</param>
  137. <param name="Mode">保留着,暂时未用</param>
  138. <returns>处理以后的图片</returns>
  139. </member>
  140. <member name="T:OASystem.API.CMBPayBusiness.GmUtil">
  141. need lib:
  142. BouncyCastle.Crypto.dll(http://www.bouncycastle.org/csharp/index.html)(这段代码写的时候用的bccrypto-csharp-1.8.8,最低支持版本和最高支持版本自己研究)
  143. log4net.dll(http://logging.apache.org/log4net/)(仅为了输出日志用,不用的话可自行改换其他方式输出异常信息)
  144. ref:
  145. https://tools.ietf.org/html/draft-shen-sm2-ecdsa-02
  146. http://gmssl.org/docs/oid.html
  147. http://www.jonllen.com/jonllen/work/164.aspx
  148. 用BC的注意点:
  149. 这个版本的BC对SM3withSM2的结果为asn1格式的r和s,如果需要直接拼接的r||s需要自己转换。下面rsAsn1ToPlainByteArray、rsPlainByteArrayToAsn1就在干这事。
  150. 这个版本的BC对SM2的结果为C1||C2||C3,据说为旧标准,新标准为C1||C3||C2,用新标准的需要自己转换。下面(被注释掉的)changeC1C2C3ToC1C3C2、changeC1C3C2ToC1C2C3就在干这事。java版的高版本有加上C1C3C2,csharp版没准以后也会加,但目前还没有,java版的目前可以初始化时“ SM2Engine sm2Engine = new SM2Engine(SM2Engine.Mode.C1C3C2);”。
  151. </member>
  152. <member name="M:OASystem.API.CMBPayBusiness.GmUtil.SignSm3WithSm2(System.Byte[],System.Byte[],Org.BouncyCastle.Crypto.AsymmetricKeyParameter)">
  153. @param msg
  154. @param userId
  155. @param privateKey
  156. @return r||s,直接拼接byte数组的rs
  157. </member>
  158. <member name="M:OASystem.API.CMBPayBusiness.GmUtil.signRawToAsn1(System.Byte[])">
  159. 将BC SM2 RAW签名值转化为ASN1格式签名值
  160. @param bcCipTxt
  161. @return
  162. @throws Exception
  163. </member>
  164. <member name="M:OASystem.API.CMBPayBusiness.GmUtil.signAsn12Raw(System.Byte[])">
  165. 将ASN1格式签名值转化为BC SM2 RAW 签名值
  166. @param signature Asn1格式签名值
  167. @return byte[] Raw签名值
  168. </member>
  169. <member name="M:OASystem.API.CMBPayBusiness.GmUtil.SignSm3WithSm2Asn1Rs(System.Byte[],System.Byte[],Org.BouncyCastle.Crypto.AsymmetricKeyParameter)">
  170. @param msg
  171. @param userId
  172. @param privateKey
  173. @return rs in <b>asn1 format</b>
  174. </member>
  175. <member name="M:OASystem.API.CMBPayBusiness.GmUtil.VerifySm3WithSm2(System.Byte[],System.Byte[],System.Byte[],Org.BouncyCastle.Crypto.AsymmetricKeyParameter)">
  176. @param msg
  177. @param userId
  178. @param rs r||s,直接拼接byte数组的rs
  179. @param publicKey
  180. @return
  181. </member>
  182. <member name="M:OASystem.API.CMBPayBusiness.GmUtil.VerifySm3WithSm2Asn1Rs(System.Byte[],System.Byte[],System.Byte[],Org.BouncyCastle.Crypto.AsymmetricKeyParameter)">
  183. @param msg
  184. @param userId
  185. @param rs in <b>asn1 format</b>
  186. @param publicKey
  187. @return
  188. </member>
  189. <member name="M:OASystem.API.CMBPayBusiness.GmUtil.ChangeC1C2C3ToC1C3C2(System.Byte[])">
  190. bc加解密使用旧标c1||c2||c3,此方法在加密后调用,将结果转化为c1||c3||c2
  191. @param c1c2c3
  192. @return
  193. </member>
  194. <member name="M:OASystem.API.CMBPayBusiness.GmUtil.ChangeC1C3C2ToC1C2C3(System.Byte[])">
  195. bc加解密使用旧标c1||c3||c2,此方法在解密前调用,将密文转化为c1||c2||c3再去解密
  196. @param c1c3c2
  197. @return
  198. </member>
  199. <member name="M:OASystem.API.CMBPayBusiness.GmUtil.Sm2Decrypt(System.Byte[],Org.BouncyCastle.Crypto.AsymmetricKeyParameter)">
  200. c1||c3||c2
  201. @param data
  202. @param key
  203. @return
  204. </member>
  205. <member name="M:OASystem.API.CMBPayBusiness.GmUtil.Sm2Encrypt(System.Byte[],Org.BouncyCastle.Crypto.AsymmetricKeyParameter)">
  206. c1||c3||c2
  207. @param data
  208. @param key
  209. @return
  210. </member>
  211. <member name="M:OASystem.API.CMBPayBusiness.GmUtil.Sm2EncryptOld(System.Byte[],Org.BouncyCastle.Crypto.AsymmetricKeyParameter)">
  212. c1||c2||c3
  213. @param data
  214. @param key
  215. @return
  216. </member>
  217. <member name="M:OASystem.API.CMBPayBusiness.GmUtil.Sm2DecryptOld(System.Byte[],Org.BouncyCastle.Crypto.AsymmetricKeyParameter)">
  218. c1||c2||c3
  219. @param data
  220. @param key
  221. @return
  222. </member>
  223. <member name="M:OASystem.API.CMBPayBusiness.GmUtil.Sm3(System.Byte[])">
  224. @param bytes
  225. @return
  226. </member>
  227. <member name="M:OASystem.API.CMBPayBusiness.GmUtil.RsAsn1ToPlainByteArray(System.Byte[])">
  228. BC的SM3withSM2签名得到的结果的rs是asn1格式的,这个方法转化成直接拼接r||s
  229. @param rsDer rs in asn1 format
  230. @return sign result in plain byte array
  231. </member>
  232. <member name="M:OASystem.API.CMBPayBusiness.GmUtil.RsPlainByteArrayToAsn1(System.Byte[])">
  233. BC的SM3withSM2验签需要的rs是asn1格式的,这个方法将直接拼接r||s的字节数组转化成asn1格式
  234. @param sign in plain byte array
  235. @return rs result in asn1 format
  236. </member>
  237. <member name="M:OASystem.API.CMBPayBusiness.GmUtil.Join(System.Byte[][])">
  238. 字节数组拼接
  239. @param params
  240. @return
  241. </member>
  242. <member name="M:OASystem.API.CMBPayBusiness.GmUtil.KDF(System.Byte[],System.Int32)">
  243. 密钥派生函数
  244. @param Z
  245. @param klen
  246. 生成klen字节数长度的密钥
  247. @return
  248. </member>
  249. <member name="M:OASystem.API.CMBPayBusiness.GmUtil.readSm2File(System.Byte[],System.String)">
  250. cfca官网CSP沙箱导出的sm2文件
  251. @param pem 二进制原文
  252. @param pwd 密码
  253. @return
  254. </member>
  255. <member name="M:OASystem.API.CMBPayBusiness.GmUtil.ReadSm2X509Cert(System.Byte[])">
  256. @param cert
  257. @return
  258. </member>
  259. <member name="M:OASystem.API.CMBPayBusiness.GmUtil.parseBase64TRawKey(System.String)">
  260. BASE64格式公钥转换为裸公钥
  261. @param sm2Key
  262. @return
  263. </member>
  264. <member name="M:OASystem.API.CMBPayBusiness.GmUtil.generateSmSign(System.String)">
  265. 加签
  266. </member>
  267. <member name="M:OASystem.API.CMBPayBusiness.GmUtil.verifySmSign(System.String,System.String)">
  268. 验签
  269. </member>
  270. </members>
  271. </doc>