doc: add documentation for golang/rust sdk

Signed-off-by: Ruoyu Ying <[email protected]>

Author: Ruoyu-y

sdk/golang/README.md

@@ -0,0 +1,218 @@
+# Confidential Cloud-Native Primitives SDK for Golang
+
+The Confidential Cloud-Native Primitives (CCNP) project is the solution targeted on simplifying the use of Trusted Execution Environment (TEE) in cloud-native environment. Currently, there are 2 parts included in CCNP, the services and the SDK.
+
+- Service is designed to hide the complexity of different TEE platforms and provides common interfaces and scalability for cloud-native environment.
+- SDK is to simplify the use of the service interface for development, it covers communication to the service and parses the results from the services.
+
+The service supports attestation, measurement fetching and event log collecting of various platforms including Intel Trusted Domain Extensions (TDX), Trusted Platform Modules (TPM) and AMD SEV-SNP. More platforms will be supported later.
+
+Attestation is a common process within TEE platform and TPM to verify if the software binaries were properly instantiated on a trusted platform. Third parties can leverage the attestation process to identify the trustworthiness of the platform (by checking the measurements or event logs) as well as the software running on it, in order to decide whether they shall put their confidential information/workload onto the platform.
+
+CCNP, as the overall framework for attestation, measurement and event log fetching, provides user with both customer-facing SDK and overall framework. By leveraging this SDK, user can easily retrieve different kinds of measurements or evidence such as event logs. Working along with different verification services (such as Amber) and configurable policies, user can validate the trustworthiness of the  platform and make further decision.
+
+[Source code][source_code]
+| [Package (Go package)][ccnp_golang]
+| [API reference documentation][api_doc]
+
+## Getting started
+
+### Prerequisites
+In order to work properly, user need to have the backend services ready on the TEE or TPM enabled platform first. Please refer to each deployment guide reside in the [service](../../service/) folder to install the backend services.
+
+### Install the package
+User can install the CCNP client library for Golang:
+
+```
+go get github.com/cc-api/confidential-cloud-native-primitives/sdk/golang/ccnp
+```
+
+## Key concepts and usage
+There are three major functionalities provided in this SDK:
+
+* [CC report fetching](#cc-report)
+* [Measurement fetching](#measurement)
+* [Event log fetching](#event-log)
+
+### CC Report
+
+Using this SDK, user could fetch the report from different platforms, the service detect the platform automatically and return the report.
+
+#### Example usage of the SDK
+
+The interface input of CC report is `nonce` and `user_data`, both of them are optional and will be measured in the report.
+Here are the example usages of the SDK:
+
+* Fetch report with a `nonce` and `user_data`
+```golang
+import (
+    b64 "encoding/base64"
+    "encoding/binary"
+    "math"
+    "math/rand"
+    "fmt"
+    "os"
+
+    "github.com/cc-api/cc-trusted-api/common/golang/cctrusted_base"
+	"github.com/cc-api/confidential-cloud-native-primitives/sdk/golang/ccnp"
+)
+
+func testGetCCReport() {
+    sdk := ccnp.SDK{}
+
+    num := uint64(rand.Int63n(math.MaxInt64))
+    b := make([]byte, 8)
+    binary.LittleEndian.PutUint64(b, num)
+    nonce := b64.StdEncoding.EncodeToString(b)
+
+    rawBytes := []byte("demo user data")
+    userData := b64.StdEncoding.EncodeToString(rawBytes)
+    report, err := sdk.GetCCReport(nonce, userData, nil)
+    if err != nil {
+        fmt.Println("Error in fetching cc report.")
+        os.Exit(-1)
+    }
+
+    fmt.Println("Dump the attestation report fetched.")
+    report.Dump(cctrusted_base.QuoteDumpFormat(cctrusted_base.QuoteDumpFormatRaw))
+}
+
+```
+
+
+### Measurement
+
+Using this SDK, user could fetch various measurements from different perspective and categories.
+Basic support on measurement focus on the platform measurements, including TEE report, values within TDX RTMR registers or values reside in TPM PCR registers.
+There's also advanced support to provide measurement for a certain workload or container. The feature is still developing in progress.
+
+#### Example usage of the SDK
+
+Here are the example usages for measurement SDK:
+
+* Fetch TEE IMR measurement of the current pod(Fetch IMR[0] in the example)
+```golang
+import(
+    "os"
+    "fmt"
+
+    "github.com/cc-api/cc-trusted-api/common/golang/cctrusted_base"
+    "github.com/cc-api/confidential-cloud-native-primitives/sdk/golang/ccnp"
+)
+
+func testGetCCMeasurement() {
+    sdk := ccnp.SDK{}
+
+    // set the imr index to 0
+    imr_index := 0
+    alg := cctrusted_base.TPM_ALG_SHA384
+
+    measurement, err := sdk.GetCCMeasurement(imr_index, alg)
+    if err != nil {
+        os.Exit(-1)
+    }
+
+    fmt.Println("Dump measurement fetched.")
+    fmt.Println("AlgID:  ", measurement.AlgID)
+    fmt.Println("Digest:")
+    fmt.Printf("    %02X", measurement.Hash)
+}
+
+```
+
+### Event log
+
+Using this SDK, user can fetch the event logs to assist the attestation/verification process. It also enables two different categories of event logs - for the platform or for a single workload/container.
+From platform perspective, it can support different Trusted Execution Environment and TPM. This sdk can also do fetching on certain number of event logs.
+
+#### Example usage of the SDK
+
+Here are the example usages of the SDK:
+
+* Fetch event log of platform and check the information inside
+```golang
+import(
+    "os"
+    "fmt"
+
+    "github.com/cc-api/cc-trusted-api/common/golang/cctrusted_base"
+    "github.com/cc-api/confidential-cloud-native-primitives/sdk/golang/ccnp"
+)
+
+func testGetCCEventLog() {
+    sdk := ccnp.SDK{}
+
+    /*
+        Another example to set start to 0 and count to 10 for event log retrieval
+        start := int32(0)
+        count := int32(10)
+        eventLogs, err := sdk.GetCCEventLog(start, count)
+    */
+    eventLogs, err := sdk.GetCCEventLog()
+    if err != nil {
+        fmt.Println("Error in fetching event logs.")
+        os.Exit(-1)
+    }
+
+    fmt.Println("Total ", len(eventLogs), " of event logs fetched.")
+    for _, log := range eventLogs {
+        log.Dump()
+    }
+}
+
+```
+
+* Replay the event logs
+```golang
+import(
+    "os"
+    "fmt"
+
+    "github.com/cc-api/cc-trusted-api/common/golang/cctrusted_base"
+    "github.com/cc-api/confidential-cloud-native-primitives/sdk/golang/ccnp"
+)
+
+func testReplayCCEventLog() {
+    sdk := ccnp.SDK{}
+
+    eventLogs, err := sdk.GetCCEventLog()
+    if err != nil {
+        fmt.Println("Error in fetching event logs.")
+        os.Exit(-1)
+    }
+
+    fmt.Println("Total ", len(eventLogs), " of event logs fetched.")
+    res := sdk.ReplayCCEventLog(eventLogs)
+    for key, value := range res {
+        fmt.Println(key, ": ", value)
+    }
+
+}
+
+```
+
+## End-to-end examples
+
+TBA.
+
+## Troubleshooting
+
+Troubleshooting information for the CCNP SDK can be found here.
+
+## Next steps
+For more information about the Confidential Cloud-Native Primitives, please see our documentation page.
+
+## Contributing
+This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit the Contributor License Agreement site.
+
+When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
+
+See [CONTRIBUTING.md](../../CONTRIBUTING.md) for details on building, testing, and contributing to these libraries.
+
+## Provide Feedback
+If you encounter any bugs or have suggestions, please file an issue in the Issues section of the project.
+
+<!-- LINKS -->
+[source_code]: https://github.com/cc-api/confidential-cloud-native-primitives/tree/main/sdk/golang
+[ccnp_golang]: https://pkg.go.dev/github.com/cc-api/confidential-cloud-native-primitives/sdk/golang/ccnp
+[api_doc]: https://github.com/cc-api/cc-trusted-api?tab=readme-ov-file#3-apis

sdk/golang/example/go-sdk-example.go

@@ -12,7 +12,7 @@ import (
 	"github.com/cc-api/confidential-cloud-native-primitives/sdk/golang/ccnp"
 )
 
-// func to test GetCCMeasurement()
+// func to test GetCCReport()
 func testGetCCReport(sdk ccnp.SDK, logger *log.Logger) {
 	logger.Println("Call [GetCCReport] to fetch attestation report...")