Skip to content

Commit

Permalink
SNOW-1862674: update readme for signature verification (#2782)
Browse files Browse the repository at this point in the history
  • Loading branch information
sfc-gh-aling authored Dec 18, 2024
1 parent 8e614ee commit b852e46
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@
- `nullifzero`
- `snowflake_cortex_sentiment`

#### Improvements

- Updated README.md to include instructions on how to verify package signatures using `cosign`.

### Snowpark pandas API Updates

#### New Features
Expand Down
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,28 @@ pandas_df = df.to_pandas()

Note that the above Snowpark pandas commands will work if Snowpark is installed with the `[modin]` option, the additional `[pandas]` installation is not required.

## Verifying Package Signatures

To ensure the authenticity and integrity of the Python package, follow the steps below to verify the package signature using `cosign`.

**Steps to verify the signature:**
- Install cosign:
- This example is using golang installation: [installing-cosign-with-go](https://edu.chainguard.dev/open-source/sigstore/cosign/how-to-install-cosign/#installing-cosign-with-go)
- Download the file from the repository like pypi:
- https://pypi.org/project/snowflake-snowpark-python/#files
- Download the signature files from the release tag, replace the version number with the version you are verifying:
- https://github.com/snowflakedb/snowpark-python/releases/tag/v1.22.1
- Verify signature:
````bash
# replace the version number with the version you are verifying
./cosign verify-blob snowflake_snowpark_python-1.22.1-py3-none-any.whl \
--certificate snowflake_snowpark_python-1.22.1-py3-none-any.whl.crt \
--certificate-identity https://github.com/snowflakedb/snowpark-python/.github/workflows/python-publish.yml@refs/tags/v1.22.1 \
--certificate-oidc-issuer https://token.actions.githubusercontent.com \
--signature snowflake_snowpark_python-1.22.1-py3-none-any.whl.sig
Verified OK
````

## Contributing
Please refer to [CONTRIBUTING.md][contributing].

Expand Down

0 comments on commit b852e46

Please sign in to comment.