go-sdk

README

Lacework Go SDK

This repository provides a set of tools, libraries, relevant documentation, code samples, processes, and/or guides that allow users and developers to interact with the Lacework platform.

Find more information about this repository at the following Wiki page.

Lacework CLI (cli)

The Lacework Command Line Interface is a tool that helps you manage the Lacework cloud security platform. You can use it to manage compliance reports, external integrations, vulnerability scans, and other operations.

Install

Bash:

curl https://raw.githubusercontent.com/lacework/go-sdk/main/cli/install.sh | bash

Powershell:

Set-ExecutionPolicy Bypass -Scope Process -Force;
iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/lacework/go-sdk/main/cli/install.ps1'))

Homebrew:

brew install lacework/tap/lacework-cli

For more details, see Lacework Homebrew Tap.

Chocolatey:

choco install lacework-cli

For more details, see Lacework CLI Chocolatey.

Look at the cli/ folder for more information.

Lacework API Client (api)

A Golang API client for interacting with the Lacework API.

Basic Usage

package main

import (
	"fmt"
	"log"

	"github.com/lacework/go-sdk/api"
)

func main() {
	lacework, err := api.NewClient("account")
	if err != nil {
		log.Fatal(err)
	}

	tokenRes, err := lacework.GenerateTokenWithKeys("KEY", "SECRET")
	if err != nil {
		log.Fatal(err)
	}

	// Output: YOUR-ACCESS-TOKEN
	fmt.Println(tokenRes.Token())
}

Look at the api/ folder for more information.

Lacework Logger (lwlogger)

A Logger wrapper for Lacework based of zap logger Go package.

Basic Usage

package main

import "github.com/lacework/go-sdk/lwlogger"

func main() {
	lwL := lwlogger.New("INFO")

	// Output: {"level":"info","ts":"[timestamp]","caller":"main.go:9","msg":"interesting info"}
	lwL.Info("interesting info")
}

Look at the lwlogger/ folder for more information.

Lacework Updater (lwupdater)

A Go library to check for available updates of Lacework projects.

Basic Usage

package main

import (
	"fmt"

	"github.com/lacework/go-sdk/lwupdater"
)

func main() {
	var (
		project  = "go-sdk"
		sdk, err = lwupdater.Check(project, "v0.1.0")
	)

	if err != nil {
		fmt.Println("Unable to check for updates: %s", err)
	} else {
		// Output: The latest release of the go-sdk project is v0.1.7
		fmt.Printf("The latest release of the %s project is %s\n",
			project, sdk.LatestVersion,
		)
	}
}

Set the environment variable LW_UPDATES_DISABLE=1 to avoid checking for updates.

Lacework Config (lwconfig)

A Go library to help you manage the Lacework configuration file ($HOME/.lacework.toml)

Basic Usage

package main

import (
	"fmt"

	"github.com/lacework/go-sdk/lwconfig"
)

func main() {
	profiles, err := lwconfig.LoadProfiles()
	if err != nil {
		fmt.Printf("Unable to load profiles: %s\n", err)
	} else {
		fmt.Printf("You have '%d' profiles configured!\n", len(profiles))
	}
}

Look at the lwconfig/ folder for more information.

Lacework Domain (lwdomain)

Go package to disseminate a domain URL into account, cluster and whether or not it is an internal account.

Basic Usage

package main

import (
	"fmt"
	"os"

	"github.com/lacework/go-sdk/lwdomain"
)

func main() {
	domain, err := lwdomain.New("https://account.lacework.net")
	if err != nil {
		fmt.Printf("Error %s\n", err)
		os.Exit(1)
	}

	// Output: Lacework Account Name: account
	fmt.Println("Lacework Account Name: %s", domain.Account)
}

Release Process

The release process of this repository is documented at the following Wiki page.

Contributing

For guidelines on how to contribute to the project see the CONTRIBUTING.md

License and Copyright

Copyright 2020, Lacework Inc.

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.