key.go 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394
  1. // Copyright (C) 2017. See AUTHORS.
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. package openssl
  15. // #include "shim.h"
  16. import "C"
  17. import (
  18. "errors"
  19. "io/ioutil"
  20. "runtime"
  21. "unsafe"
  22. )
  23. type Method *C.EVP_MD
  24. var (
  25. SHA1_Method Method = C.X_EVP_sha1()
  26. SHA256_Method Method = C.X_EVP_sha256()
  27. SHA512_Method Method = C.X_EVP_sha512()
  28. )
  29. type PublicKey interface {
  30. // Verifies the data signature using PKCS1.15
  31. VerifyPKCS1v15(method Method, data, sig []byte) error
  32. // MarshalPKIXPublicKeyPEM converts the public key to PEM-encoded PKIX
  33. // format
  34. MarshalPKIXPublicKeyPEM() (pem_block []byte, err error)
  35. // MarshalPKIXPublicKeyDER converts the public key to DER-encoded PKIX
  36. // format
  37. MarshalPKIXPublicKeyDER() (der_block []byte, err error)
  38. evpPKey() *C.EVP_PKEY
  39. }
  40. type PrivateKey interface {
  41. PublicKey
  42. // Signs the data using PKCS1.15
  43. SignPKCS1v15(Method, []byte) ([]byte, error)
  44. // MarshalPKCS1PrivateKeyPEM converts the private key to PEM-encoded PKCS1
  45. // format
  46. MarshalPKCS1PrivateKeyPEM() (pem_block []byte, err error)
  47. // MarshalPKCS1PrivateKeyDER converts the private key to DER-encoded PKCS1
  48. // format
  49. MarshalPKCS1PrivateKeyDER() (der_block []byte, err error)
  50. }
  51. type pKey struct {
  52. key *C.EVP_PKEY
  53. }
  54. func (key *pKey) evpPKey() *C.EVP_PKEY { return key.key }
  55. func (key *pKey) SignPKCS1v15(method Method, data []byte) ([]byte, error) {
  56. ctx := C.X_EVP_MD_CTX_new()
  57. defer C.X_EVP_MD_CTX_free(ctx)
  58. if 1 != C.X_EVP_SignInit(ctx, method) {
  59. return nil, errors.New("signpkcs1v15: failed to init signature")
  60. }
  61. if len(data) > 0 {
  62. if 1 != C.X_EVP_SignUpdate(
  63. ctx, unsafe.Pointer(&data[0]), C.uint(len(data))) {
  64. return nil, errors.New("signpkcs1v15: failed to update signature")
  65. }
  66. }
  67. sig := make([]byte, C.X_EVP_PKEY_size(key.key))
  68. var sigblen C.uint
  69. if 1 != C.X_EVP_SignFinal(ctx,
  70. ((*C.uchar)(unsafe.Pointer(&sig[0]))), &sigblen, key.key) {
  71. return nil, errors.New("signpkcs1v15: failed to finalize signature")
  72. }
  73. return sig[:sigblen], nil
  74. }
  75. func (key *pKey) VerifyPKCS1v15(method Method, data, sig []byte) error {
  76. ctx := C.X_EVP_MD_CTX_new()
  77. defer C.X_EVP_MD_CTX_free(ctx)
  78. if 1 != C.X_EVP_VerifyInit(ctx, method) {
  79. return errors.New("verifypkcs1v15: failed to init verify")
  80. }
  81. if len(data) > 0 {
  82. if 1 != C.X_EVP_VerifyUpdate(
  83. ctx, unsafe.Pointer(&data[0]), C.uint(len(data))) {
  84. return errors.New("verifypkcs1v15: failed to update verify")
  85. }
  86. }
  87. if 1 != C.X_EVP_VerifyFinal(ctx,
  88. ((*C.uchar)(unsafe.Pointer(&sig[0]))), C.uint(len(sig)), key.key) {
  89. return errors.New("verifypkcs1v15: failed to finalize verify")
  90. }
  91. return nil
  92. }
  93. func (key *pKey) MarshalPKCS1PrivateKeyPEM() (pem_block []byte,
  94. err error) {
  95. bio := C.BIO_new(C.BIO_s_mem())
  96. if bio == nil {
  97. return nil, errors.New("failed to allocate memory BIO")
  98. }
  99. defer C.BIO_free(bio)
  100. rsa := (*C.RSA)(C.X_EVP_PKEY_get1_RSA(key.key))
  101. if rsa == nil {
  102. return nil, errors.New("failed getting rsa key")
  103. }
  104. defer C.RSA_free(rsa)
  105. if int(C.PEM_write_bio_RSAPrivateKey(bio, rsa, nil, nil, C.int(0), nil,
  106. nil)) != 1 {
  107. return nil, errors.New("failed dumping private key")
  108. }
  109. return ioutil.ReadAll(asAnyBio(bio))
  110. }
  111. func (key *pKey) MarshalPKCS1PrivateKeyDER() (der_block []byte,
  112. err error) {
  113. bio := C.BIO_new(C.BIO_s_mem())
  114. if bio == nil {
  115. return nil, errors.New("failed to allocate memory BIO")
  116. }
  117. defer C.BIO_free(bio)
  118. rsa := (*C.RSA)(C.X_EVP_PKEY_get1_RSA(key.key))
  119. if rsa == nil {
  120. return nil, errors.New("failed getting rsa key")
  121. }
  122. defer C.RSA_free(rsa)
  123. if int(C.i2d_RSAPrivateKey_bio(bio, rsa)) != 1 {
  124. return nil, errors.New("failed dumping private key der")
  125. }
  126. return ioutil.ReadAll(asAnyBio(bio))
  127. }
  128. func (key *pKey) MarshalPKIXPublicKeyPEM() (pem_block []byte,
  129. err error) {
  130. bio := C.BIO_new(C.BIO_s_mem())
  131. if bio == nil {
  132. return nil, errors.New("failed to allocate memory BIO")
  133. }
  134. defer C.BIO_free(bio)
  135. rsa := (*C.RSA)(C.X_EVP_PKEY_get1_RSA(key.key))
  136. if rsa == nil {
  137. return nil, errors.New("failed getting rsa key")
  138. }
  139. defer C.RSA_free(rsa)
  140. if int(C.PEM_write_bio_RSA_PUBKEY(bio, rsa)) != 1 {
  141. return nil, errors.New("failed dumping public key pem")
  142. }
  143. return ioutil.ReadAll(asAnyBio(bio))
  144. }
  145. func (key *pKey) MarshalPKIXPublicKeyDER() (der_block []byte,
  146. err error) {
  147. bio := C.BIO_new(C.BIO_s_mem())
  148. if bio == nil {
  149. return nil, errors.New("failed to allocate memory BIO")
  150. }
  151. defer C.BIO_free(bio)
  152. rsa := (*C.RSA)(C.X_EVP_PKEY_get1_RSA(key.key))
  153. if rsa == nil {
  154. return nil, errors.New("failed getting rsa key")
  155. }
  156. defer C.RSA_free(rsa)
  157. if int(C.i2d_RSA_PUBKEY_bio(bio, rsa)) != 1 {
  158. return nil, errors.New("failed dumping public key der")
  159. }
  160. return ioutil.ReadAll(asAnyBio(bio))
  161. }
  162. // LoadPrivateKeyFromPEM loads a private key from a PEM-encoded block.
  163. func LoadPrivateKeyFromPEM(pem_block []byte) (PrivateKey, error) {
  164. if len(pem_block) == 0 {
  165. return nil, errors.New("empty pem block")
  166. }
  167. bio := C.BIO_new_mem_buf(unsafe.Pointer(&pem_block[0]),
  168. C.int(len(pem_block)))
  169. if bio == nil {
  170. return nil, errors.New("failed creating bio")
  171. }
  172. defer C.BIO_free(bio)
  173. rsakey := C.PEM_read_bio_RSAPrivateKey(bio, nil, nil, nil)
  174. if rsakey == nil {
  175. return nil, errors.New("failed reading rsa key")
  176. }
  177. defer C.RSA_free(rsakey)
  178. // convert to PKEY
  179. key := C.X_EVP_PKEY_new()
  180. if key == nil {
  181. return nil, errors.New("failed converting to evp_pkey")
  182. }
  183. if C.X_EVP_PKEY_set1_RSA(key, (*C.struct_rsa_st)(rsakey)) != 1 {
  184. C.X_EVP_PKEY_free(key)
  185. return nil, errors.New("failed converting to evp_pkey")
  186. }
  187. p := &pKey{key: key}
  188. runtime.SetFinalizer(p, func(p *pKey) {
  189. C.X_EVP_PKEY_free(p.key)
  190. })
  191. return p, nil
  192. }
  193. // LoadPrivateKeyFromPEMWithPassword loads a private key from a PEM-encoded block.
  194. func LoadPrivateKeyFromPEMWithPassword(pem_block []byte, password string) (
  195. PrivateKey, error) {
  196. if len(pem_block) == 0 {
  197. return nil, errors.New("empty pem block")
  198. }
  199. bio := C.BIO_new_mem_buf(unsafe.Pointer(&pem_block[0]),
  200. C.int(len(pem_block)))
  201. if bio == nil {
  202. return nil, errors.New("failed creating bio")
  203. }
  204. defer C.BIO_free(bio)
  205. cs := C.CString(password)
  206. defer C.free(unsafe.Pointer(cs))
  207. rsakey := C.PEM_read_bio_RSAPrivateKey(bio, nil, nil, unsafe.Pointer(cs))
  208. if rsakey == nil {
  209. return nil, errors.New("failed reading rsa key")
  210. }
  211. defer C.RSA_free(rsakey)
  212. // convert to PKEY
  213. key := C.X_EVP_PKEY_new()
  214. if key == nil {
  215. return nil, errors.New("failed converting to evp_pkey")
  216. }
  217. if C.X_EVP_PKEY_set1_RSA(key, (*C.struct_rsa_st)(rsakey)) != 1 {
  218. C.X_EVP_PKEY_free(key)
  219. return nil, errors.New("failed converting to evp_pkey")
  220. }
  221. p := &pKey{key: key}
  222. runtime.SetFinalizer(p, func(p *pKey) {
  223. C.X_EVP_PKEY_free(p.key)
  224. })
  225. return p, nil
  226. }
  227. // LoadPrivateKeyFromDER loads a private key from a DER-encoded block.
  228. func LoadPrivateKeyFromDER(der_block []byte) (PrivateKey, error) {
  229. if len(der_block) == 0 {
  230. return nil, errors.New("empty der block")
  231. }
  232. bio := C.BIO_new_mem_buf(unsafe.Pointer(&der_block[0]),
  233. C.int(len(der_block)))
  234. if bio == nil {
  235. return nil, errors.New("failed creating bio")
  236. }
  237. defer C.BIO_free(bio)
  238. rsakey := C.d2i_RSAPrivateKey_bio(bio, nil)
  239. if rsakey == nil {
  240. return nil, errors.New("failed reading rsa key")
  241. }
  242. defer C.RSA_free(rsakey)
  243. // convert to PKEY
  244. key := C.X_EVP_PKEY_new()
  245. if key == nil {
  246. return nil, errors.New("failed converting to evp_pkey")
  247. }
  248. if C.X_EVP_PKEY_set1_RSA(key, (*C.struct_rsa_st)(rsakey)) != 1 {
  249. C.X_EVP_PKEY_free(key)
  250. return nil, errors.New("failed converting to evp_pkey")
  251. }
  252. p := &pKey{key: key}
  253. runtime.SetFinalizer(p, func(p *pKey) {
  254. C.X_EVP_PKEY_free(p.key)
  255. })
  256. return p, nil
  257. }
  258. // LoadPrivateKeyFromPEMWidthPassword loads a private key from a PEM-encoded block.
  259. // Backwards-compatible with typo
  260. func LoadPrivateKeyFromPEMWidthPassword(pem_block []byte, password string) (
  261. PrivateKey, error) {
  262. return LoadPrivateKeyFromPEMWithPassword(pem_block, password)
  263. }
  264. // LoadPublicKeyFromPEM loads a public key from a PEM-encoded block.
  265. func LoadPublicKeyFromPEM(pem_block []byte) (PublicKey, error) {
  266. if len(pem_block) == 0 {
  267. return nil, errors.New("empty pem block")
  268. }
  269. bio := C.BIO_new_mem_buf(unsafe.Pointer(&pem_block[0]),
  270. C.int(len(pem_block)))
  271. if bio == nil {
  272. return nil, errors.New("failed creating bio")
  273. }
  274. defer C.BIO_free(bio)
  275. rsakey := C.PEM_read_bio_RSA_PUBKEY(bio, nil, nil, nil)
  276. if rsakey == nil {
  277. return nil, errors.New("failed reading rsa key")
  278. }
  279. defer C.RSA_free(rsakey)
  280. // convert to PKEY
  281. key := C.X_EVP_PKEY_new()
  282. if key == nil {
  283. return nil, errors.New("failed converting to evp_pkey")
  284. }
  285. if C.X_EVP_PKEY_set1_RSA(key, (*C.struct_rsa_st)(rsakey)) != 1 {
  286. C.X_EVP_PKEY_free(key)
  287. return nil, errors.New("failed converting to evp_pkey")
  288. }
  289. p := &pKey{key: key}
  290. runtime.SetFinalizer(p, func(p *pKey) {
  291. C.X_EVP_PKEY_free(p.key)
  292. })
  293. return p, nil
  294. }
  295. // LoadPublicKeyFromDER loads a public key from a DER-encoded block.
  296. func LoadPublicKeyFromDER(der_block []byte) (PublicKey, error) {
  297. if len(der_block) == 0 {
  298. return nil, errors.New("empty der block")
  299. }
  300. bio := C.BIO_new_mem_buf(unsafe.Pointer(&der_block[0]),
  301. C.int(len(der_block)))
  302. if bio == nil {
  303. return nil, errors.New("failed creating bio")
  304. }
  305. defer C.BIO_free(bio)
  306. rsakey := C.d2i_RSA_PUBKEY_bio(bio, nil)
  307. if rsakey == nil {
  308. return nil, errors.New("failed reading rsa key")
  309. }
  310. defer C.RSA_free(rsakey)
  311. // convert to PKEY
  312. key := C.X_EVP_PKEY_new()
  313. if key == nil {
  314. return nil, errors.New("failed converting to evp_pkey")
  315. }
  316. if C.X_EVP_PKEY_set1_RSA(key, (*C.struct_rsa_st)(rsakey)) != 1 {
  317. C.X_EVP_PKEY_free(key)
  318. return nil, errors.New("failed converting to evp_pkey")
  319. }
  320. p := &pKey{key: key}
  321. runtime.SetFinalizer(p, func(p *pKey) {
  322. C.X_EVP_PKEY_free(p.key)
  323. })
  324. return p, nil
  325. }
  326. // GenerateRSAKey generates a new RSA private key with an exponent of 3.
  327. func GenerateRSAKey(bits int) (PrivateKey, error) {
  328. return GenerateRSAKeyWithExponent(bits, 3)
  329. }
  330. // GenerateRSAKeyWithExponent generates a new RSA private key.
  331. func GenerateRSAKeyWithExponent(bits int, exponent int) (PrivateKey, error) {
  332. rsa := C.RSA_generate_key(C.int(bits), C.ulong(exponent), nil, nil)
  333. if rsa == nil {
  334. return nil, errors.New("failed to generate RSA key")
  335. }
  336. key := C.X_EVP_PKEY_new()
  337. if key == nil {
  338. return nil, errors.New("failed to allocate EVP_PKEY")
  339. }
  340. if C.X_EVP_PKEY_assign_charp(key, C.EVP_PKEY_RSA, (*C.char)(unsafe.Pointer(rsa))) != 1 {
  341. C.X_EVP_PKEY_free(key)
  342. return nil, errors.New("failed to assign RSA key")
  343. }
  344. p := &pKey{key: key}
  345. runtime.SetFinalizer(p, func(p *pKey) {
  346. C.X_EVP_PKEY_free(p.key)
  347. })
  348. return p, nil
  349. }