Merge pull request #652 from ericchiang/dev-docs-api

Documentation: add document on the dex API
2016-10-31 18:16:08 -07:00 · 2016-10-31 18:16:08 -07:00 · 1c51c50b23
commit 1c51c50b23
parent 651b406cfd fe1d27586e
1 changed files with 113 additions and 0 deletions
--- a/Documentation/api.md
+++ b/Documentation/api.md
@ -0,0 +1,113 @@
+# The dex API
+
+Dex provides a [gRPC][grpc] service for programmatic modification of dex's state. The API is intended too expose hooks for management applications and is not expected to be used by most installations.
+
+This document is an overview of how to interact with the API.
+
+## Configuration
+
+Admins that wish to expose the gRPC service must add the following entry to the dex config file. This option is off by default.
+
+```
+grpc:
+  # Cannot be the same address as an HTTP(S) service.
+  addr: 127.0.0.1:5557
+  # Server certs. If TLS credentials aren't provided dex will generate self-signed ones.
+  tlsCert: /etc/dex/grpc.crt
+  tlsKey: /etc/dex/grpc.key
+```
+
+## Generating clients
+
+gRPC is a suite of tools for generating client and server bindings from a common declarative language. The canonical schema for dex's API can be found in the source tree at [`api/api.proto`][api-proto]. Go bindings are generated and maintained in the same directory for internal use.
+
+To generate a client for your own project install [`protoc`][protoc], install a protobuf generator for your project's language, and download the `api.proto` file. An example for a Go project:
+
+```
+# Install protoc-gen-go.
+$ go get -u github.com/golang/protobuf/{proto,protoc-gen-go}
+
+# Download api.proto for a given version.
+$ DEX_VERSION=v2.0.0-alpha.5
+$ wget https://raw.githubusercontent.com/coreos/dex/${DEX_VERSION}/api/api.proto
+
+# Generate the Go client bindings.
+$ protoc --go_out=import_path=dexapi:. api.proto
+```
+
+Client programs can then be written using the generated code. A Go client which uses dex's internally generated code might look like the following:
+
+__NOTE:__ Because dex has the `google.golang.org/grpc` package in its `vendor` directory, gRPC code in `github.com/coreos/dex/api` refers to the vendored copy, not copies in a developers GOPATH. Clients must either regenerate the gRPC Go code or vendor dex and remove its `vendor` directory to run this program.
+
+```
+package main
+
+import (
+    "context"
+    "fmt"
+    "log"
+
+    "github.com/coreos/dex/api"
+    "google.golang.org/grpc"
+    "google.golang.org/grpc/credentials"
+)
+
+func newDexClient(hostAndPort, caPath string) (api.DexClient, error) {
+    creds, err := credentials.NewClientTLSFromFile(caPath, "")
+    if err != nil {
+        return nil, fmt.Errorf("load dex cert: %v", err)
+    }
+
+    conn, err := grpc.Dial(hostAndPort, grpc.WithTransportCredentials(creds))
+    if err != nil {
+        return nil, fmt.Errorf("dail: %v", err)
+    }
+    return api.NewDexClient(conn), nil
+}
+
+func main() {
+    client, err := newDexClient("127.0.0.1:5557", "/etc/dex/grpc.crt")
+    if err != nil {
+        log.Fatalf("failed creating dex client: %v ", err)
+    }
+
+    req := &api.CreateClientReq{
+        Client: &api.Client{
+            Id:           "example-app",
+            Name:         "Example App",
+            Secret:       "ZXhhbXBsZS1hcHAtc2VjcmV0",
+            RedirectUris: []string{"http://127.0.0.1:5555/callback"},
+        },
+    }
+
+    if _, err := client.CreateClient(context.TODO(), req); err != nil {
+        log.Fatalf("failed creating oauth2 client: %v", err)
+    }
+}
+```
+
+## Authentication and access control
+
+The dex API does not provide any authentication or authorization beyond TLS client auth.
+
+Projects that wish to add access controls on top of the existing API should build apps which perform such checks. For example to provide a "Change password" screen, a client app could use dex's OpenID Connect flow to authenticate an end user, then call dex's API to update that user's password.
+
+## dexctl?
+
+Dex does not ship with a command line tool for interacting with the API. Command line tools are useful but hard to version, easy to design poorly, and expose another interface which can never be changed in the name of compatibility.
+
+While the dex team would be open to re-implementing `dexctl` for v2 a majority of the work is writing a design document, not the actual programming effort.
+
+## Why not REST or gRPC Gateway?
+
+Between v1 and v2, dex switched from REST to gRPC. This largely stemmed from problems generating documentation, client bindings, and server frameworks that adequately expressed REST semantics. While [Google APIs][google-apis], [Open API/Swagger][open-api], and [gRPC Gateway][grpc-gateway] were evaluated, they often became clunky when trying to use specific HTTP error codes or complex request bodies. As a result, v2's API is entirely gRPC.
+
+Many arguments _against_ gRPC cite short term convenience rather than production use cases. Though this is a recognized shortcoming, dex already implements many features for developer convenience. For instance, users who wish to manually edit clients during testing can use the `staticClients` config field instead of the API.
+
+[grpc]: http://www.grpc.io/
+[api-proto]: https://github.com/coreos/dex/blob/v2.0.0-alpha.5/api/api.proto
+[protoc]: https://github.com/google/protobuf/releases
+[protoc-gen-go]: https://github.com/golang/protobuf
+[google-apis]: https://github.com/google/apis-client-generator
+[open-api]: https://openapis.org/
+[grpc-gateway]: https://github.com/grpc-ecosystem/grpc-gateway