agent

Documentation

Overview

Copyright 2014 AdRoll, 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.

Copyright 2014 AdRoll, 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.

Copyright 2014 AdRoll, 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.

Copyright 2014 AdRoll, 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.

Copyright 2014 AdRoll, 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.

Copyright 2014 AdRoll, 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.

Index

• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func NewCliHandler(address string, client Client) *cliHandler
• func NewClient(connectionString string, cr CredentialsReceiver) *client
• func NewCredentialsExpirationManager() *credentialsExpirationManager
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• func SSHSetAgentSock(socketAddressFromCli string, sshKeyFromCli []byte)
• func SSHSign(challenge []byte, skip int) (*ssh.Signature, error)
• type Client
• type CredentialsReceiver
• type CredentialsSource
• type MetadataService
  • func NewMetadataService(listener net.Listener, creds CredentialsSource) (MetadataService, error)
• type Service

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func NewCliHandler

func NewCliHandler(address string, client Client) *cliHandler

func NewClient

func NewClient(connectionString string, cr CredentialsReceiver) *client

func NewCredentialsExpirationManager

func NewCredentialsExpirationManager() *credentialsExpirationManager

func RestoreAsset

func RestoreAsset(dir, name string) error

Restore an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

Restore assets under the given directory recursively

func SSHSetAgentSock

func SSHSetAgentSock(socketAddressFromCli string, sshKeyFromCli []byte)

func SSHSign

func SSHSign(challenge []byte, skip int) (*ssh.Signature, error)

SSHSign signs the provided challenge using a key from the ssh-agent keyring. The key is chosen by enumerating all keys, then skipping the requested number of keys.

Types

type Client

type Client interface {
	AssumeRole(role string) error
	GetUserCredentials() error
}

type CredentialsReceiver

type CredentialsReceiver interface {
	SetCredentials(*sts.Credentials, string)
	SetClient(Client)
}

type CredentialsSource

type CredentialsSource interface {
	GetCredentials() (*sts.Credentials, error)
}

type MetadataService

type MetadataService interface {
	Service
	Port() int
}

MetadataService extends Service to include information about public port numbers for testing purposes.

func NewMetadataService

func NewMetadataService(listener net.Listener, creds CredentialsSource) (MetadataService, error)

NewMetadataService returns a properly-initialized metadataService for use.

type Service

type Service interface {
	/*
		Start should create any resources that the service requires,
		including background goroutines that service requests through
		the Service's public API.
	*/
	Start() error

	/*
		If any special cleanup needs to occur for this Service to cleanly
		shut down, it should be implemented here.
	*/
	Stop() error
}

Service implements background workers and servers.