native-pkcs11 - GitLite

KO | EN

gitlite — search

#javascript #python #ai #typescript #golang #rust #deep-learning #linux #docker #macos #java #windows #cli #ios

native-pkcs11

(★ 74)

No description available.

파일 탐색기

최종 버전 다운로드 (.zip)

- - ci.yaml
- dependabot.yaml
- settings.json
- - lib.rs
  - object_store.rs
  - sessions.rs
  - utils.rs
- .gitignore
- Cargo.toml
- CHANGELOG.md
- LICENSE
- - attribute.rs
  - lib.rs
  - mechanism.rs
  - object.rs
- Cargo.toml
- CHANGELOG.md
- LICENSE
- - lib.rs
- Cargo.toml
- CHANGELOG.md
- LICENSE
- - lib.rs
- Cargo.toml
- CHANGELOG.md
- LICENSE
- - lib.rs
- Cargo.toml
- CHANGELOG.md
- LICENSE
- README.md
- - lib.rs
  - pkcs11_unix.rs
  - pkcs11_windows.rs
- .gitignore
- build.rs
- Cargo.toml
- CHANGELOG.md
- LICENSE
- pkcs11.h
- - run.sh
  - SunPKCS11ProviderTest.java
- - run.sh
  - ssh_config
  - ssh_host_ecdsa_key
  - sshd_config.template
- create_keychain.sh
- create_selfsigned.sh
- - LICENSE
  - pkcs11.h
  - pkcs11f.h
  - pkcs11t.h
.gitignore
.gitmodules
Cargo.lock
Cargo.toml
conformancetest.sh
CONTRIBUTING.md
deny.toml
LICENSE
osv-scanner.toml
package-lipo.sh
pkcs11test
README.md
release-plz.toml
rustfmt.toml

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# `native-pkcs11`

> pkcs11 module for native credential stores

`native-pkcs11` is a crate for building PKCS#11 modules. Its primary use-case is
authenticating with client certificates. `native-pkcs11` aims to support native
certificate stores (MacOS Keychain, Windows Platform Key Provider) out of the
box. It can also be extended with a custom backend (see
[this section](#building-a-custom-backend)).

## Host Software Compatibility

Software compatibility is a core goal of `native-pkcs11`. It is currently tested
with

- openssh
- openvpn
- Chrome
- Firefox

If a `native-pkcs11` module does not work for your software, please file an
issue.

## Building a Custom Backend

The `native_pkcs11_traits::Backend` trait can be implemented to add support for
a new credential store. Backends are registered in the exported
`C_GetFunctionList` function. In order to register your own backend, enable the
`custom-function-list` feature on `native-pkcs11` and export the method from
your crate. For example:

```rs
use native_pkcs11::{CKR_OK, CK_FUNCTION_LIST_PTR_PTR, CK_RV, FUNC_LIST};
#[no_mangle]
pub extern "C" fn C_GetFunctionList(ppFunctionList: CK_FUNCTION_LIST_PTR_PTR) -> CK_RV {
    native_pkcs11_traits::register_backend(Box::new(backend::MyBackend {}));
    unsafe { *ppFunctionList = &mut FUNC_LIST };
    return CKR_OK;
}
```

## Running tests

### macOS

Create a tempory keychain and set `NATIVE_PKCS11_KEYCHAIN_PATH` to run `cargo test` without endless password prompts.
```
$ . tests/create_keychain.sh
$ cargo test
```

## Releasing

The [`cargo-ws`](https://github.com/pksunkara/cargo-workspaces) tool can be used
to version bump and release all crates in the workspace at once. It can be
installed with `cargo install cargo-workspaces`.

```bash
# Create a branch for the release PR
git checkout -b release
# Bump the version of all crates in the workspace
cargo ws version --allow-branch=release --no-git-push
# Publish all crates to crates.io
cargo ws publish --no-git-push
```