tls

成员函数	函数描述/介绍
tls.DecryptWithPkcs1v15	DecryptWithPkcs1v15 将PEM格式的私钥与密文进行PKCS1v15解密，返回明文与错误
tls.EncryptWithPkcs1v15	EncryptWithPkcs1v15 将PEM格式的公钥与数据进行PKCS1v15加密，返回密文与错误
tls.GenerateRSA1024KeyPair	GenerateRSA1024KeyPair 生成1024位大小的RSA公私钥对，返回PEM格式公钥和私钥与错误
tls.GenerateRSA2048KeyPair	GenerateRSA2048KeyPair 生成2048位大小的RSA公私钥对，返回PEM格式公钥和私钥与错误
tls.GenerateRSA4096KeyPair	GenerateRSA4096KeyPair 生成4096位大小的RSA公私钥对，返回PEM格式公钥和私钥与错误
tls.GenerateRSAKeyPair	GenerateRSAKeyPair 根据给定的bit大小生成RSA公私钥对，返回PEM格式公钥和私钥与错误
tls.GenerateRootCA	GenerateRootCA 根据名字生成根证书和私钥，返回PEM格式证书和私钥与错误
tls.GenerateSM2KeyPair	GenerateSM2KeyPair 生成SM2公私钥对，返回PEM格式公钥和私钥与错误
tls.Inspect	Inspect 检查目标地址的TLS证书，并返回其证书信息与错误
tls.SignClientCertAndKey	SignClientCertAndKey 根据给定的CA证书和私钥，生成不包含认证的客户端证书和密钥，返回PEM格式的客户端证书和密钥与错误
tls.SignServerCertAndKey	SignServerCertAndKey 根据给定的CA证书和私钥，生成不包含认证的服务器证书和密钥，返回PEM格式的服务器证书和密钥与错误
tls.SignX509ClientCertAndKey	SignX509ClientCertAndKey 根据给定的CA证书和私钥，生成客户端证书和密钥，返回PEM格式的客户端证书和密钥与错误
tls.SignX509ServerCertAndKey	SignX509ServerCertAndKey 根据给定的CA证书和私钥，生成服务器证书和密钥，返回PEM格式的服务器证书和密钥与错误

函数定义

DecryptWithPkcs1v15

详细描述

DecryptWithPkcs1v15 将PEM格式的私钥与密文进行PKCS1v15解密，返回明文与错误

Example:

dec, err := tls.DecryptWithPkcs1v15(pemBytes, enc)

定义

DecryptWithPkcs1v15(pemPriBytes []byte, data any) ([]byte, error)

参数

参数名	参数类型	参数解释
pemPriBytes	[]byte
data	any

返回值

返回值(顺序)	返回值类型	返回值解释
r1	[]byte
r2	error

EncryptWithPkcs1v15

详细描述

EncryptWithPkcs1v15 将PEM格式的公钥与数据进行PKCS1v15加密，返回密文与错误

Example:

enc, err := tls.EncryptWithPkcs1v15(pemBytes, "hello")

定义

EncryptWithPkcs1v15(pemBytes []byte, data any) ([]byte, error)

参数

参数名	参数类型	参数解释
pemBytes	[]byte
data	any

返回值

返回值(顺序)	返回值类型	返回值解释
r1	[]byte
r2	error

GenerateRSA1024KeyPair

详细描述

GenerateRSA1024KeyPair 生成1024位大小的RSA公私钥对，返回PEM格式公钥和私钥与错误

Example:

pub, pri, err := tls.GenerateRSA1024KeyPair()

定义

GenerateRSA1024KeyPair() ([]byte, []byte, error)

返回值

返回值(顺序)	返回值类型	返回值解释
r1	[]byte
r2	[]byte
r3	error

GenerateRSA2048KeyPair

详细描述

GenerateRSA2048KeyPair 生成2048位大小的RSA公私钥对，返回PEM格式公钥和私钥与错误

Example:

pub, pri, err := tls.GenerateRSA2048KeyPair()

定义

GenerateRSA2048KeyPair() ([]byte, []byte, error)

返回值

返回值(顺序)	返回值类型	返回值解释
r1	[]byte
r2	[]byte
r3	error

GenerateRSA4096KeyPair

详细描述

GenerateRSA4096KeyPair 生成4096位大小的RSA公私钥对，返回PEM格式公钥和私钥与错误

Example:

pub, pri, err := tls.GenerateRSA4096KeyPair()

定义

GenerateRSA4096KeyPair() ([]byte, []byte, error)

返回值

返回值(顺序)	返回值类型	返回值解释
r1	[]byte
r2	[]byte
r3	error

GenerateRSAKeyPair

详细描述

GenerateRSAKeyPair 根据给定的bit大小生成RSA公私钥对，返回PEM格式公钥和私钥与错误

Example:

pub, pri, err := tls.GenerateRSAKeyPair(2048)

定义

GenerateRSAKeyPair(bitSize int) ([]byte, []byte, error)

参数

参数名	参数类型	参数解释
bitSize	int

返回值

返回值(顺序)	返回值类型	返回值解释
r1	[]byte
r2	[]byte
r3	error

GenerateRootCA

详细描述

GenerateRootCA 根据名字生成根证书和私钥，返回PEM格式证书和私钥与错误

Example:

cert, key, err := tls.GenerateRootCA("yaklang.io")

定义

GenerateRootCA(commonName string) (ca []byte, key []byte, err error)

参数

参数名	参数类型	参数解释
commonName	string

返回值

返回值(顺序)	返回值类型	返回值解释
ca	[]byte
key	[]byte
err	error

GenerateSM2KeyPair

详细描述

GenerateSM2KeyPair 生成SM2公私钥对，返回PEM格式公钥和私钥与错误

Example:

pub, pri, err := tls.GenerateSM2KeyPair()

定义

GenerateSM2KeyPair() ([]byte, []byte, error)

返回值

返回值(顺序)	返回值类型	返回值解释
r1	[]byte
r2	[]byte
r3	error

Inspect

详细描述

Inspect 检查目标地址的TLS证书，并返回其证书信息与错误

Example:

cert, err := tls.Inspect("yaklang.io:443")

定义

Inspect(addr string) ([]*TLSInspectResult, error)

参数

参数名	参数类型	参数解释
addr	string

返回值

返回值(顺序)	返回值类型	返回值解释
r1	[]*TLSInspectResult
r2	error

SignClientCertAndKey

详细描述

SignClientCertAndKey 根据给定的CA证书和私钥，生成不包含认证的客户端证书和密钥，返回PEM格式的客户端证书和密钥与错误

Example:

ca, key, err = tls.GenerateRootCA("yaklang.io")cert, sKey, err = tls.SignClientCertAndKey(ca, key)

定义

SignClientCertAndKey(ca []byte, key []byte) ([]byte, []byte, error)

参数

参数名	参数类型	参数解释
ca	[]byte
key	[]byte

返回值

返回值(顺序)	返回值类型	返回值解释
r1	[]byte
r2	[]byte
r3	error

SignServerCertAndKey

详细描述

SignServerCertAndKey 根据给定的CA证书和私钥，生成不包含认证的服务器证书和密钥，返回PEM格式的服务器证书和密钥与错误

Example:

ca, key, err = tls.GenerateRootCA("yaklang.io")cert, sKey, err = tls.SignServerCertAndKey(ca, key)

定义

SignServerCertAndKey(ca []byte, key []byte) (cert []byte, sKey []byte, _ error)

参数

参数名	参数类型	参数解释
ca	[]byte
key	[]byte

返回值

返回值(顺序)	返回值类型	返回值解释
cert	[]byte
sKey	[]byte
_	error

SignX509ClientCertAndKey

详细描述

SignX509ClientCertAndKey 根据给定的CA证书和私钥，生成客户端证书和密钥，返回PEM格式的客户端证书和密钥与错误

Example:

ca, key, err = tls.GenerateRootCA("yaklang.io")cert, sKey, err = tls.SignX509ClientCertAndKey(ca, key)

定义

SignX509ClientCertAndKey(ca []byte, key []byte) ([]byte, []byte, error)

参数

参数名	参数类型	参数解释
ca	[]byte
key	[]byte

返回值

返回值(顺序)	返回值类型	返回值解释
r1	[]byte
r2	[]byte
r3	error

SignX509ServerCertAndKey

详细描述

SignX509ServerCertAndKey 根据给定的CA证书和私钥，生成服务器证书和密钥，返回PEM格式的服务器证书和密钥与错误

Example:

ca, key, err = tls.GenerateRootCA("yaklang.io")cert, sKey, err = tls.SignX509ServerCertAndKey(ca, key)

定义

SignX509ServerCertAndKey(ca []byte, key []byte) (cert []byte, sKey []byte, _ error)

参数

参数名	参数类型	参数解释
ca	[]byte
key	[]byte

返回值

返回值(顺序)	返回值类型	返回值解释
cert	[]byte
sKey	[]byte
_	error