使用Golang的miekg/PKCS11包遇New等未定义错误求助

问题场景 #

使用Golang的github.com/miekg/pkcs11包开发时，编译阶段持续出现pkcs11.New、pkcs11.Mechanism、pkcs11.NewMechanism未定义的错误，环境变量配置无误。相关代码及编译输出如下：

原代码 #

package main

import (
    "fmt"

    "github.com/miekg/pkcs11"
)

func main() {

    p := pkcs11.New("/user/lib/softhsm/libsofthsm2.dll")
    err := p.Initialize()
    if err != nil {
        panic(err)
    }

    defer p.Destroy()
    defer p.Finalize()

    slots, err := p.GetSlotList(true)
    if err != nil {
        panic(err)
    }

    session, err := p.OpenSession(slots[0], pkcs11.CKF_SERIAL_SESSION|pkcs11.CKF_RW_SESSION)
    if err != nil {
        panic(err)
    }
    defer p.CloseSession(session)

    err = p.Login(session, pkcs11.CKU_USER, "1234")
    if err != nil {
        panic(err)
    }
    defer p.Logout(session)

    p.DigestInit(session, []*pkcs11.Mechanism{pkcs11.NewMechanism(pkcs11.CKM_SHA_1, nil)})
    hash, err := p.Digest(session, []byte("this is a string"))
    if err != nil {
        panic(err)
    }

    for _, d := range hash {
        fmt.Printf("%x", d)
    }
    fmt.Println()

}

编译错误输出 #

go: finding module for package github.com/miekg/pkcs11
go: downloading github.com/miekg/pkcs11 v1.1.1
go: found github.com/miekg/pkcs11 in github.com/miekg/pkcs11 v1.1.1
# play
./prog.go:11:14: undefined: pkcs11.New
./prog.go:37:34: undefined: pkcs11.Mechanism
./prog.go:37:51: undefined: pkcs11.NewMechanism

Go build failed.

原因分析 #

你使用的是github.com/miekg/pkcs11的v1.1.1版本，但代码是基于旧版（v0.x）的示例编写的——v1.x版本对API做了不兼容的调整：

• 移除了全局的pkcs11.New函数，改用pkcs11.NewLib加载PKCS#11库
• 部分类型/函数的引用逻辑发生变化，旧版示例无法直接适配新版包

解决方案 #

1. 修改代码适配v1.x API #

将代码中的pkcs11.New替换为pkcs11.NewLib，其余API调用可保持不变（v1.1.1中pkcs11.Mechanism和pkcs11.NewMechanism是存在的）。修改后的完整代码：

package main

import (
    "fmt"

    "github.com/miekg/pkcs11"
)

func main() {
    // 替换New为NewLib加载PKCS#11库
    p := pkcs11.NewLib("/user/lib/softhsm/libsofthsm2.dll")
    err := p.Initialize()
    if err != nil {
        panic(err)
    }

    defer p.Destroy()
    defer p.Finalize()

    slots, err := p.GetSlotList(true)
    if err != nil {
        panic(err)
    }

    session, err := p.OpenSession(slots[0], pkcs11.CKF_SERIAL_SESSION|pkcs11.CKF_RW_SESSION)
    if err != nil {
        panic(err)
    }
    defer p.CloseSession(session)

    err = p.Login(session, pkcs11.CKU_USER, "1234")
    if err != nil {
        panic(err)
    }
    defer p.Logout(session)

    // NewMechanism在v1.1.1中为全局函数，可正常使用
    p.DigestInit(session, []*pkcs11.Mechanism{pkcs11.NewMechanism(pkcs11.CKM_SHA_1, nil)})
    hash, err := p.Digest(session, []byte("this is a string"))
    if err != nil {
        panic(err)
    }

    for _, d := range hash {
        fmt.Printf("%x", d)
    }
    fmt.Println()
}

2. 清理模块缓存（若修改后仍报错） #

如果修改代码后依然出现未定义错误，大概率是本地Go模块缓存存在异常，执行以下命令清理缓存并重新下载依赖：

go clean -modcache
go get github.com/miekg/pkcs11@v1.1.1

内容的提问来源于stack exchange，提问作者VictorFM