appledev

README

go-appledev

A library & command line application for generating the signed developer tokens used to authenticate against Apple REST APIs. A valid signed JWT token is constructed using your private key, key ID, team ID, and service ID.

go-appledev is an open source project not affiliated with Apple Inc.

Locating your identifiers:

• Key ID: An identifier associated with your private key. It can be found on the Certificates, Identifiers & Profiles page under Keys. Click on the appropriate key to view the ID.
• Team ID: Found on the account page under Membership details.
• Service ID: Found on the Certificates, Identifiers & Profiles page under Identifiers. Make sure "Services IDs" is selected from the dropdown.

CLI usage:

Precompiled binaries are available on the Releases page.

Usage of ./appledev:
  token         Create an apple developer token.
  config        Generate a config file.
  version       Print the version of this application.

Usage of ./appledev token:
  -c string
        Path to a json config file containing args.
  -d duration
        How long the token will be valid for. (default 30m0s)
  -kid string
        (required) The Key ID associated with your private key.
  -pk string
        (required) The path to a file containing your PEM encoded private key.
  -sid string
        (required) The Service ID from your developer account.
  -tid string
        (required) The Team ID from your developer account.

Generate a token:

./appledev token -pk AuthKey_ABCDE12345.p8 -kid keyId -sid serviceId -tid teamId

Duration d is an optional time.Duration string for when the token will expire from now. Paraphrasing the Go documentation, it may contain a sequence of decimal numbers, each with an optional fraction and a unit suffix, such as "30m", "1.5h" or "2h45m". Valid time units are "ms", "s", "m", "h", "d", "w", "y".

Config file

A JSON config file may be used in place of args. The easiest way to create a config file is to provide your private key to ./appledev config. This way, the private key will be properly formatted with newlines.

./appledev config -pk AuthKey_ABCDE12345.p8 -o appledev_config.json

appledev_config.json:

{
  "kid": "key ID",
  "tid": "team ID",
  "sid": "service ID",
  "d": "10m",
  "pk": "-----BEGIN PRIVATE KEY-----\n-----END PRIVATE KEY-----"
}

Generate a token using a config file:

./appledev token -c appledev_config.json

CLI args provided in addition to -c will take precedence over their value in the config file.

Library usage:

This project may imported as a Go module for token generation on the fly.

import (
  "github.com/shawntoffel/go-appledev"
)

// Initialize the API token provider.
tokenProvider := appledev.ApiTokenProvider{
  KeyID:     "keyId",
  TeamID:    "teamId",
  ServiceID: "serviceId",
  Duration:  time.Minute * 30,
}

// Fetch your private key bytes. 
bytes, err := os.ReadFile(privateKeyFilePath)

// Generate a signed JWT string.
token, err := tokenProvider.SignedJWT(bytes)

Troubleshooting

Please use the GitHub Discussions tab for questions regarding this client library.

Documentation

Index

• type ApiTokenProvider
  • func (g *ApiTokenProvider) SignedJWT(pemBytes []byte) (string, error)

Types

type ApiTokenProvider

type ApiTokenProvider struct {
	// KeyID is the Key identifier from your developer accoung.
	KeyID string

	// TeamID is the Team ID from your developer accoung.
	TeamID string

	// ServiceID is the Service ID from your developer accoung.
	ServiceID string

	// Duration is how long the token will be valid for.
	Duration time.Duration
}

TokenProvider generates authentication tokens for apple REST APIs.

func (*ApiTokenProvider) SignedJWT

func (g *ApiTokenProvider) SignedJWT(pemBytes []byte) (string, error)

GenerateSignedJWT generates a valid JWT signed with your PEM private key.