1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
# Google Proxies for Enterprise Certificates (Preview)
## Certificate-based-access
If you use [certificate-based access][cba] to protect your Google Cloud resources, the end user [device certificate][clientcert] is one of the credentials that is verified before access to a resource is granted. You can configure Google Cloud to use the device certificates in your operating system key store when verifying access to a resource from the gcloud CLI or Terraform by using the enterprise certificates feature.
## Google Enterprise Certificate Proxies (ECP)
Google Enterprise Certificate Proxies (ECP) are part of the [Google Cloud Zero Trust architecture](zerotrust) that enables mutual authentication with [client-side certificates][clientcert]. This repository contains a set of proxies/modules that can be used by clients or toolings to interact with certificates that are stored in [protected key storage systems][keystore].
To interact the client certificates, application code should not need to use most of these proxies within this repository directly. Instead, the application should leverage the clients and toolings provided by Google such as [Cloud SDK](https://cloud.google.com/sdk) to have a more convenient developer experience.
## Compatibility
Currently ECP is in Preview stage and all the APIs and configurations are **subject to change**.
The following platforms/keystores are supported by ECP:
- MacOS: __Keychain__
- Linux: __PKCS#11__
## Prerequisites
Before using ECP with your application/client, you should follow the instructions [here](enterprisecert) to configure your enterprise certificate policies with Access Context Manager.
### Quick Start
1. Install [Openssl][openssl] and then add the OpenSSL installation path to your system path:
`brew install openssl@1.1`
1. Install gcloud CLI (Cloud SDK) at: https://cloud.google.com/sdk/docs/install
1. Download the ECP binary based on your OS from the latest [Github release](https://github.com/googleapis/enterprise-certificate-proxy/releases).
1. Unzip the downloaded zip and move all the binaries into the following directory:
- Linux/MacOS: `~/.config/gcloud/enterprise_cert`
1. If you are on Linux, skip this step since you will be using the bundled Python by default. If you are on MacOS, you need to do the following steps:
- Enable gcloud virtual Python environment:
`gcloud config virtualenv create`
`gcloud config virtualenv enable`
- Install dependencies for your virtual environment:
`~/.config/gcloud/virtenv/bin/python3 -m pip install cryptography==36.0.2`
`~/.config/gcloud/virtenv/bin/python3 -m pip install pyopenssl==22.0.0`
1. Create a new JSON file at `.config/gcloud/certificate_config.json`:
- Alternatively you can put the JSON in the location of your choice and set the path to it using:
`$ gcloud config set context_aware/enterprise_certificate_config_file_path "<json file path>"`.
- Another approach for setting the JSON file location is setting the location with the `GOOGLE_API_CERTIFICATE_CONFIG` environment variable.
1. Update the `certificate_config.json` file with details about the certificate (See [Configuration](#certificate-configutation) section for details.)
1. Enable usage of client certificates through gcloud CLI config command:
```
gcloud config set context_aware/use_client_certificate true
```
1. You can now use gcloud to access GCP resources with mTLS.
### Certificate Configuration
ECP relies on the `certificate_config.json` file to read all the metadata information for locating the certificate. The contents of this JSON file look like the following:
#### MacOS (Keychain)
```json
{
"cert_configs": {
"macos_keychain": {
"issuer": "YOUR_CERT_ISSUER"
}
},
"libs": {
"ecp": "[YOUR_FULL_HOME_PATH]/.config/gcloud/enterprise_cert/ecp",
"ecp_client": "[YOUR_FULL_HOME_PATH]/.config/gcloud/enterprise_cert/libecp.dylib",
"tls_offload": "[YOUR_FULL_HOME_PATH]/.config/gcloud/enterprise_cert/libtls_offload.dylib"
},
"version": 1
}
```
#### Windows (MyStore)
```json
{
"cert_configs": {
"windows_store": {
"store": "MY",
"provider": "current_user",
"issuer": "YOUR_CERT_ISSUER"
}
},
"libs": {
"ecp": "%AppData%/gcloud/enterprise_cert/ecp.exe",
"ecp_client": "%AppData%/gcloud/enterprise_cert/libecp.dll",
"tls_offload": "%AppData%/gcloud/enterprise_cert/libtls_offload.dll"
},
"version": 1
}
```
#### Linux (PKCS#11)
```json
{
"cert_configs": {
"pkcs11": {
"label": "YOUR_TOKEN_LABEL",
"user_pin": "YOUR_PIN",
"slot": "YOUR_SLOT",
"module": "The PKCS #11 module library file path"
}
},
"libs": {
"ecp": "[YOUR_FULL_HOME_PATH]/.config/gcloud/enterprise_cert/ecp",
"ecp_client": "[YOUR_FULL_HOME_PATH]/.config/gcloud/enterprise_cert/libecp.so",
"tls_offload": "[YOUR_FULL_HOME_PATH]/.config/gcloud/enterprise_cert/libtls_offload.so"
},
"version": 1
}
```
## Build binaries
For amd64 MacOS, run `./build/scripts/darwin_amd64.sh`. The binaries will be placed in `build/bin/darwin_amd64` folder.
For amd64 Linux, run `./build/scripts/linux_amd64.sh`. The binaries will be placed in `build/bin/linux_amd64` folder.
For amd64 Windows, in powershell terminal, run `.\build\scripts\windows_amd64.ps1`. The binaries will be placed in `build\bin\windows_amd64` folder.
Note that gcc is required for compiling the Windows shared library. The easiest way to get gcc on Windows is to download Mingw64, and add "gcc.exe" to the powershell path.
## Contributing
Contributions to this library are always welcome and highly encouraged. See the [CONTRIBUTING](contributing) documentation for more information on how to get started.
## License
Apache - See [LICENSE](license) for more information.
[cba]: https://cloud.google.com/beyondcorp-enterprise/docs/securing-resources-with-certificate-based-access
[clientcert]: https://en.wikipedia.org/wiki/Client_certificate
[openssl]: https://wiki.openssl.org/index.php/Binaries
[keystore]: https://en.wikipedia.org/wiki/Key_management
[cloudsdk]: https://cloud.google.com/sdk
[contributing]: ./CONTRIBUTING.md
[license]:./LICENSE.md
[enterprisecert]: https://cloud.google.com/access-context-manager/docs/enterprise-certificates
|
