device_id.go

// Copyright © 2019 Ispirata Srl
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package utils

import (
	"encoding/base64"
	"fmt"
	"os"

	"github.com/astarte-platform/astarte-go/misc"

	"github.com/google/uuid"
	"github.com/spf13/cobra"
)

var deviceIDCmd = &cobra.Command{
	Use:   "device-id",
	Short: "Various operations on Device IDs",
}

var validateDeviceIDCmd = &cobra.Command{
	Use:   "validate <device_id>",
	Short: "Validates a device ID",
	Long: `Checks whether the provided string is a valid Device ID.

Returns 0 and does not print anything if the ID is valid, returns 1 and prints an error message if it isn't.`,
	Example: `  astartectl utils device-id validate 2TBn-jNESuuHamE2Zo1anA`,
	Args:    cobra.ExactArgs(1),
	RunE:    validateDeviceIDF,
}

var generateRandomDeviceIDCmd = &cobra.Command{
	Use:     "generate-random",
	Short:   "Generates a random Astarte Device ID",
	Long:    `Outputs a valid, random Astarte Device ID.`,
	Example: `  astartectl utils device-id generate-random`,
	RunE:    generateRandomDeviceIDF,
}

var computeDeviceIDFromStringCmd = &cobra.Command{
	Use:   "compute-from-string <namespace_uuid> <string_data>",
	Short: "Computes an Astarte device ID from a UUID and an arbitrary data from a string",
	Long: `Computes a deterministic Astarte device ID using a namespace and arbitrary data from a string.

This leverages UUIDv5 to generate a reproducible ID everytime. A valid UUIDv5 is generated starting from the
supplied data, and it's then encoded into a valid Astarte Device ID. This command is guaranteed to return always
the same ID upon providing the same namespace and data.`,
	Example: `  astartectl utils device-id compute-from-string f79ad91f-c638-4889-ae74-9d001a3b4cf8 myidentifierdata`,
	Args:    cobra.ExactArgs(2),
	RunE:    computeDeviceIDFromStringF,
}

var computeDeviceIDFromBytesCmd = &cobra.Command{
	Use:   "compute-from-bytes <namespace_uuid> <base64_encoded_data>",
	Short: "Computes an Astarte device ID from a UUID and an arbitrary bytearray, encoded in Base64",
	Long: `Computes a deterministic Astarte device ID using a namespace and arbitrary data from a string.

This leverages UUIDv5 to generate a reproducible ID everytime. A valid UUIDv5 is generated starting from the
supplied data, and it's then encoded into a valid Astarte Device ID.

The supplied data must be encoded with Base64 standard encoding. Any input not following this specification will
be rejected.

This command is guaranteed to return always the same ID upon providing the same namespace and data.`,
	Example: `  astartectl utils device-id compute-from-bytes f79ad91f-c638-4889-ae74-9d001a3b4cf8 "bXlpZGVudGlmaWVyZGF0YQ=="`,
	Args:    cobra.ExactArgs(2),
	RunE:    computeDeviceIDFromBytesF,
}

var toUUIDDeviceIDCmd = &cobra.Command{
	Use:   "to-uuid <device_id>",
	Short: "Prints the UUID representation of a device ID",
	Long: `Prints the UUID representation of a device ID.
This is useful to interact with Cassandra, where the Device ID is saved as UUID.`,
	Example: `  astartectl utils device-id to-uuid 2TBn-jNESuuHamE2Zo1anA`,
	Args:    cobra.ExactArgs(1),
	RunE:    toUUIDDeviceIDF,
}

var fromUUIDDeviceIDCmd = &cobra.Command{
	Use:   "from-uuid <device_id>",
	Short: "Prints the Device ID representation of the given UUID",
	Long: `Prints the Device ID representation of the given UUID",
This is useful to interact with Cassandra, where the Device ID is saved as UUID.`,
	Example: `  astartectl utils device-id from-uuid d93067fa-3344-4aeb-876a-6136668d5a9c`,
	Args:    cobra.ExactArgs(1),
	RunE:    fromUUIDDeviceIDF,
}

func init() {
	UtilsCmd.AddCommand(deviceIDCmd)

	deviceIDCmd.AddCommand(
		validateDeviceIDCmd,
		generateRandomDeviceIDCmd,
		computeDeviceIDFromStringCmd,
		computeDeviceIDFromBytesCmd,
		toUUIDDeviceIDCmd,
		fromUUIDDeviceIDCmd,
	)
}

func validateDeviceIDF(command *cobra.Command, args []string) error {
	deviceID := args[0]
	if misc.IsValidAstarteDeviceID(deviceID) {
		fmt.Println("Valid")
		return nil
	}

	fmt.Fprintf(os.Stderr, "%s is not a valid Astarte Device ID\n", deviceID)
	os.Exit(1)
	return nil
}

func generateRandomDeviceIDF(command *cobra.Command, args []string) error {
	deviceID, err := misc.GenerateRandomAstarteDeviceID()
	if err != nil {
		return err
	}

	fmt.Println(deviceID)
	return nil
}

func computeDeviceIDFromStringF(command *cobra.Command, args []string) error {
	namespaceUUID := args[0]
	stringData := args[1]
	deviceID, err := misc.GetNamespacedAstarteDeviceID(namespaceUUID, []byte(stringData))
	if err != nil {
		return err
	}

	fmt.Println(deviceID)
	return nil
}

func computeDeviceIDFromBytesF(command *cobra.Command, args []string) error {
	namespaceUUID := args[0]
	bytesData := args[1]
	actualBytes, err := base64.StdEncoding.DecodeString(bytesData)
	if err != nil {
		return err
	}

	deviceID, err := misc.GetNamespacedAstarteDeviceID(namespaceUUID, actualBytes)
	if err != nil {
		return err
	}

	fmt.Println(deviceID)
	return nil
}

func toUUIDDeviceIDF(command *cobra.Command, args []string) error {
	deviceID := args[0]
	if !misc.IsValidAstarteDeviceID(deviceID) {
		fmt.Fprintf(os.Stderr, "%s is not a valid Astarte Device ID\n", deviceID)
		os.Exit(1)
	}

	deviceUUID, err := misc.DeviceIDToUUID(deviceID)
	if err != nil {
		return err
	}

	fmt.Println(deviceUUID)
	return nil
}

func fromUUIDDeviceIDF(command *cobra.Command, args []string) error {
	deviceUUID := args[0]
	_, err := uuid.Parse(deviceUUID)
	if err != nil {
		fmt.Fprintf(os.Stderr, "%s is not a valid UUID\n", deviceUUID)
		os.Exit(1)
	}

	deviceID, err := misc.UUIDToDeviceID(deviceUUID)
	if err != nil {
		return err
	}

	fmt.Println(deviceID)
	return nil
}