...

Text file src/crypto/internal/boring/README.md

Documentation: crypto/internal/boring

     1We have been working inside Google on a fork of Go that uses
     2BoringCrypto (the core of [BoringSSL](https://boringssl.googlesource.com/boringssl/))
     3for various crypto primitives, in furtherance of some work related to FIPS 140.
     4We have heard that some external users of Go would be
     5interested in this code as well, so we have published this code
     6here in the main Go repository behind the setting GOEXPERIMENT=boringcrypto.
     7
     8Use of GOEXPERIMENT=boringcrypto outside Google is _unsupported_.
     9This mode is not part of the [Go 1 compatibility rules](https://go.dev/doc/go1compat),
    10and it may change incompatibly or break in other ways at any time.
    11
    12To be clear, we are not making any statements or representations about
    13the suitability of this code in relation to the FIPS 140 standard.
    14Interested users will have to evaluate for themselves whether the code
    15is useful for their own purposes.
    16
    17---
    18
    19This directory holds the core of the BoringCrypto implementation
    20as well as the build scripts for the module itself: syso/*.syso.
    21
    22syso/goboringcrypto_linux_amd64.syso is built with:
    23
    24	GOARCH=amd64 ./build.sh
    25
    26syso/goboringcrypto_linux_arm64.syso is built with:
    27
    28	GOARCH=arm64 ./build.sh
    29
    30Both run using Docker.
    31
    32For the arm64 build to run on an x86 system, you need
    33
    34	apt-get install qemu-user-static qemu-binfmt-support
    35
    36to allow the x86 kernel to run arm64 binaries via QEMU.
    37
    38For the amd64 build to run on an Apple Silicon macOS, you need Rosetta 2.
    39
    40See build.sh for more details about the build.

View as plain text