https://github.com/HewlettPackard/c-spiffe

https://github.com/HewlettPackard/c-spiffe

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/HewlettPackard/c-spiffe
• Owner: HewlettPackard
• License: apache-2.0
• Created: 2021-01-28T22:55:08.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-08-27T19:07:34.000Z (about 3 years ago)
• Last Synced: 2024-04-28T16:35:07.980Z (5 months ago)
• Language: C
• Size: 256 MB
• Stars: 12
• Watchers: 12
• Forks: 10
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-spiffe-spire - c spiffe

README

        


# c-spiffe

C extension for Spiffe platform.

[![Build and run tests](https://github.com/HewlettPackard/c-spiffe/actions/workflows/actions.yml/badge.svg)](https://github.com/HewlettPackard/c-spiffe/actions/workflows/actions.yml)

[![codecov](https://codecov.io/gh/HewlettPackard/c-spiffe/branch/master/graph/badge.svg)](https://codecov.io/gh/HewlettPackard/c-spiffe)

![GitHub release (latest by date)](https://img.shields.io/github/v/release/HewlettPackard/c-spiffe)

## Introduction

[SPIFFE](https://spiffe.io/) stands for Security Identity Framework for Everyone and is a set for securely identifying system in dynamic and heterogeneous environment. Please refer to [SPIFFE Documentation](https://spiffe.io/docs/latest/spiffe-about/overview/) for more information.  

C-spiffe is an extension for Spiffe that allows any [workload](https://spiffe.io/docs/latest/spiffe-about/spiffe-concepts/#workload) written C, C++ or  any language that supports loading a .so library, access [Workload API](https://spiffe.io/docs/latest/spiffe-about/spiffe-concepts/#spiffe-workload-api) and establish a mTLS connection with other workloads.  

The image above shows an example, where a C/C++ Workload imports the c-spiffe library in order to fetch a [SVID](https://spiffe.io/docs/latest/spiffe-about/spiffe-concepts/#spiffe-verifiable-identity-document-svid) and use it to establish a mTLS connection with another Workload, which can be implemented in another language, provided it follows the SPIFFE standard.

![Alt text](img/cspiffe_example.png "C-spiffe usage example")

### Motivation

Even though there is an official [c-spiffe](https://github.com/spiffe/c-spiffe) library, we started this one from scratch. We wanted a C implementation (not C++) for better compatibility. We also based most of the design decisions on [go-spiffe](https://github.com/spiffe/go-spiffe), which is the offical supported extension by the Spiffe Community.

## Project structure

### Folders

The project folder structure is described as follows:

* **bundle** Source code for bundle module

* **cmake** Configuration for cmake build

* **docker** Configuration files for container used to build this lib

* **img** Images files for documentations

* **infra** Container orchestration for tests environment

* **integration_test** Source code for automated test

* **internal** Souce code for internal module

* **protos** Source code for gRPC protos

* **spiffeid** Sour code for spiffeid module

* **spiffetls** Source code for spiffetls module

* **svid** Source code for SVID module

* **utils** Source code for utility functions

* **workload** Source code for workload

### Remarkable files

* [CMakeList.txt](CMakeLists.txt) Main build configuration file. Each source folder also has its own CMake file.

* [README.md](README.md) This README.

* [LICENSE](LICENSE) Project license.

* [BUILDING.md](BUILDING.md) Instructions on how to build c-spiffe in your system.

* [CONTRIBUTING.md](CONTRIBUTING.md) Guidelines for contributing to c-spiffe project.

* [MODULES.md](MODULES.md) Short description on each module of c-spiffe and dependency diagram.

* [MINIMAL INSTALLATION](MINOR-INSTALLATION.md) Minimal Installation.

## Using C-Spiffe

### Installing

#### Install from source

Reffer to [BUILDING.md](BUILDING.md)

#### Install on system

We are planning on delivering package for the most popular Linux distros, but at this moment, only building from source is supported.

### Basic usage

Refer to [Examples](workload/EXAMPLE.md) for more information.

## Initial Contributors

* Ariana Lima

* Débora Silva

* Glaucimar Aguiar

* Marcus Silva

* Otávio Silva

* Rodrigo Carvalho

* Thiago Jamir

* Willian Alves

## Contributing

Refer to [Contributing](CONTRIBUTING.md) for more information.