base on null # Tesla Vehicle Command SDK [](https://pkg.go.dev/github.com/teslamotors/vehicle-command/pkg) [](https://github.com/teslamotors/vehicle-command/actions/workflows/build.yml) [](https://github.com/teslamotors/vehicle-command/tags) [](https://hub.docker.com/r/tesla/vehicle-command/tags) Tesla vehicles now support a protocol that provides end-to-end command authentication. This Golang package uses the new protocol to control vehicle functions, such as climate control and charging. Among the included tools is an HTTP proxy server that converts REST API calls to the new vehicle-command protocol. Some developers may be familiar with Tesla's Owner API. Owner API will stop working as vehicles begin requiring end-to-end command authentication. If you are one of these developers, you can set up the proxy server or refactor your application to use this library directly. Pre-2021 Model S and X vehicles do not support this new protocol. [Fleet API](https://developer.tesla.com/docs/fleet-api/getting-started/what-is-fleet-api) will continue to work on these vehicles. ## System overview Command authentication takes place in two steps: 1. Tesla's servers will only forward messages to a vehicle if the client has a valid [OAuth token](https://oauth.net/2/). 2. The vehicle will only execute the command if it can be authenticated using a public key from the vehicle's keychain. So in order to send a command to a vehicle, a third-party application must obtain a valid OAuth token from the user, and the user must enroll the application's public key in the vehicle. Tesla's website has [instructions for obtaining OAuth tokens](https://developer.tesla.com/docs/fleet-api/authentication/third-party-tokens). This README has instructions for generating private keys and directing the user to the public-key enrollment flow. The tools in this repository can use the OAuth token and the private key to send commands to vehicles. For example, the repository includes a [command-line interface](cmd/tesla-control/README.md): ```bash tesla-control -ble -key-file private_key.pem lock ``` And a REST API proxy server (which is provided with a private key on launch and uses OAuth tokens sent by clients): ``` curl --cacert cert.pem \ --header 'Content-Type: application/json' \ --header "Authorization: Bearer $TESLA_AUTH_TOKEN" \ --data '{}' \ "https://localhost:4443/api/1/vehicles/$VIN/command/door_lock" ``` ## Installation and configuration ### Installing locally Requirements: * You've [installed Golang](https://go.dev/doc/install). The package was tested with Go 1.23.0. * You're using macOS or Linux. (Everything except BLE should run on Windows, but Windows is not officially supported). Installation steps: 1. Download dependencies: `go get ./...` 1. Compile tools and examples: `go build ./...` 1. Install tools to your PATH: `go install ./...` The final command installs the following utilities: * **tesla-keygen**: Generate a command-authentication private key and save it to your system keyring. * **tesla-control**: Send commands to a vehicle over BLE or the Internet. See [tool's README file](cmd/tesla-control/README.md) for more information. * **tesla-http-proxy**: An HTTP proxy that exposes a REST API for sending vehicle commands. * **tesla-auth-token**: Write an OAuth token to your system keyring. This utility does not fetch tokens. Read the [Fleet API documentation](https://developer.tesla.com/docs/fleet-api/authentication/third-party-tokens) for information on fetching OAuth tokens. ### Installing with Docker A Docker image is available for running these tools. The image defaults to running the HTTP proxy, but the `--entrypoint` flag changes the tool to be used. Run the image from Docker hub: ```bash docker pull tesla/vehicle-command:latest docker run tesla/vehicle-command:latest --help # running a different tool docker run --entrypoint tesla-control tesla/vehicle-command:latest --help ``` An example [docker-compose.yml](./docker-compose.yml) file is also provided. ```bash docker compose up ``` ### Configuration The following environment variables can used in lieu of command-line flags. * `TESLA_KEY_NAME` used to derive the entry name for your command authentication private key in your system keyring. * `TESLA_TOKEN_NAME` used to derive the entry name for your OAuth token in your system keyring. * `TESLA_KEYRING_TYPE` used override the default system keyring type for your OS. Run `tesla-keygen -h` to see supported values listed in the `-keyring-type` flag documentation. Consult [keyring documentation](https://github.com/99designs/keyring/#readme) for details on each option. * `TESLA_VIN` specifies a vehicle identification number. You can find your VIN under Controls > Software in your vehicle's UI. (Despite the name, VINs contain both letters and numbers). * `TESLA_CACHE_FILE` specifies a file that caches session information. The cache allows programs to skip sending handshake messages to a vehicle. This reduces both latency and the number of Fleet API calls a client makes when reconnecting to a vehicle after restarting. This is particularly helpful when using `tesla-control`, which restarts on each invocation. * `TESLA_HTTP_PROXY_TLS_CERT` specifies a TLS certificate file for the HTTP proxy. * `TESLA_HTTP_PROXY_TLS_KEY` specifies a TLS key file for the HTTP proxy. * `TESLA_HTTP_PROXY_HOST` specifies the host for the HTTP proxy. * `TESLA_HTTP_PROXY_PORT` specifies the port for the HTTP proxy. * `TESLA_HTTP_PROXY_TIMEOUT` specifies the timeout for the HTTP proxy to use when contacting Tesla servers. * `TESLA_VERBOSE` enables verbose logging. Supported by `tesla-control` and `tesla-http-proxy`. For example: ```bash export TESLA_KEY_NAME=$(whoami) export TESLA_TOKEN_NAME=$(whoami) export TESLA_CACHE_FILE=~/.tesla-cache.json ``` At this point, you're ready to go use the [the command-line tool](cmd/tesla-control) to start sending commands to your personal vehicle over BLE! Alternatively, continue reading below to learn how to build an application that can send commands over the Internet using a REST API. ## Using the HTTP proxy This section describes how to set up and use the HTTP proxy, which allows clients to send vehicle commands using a REST API. As discussed above, your HTTP proxy will need to authenticate both with Tesla (using OAuth tokens) and with individual vehicles (using a private key). ### Obtaining OAuth access tokens Tesla's servers require your client to provide an OAuth access token before they will forward commands to a vehicle. You must obtain the OAuth token from the vehicle's owner. See [Tesla's website](https://developer.tesla.com/docs/fleet-api/getting-started/what-is-fleet-api) for instructions on registering a developer account and obtaining OAuth tokens. ### Generating a command-authentication private key Even if your client has a valid token, the vehicle only accepts commands that are authorized by your client's private key. The `tesla-keygen` utility included in this repository generates a private key, stores it in your system keyring, and prints the corresponding public key: ``` export TESLA_KEY_NAME=$(whoami) tesla-keygen create > public_key.pem ``` The system keyring uses your OS-dependent credential storage as the system keyring. On macOS, for example, it defaults to using your login keychain. Run `tesla-keygen -h` for more options. Re-running the `tesla-keygen` command will print out the same public key without overwriting the private key. You can force the utility to overwrite an existing public key with `-f`. ### Distributing your public key Vehicles verify commands using public keys. Your public key must be enrolled on your users' vehicles before they will accept commands sent by your application. Here's the enrollment process from the owner's perspective: 1. Your website or app provides a link, as described below. 2. The user taps the link, which opens the Tesla app. 3. The Tesla app asks the user to approve the request. 4. If the user approves, then the Tesla app sends a command to the vehicle to enroll your public key. This requires the vehicle to be online and paired with the phone. In order for this process to work, you must register a domain name that identifies your application. The Tesla app will display this domain name to the user when it asks if they wish to approve your request, and the vehicle will display the domain name next to the key in the Locks screen. Follow the instructions to [register your public key and domain](https://developer.tesla.com/docs/fleet-api/endpoints/partner-endpoints#register). The public key referred to in those instructions is the `public_key.pem` file in the above example. Once your public key is successfully registered, provide vehicle owners with a link to `https://tesla.com/_ak/<your_domain_name>`. For example, if you registered `example.com`, provide a link to `https://tesla.com/_ak/example.com`. The official Tesla iPhone or Android mobile app (version 4.27.3 or above) will handle the rest. Customers with more than one Tesla product must select the desired vehicle before clicking the link or scanning the QR code. ### Generating a server TLS key and certificate The HTTP Proxy requires a TLS server certificate. For testing and development purposes, you can create a self-signed localhost server certificate using OpenSSL: ``` mkdir config openssl req -x509 -nodes -newkey ec \ -pkeyopt ec_paramgen_curve:secp384r1 \ -pkeyopt ec_param_enc:named_curve \ -subj '/CN=localhost' \ -keyout config/tls-key.pem -out config/tls-cert.pem -sha256 -days 3650 \ -addext "extendedKeyUsage = serverAuth" \ -addext "keyUsage = digitalSignature, keyCertSign, keyAgreement" ``` This command creates an unencrypted private key, `config/tls-key.pem`. The proxy server requires TLS. We do not offer an option to disable TLS because this greatly increases the risk of non-experts creating insecure deployments. Expert users who need a non-TLS version can create one without forking the repository by using [pkg/proxy](https://pkg.go.dev/github.com/teslamotors/vehicle-command/pkg/proxy); the [proxy source code](cmd/tesla-http-proxy/main.go) may be a helpful starting point. ### Running the proxy server The proxy server can be run using the following command: ```bash tesla-http-proxy -tls-key config/tls-key.pem -cert config/tls-cert.pem -key-file config/fleet-key.pem -port 4443 ``` It can also be run using Docker: ```bash # option 1: using docker run docker pull tesla/vehicle-command:latest docker run --security-opt=no-new-privileges:true -v ./config:/config -p 127.0.0.1:4443:4443 tesla/vehicle-command:latest -tls-key /config/tls-key.pem -cert /config/tls-cert.pem -key-file /config/fleet-key.pem -host 0.0.0.0 -port 4443 # option 2: using docker compose docker compose up ``` *Note:* In production, you'll likely want to omit the `-port 4443` and listen on the standard port 443. ### Sending commands to the proxy server This section illustrates how clients can reach the server using `curl`. Clients are responsible for obtaining OAuth tokens. Obtain an OAuth token as described as above. Endpoints that do not support end-to-end authentication are proxied to Tesla's REST API: ```bash export TESLA_AUTH_TOKEN=<access-token> export VIN=<vin> curl --cacert cert.pem \ --header "Authorization: Bearer $TESLA_AUTH_TOKEN" \ "https://localhost:4443/api/1/vehicles/$VIN/vehicle_data" \ | jq -r . ``` Endpoints that support end-to-end authentication are intercepted and re-written by the proxy, which handles session state and retries. After copying `cert.pem` to your client, running the following command from a client will cause the proxy to send a `flash_lights` command to the vehicle: ```bash export TESLA_AUTH_TOKEN=<access-token> export VIN=<vin> curl --cacert cert.pem \ --header 'Content-Type: application/json' \ --header "Authorization: Bearer $TESLA_AUTH_TOKEN" \ --data '{}' \ "https://localhost:4443/api/1/vehicles/$VIN/command/flash_lights" ``` The flow to obtain `$TESLA_AUTH_TOKEN`:  A command's flow through the system:  ### REST API documentation The HTTP proxy implements the [Tesla Fleet API vehicle command endpoints](https://developer.tesla.com/docs/fleet-api/endpoints/vehicle-commands). Legacy clients written for Owner API may be using a vehicle's Owner API ID when constructing URL paths. The proxy server requires clients to use the VIN directly, instead. ## Using the Golang library You can read package [documentation on pkg.go.dev](https://pkg.go.dev/github.com/teslamotors/vehicle-command/pkg). This repository supports `go mod` and follows [Go version semantics](https://go.dev/doc/modules/version-numbers). Note that v0.x.x releases do not guarantee API stability. ", Assign "at most 3 tags" to the expected json: {"id":"5303","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"