diag

Documentation

Index

• Variables
• type Credentials
• type ErrObfIncompat
  • func (e *ErrObfIncompat) Error() string

Variables

var (
	ErrObfTargetExist = errors.New("target exists, and overwrite flag not set")
	ErrObfSame        = errors.New("input and output are the same")
)

var CmdDiag = &base.Command{
	Run:       nil,
	Wizard:    nil,
	UsageLine: "slackdump tools",
	Short:     "diagnostic tools",
	Long: `
# Diagnostic tools

Tools command contains different tools, running which may be requested if you open an issue on Github.
`,
	CustomFlags: false,
	FlagMask:    0,
	PrintFlags:  false,
	RequireAuth: false,
	Commands: []*base.Command{
		CmdEdge,
		CmdEncrypt,
		CmdEzTest,
		CmdInfo,
		CmdObfuscate,
		CmdRawOutput,
		CmdUninstall,
		CmdRecord,
		cmdSearch,
		CmdThread,
		CmdWizDebug,
	},
}

CmdDiag is the diagnostic tool.

var CmdEdge = &base.Command{
	Run:         runEdge,
	UsageLine:   "slack tools edge",
	Short:       "Edge test",
	RequireAuth: true,
	HideWizard:  true,
	Long: `
# Slack Edge API test tool

Edge test attempts to call the Edge API with the provided credentials.
`,
}

var CmdEncrypt = &base.Command{
	Run:       runEncrypt,
	UsageLine: "slackdump tools encrypt [flags] file",
	Short:     "encrypts a file to post in github issues",
	Long: `
# Command Encrypt

Encrypt a file with the developer key to attach to a github issue or send
as a message.

It uses the assymetric encryption (GPG) to encrypt the file with the
developer key, and can only be decrypted by the developer.

## Usage

Encrypt a file to attach as a file to github issue:

	$ slackdump tools encrypt -a file

Encrypt a file to post as a message (for small files):

	$ slackdump tools encrypt -a file

`,
	FlagMask:   cfg.OmitAll,
	PrintFlags: true,
}

var CmdEzTest = &base.Command{
	Run:       runEzLoginTest,
	UsageLine: "slack tools eztest",
	Short:     "EZ-Login 3000 test",
	Long: `
# EZ-Login 3000 Test tool
Eztest attempts to start EZ Login 3000 on the device.

The browser will open, and you will be offered to login to the workspace of your
choice.  On successful login it outputs the json with the test results.

You will see "OK" in the end if there were no issues, otherwise an error will
be printed and the test will be terminated.
`,
	CustomFlags: true,
	PrintFlags:  true,
}

var CmdInfo = &base.Command{
	UsageLine: "slackdump tools info",
	Short:     "show information about Slackdump environment",
	Run:       runInfo,

	Long: `# Info Command
	
**Info** shows information about Slackdump environment, such as local system paths, etc.
`,
}

CmdInfo is the information command.

var CmdObfuscate = &base.Command{
	UsageLine: "slackdump tools obfuscate [options] [input] [output]",
	Short:     "obfuscate sensitive data in a slackdump recording",
	Long: `
# Obfuscate tool

Obfuscate tool obfuscates sensitive data in a slackdump chunk recording.

To record the API output into a chunk, you can run ` + "`slackdump tools record stream`" + `.
`,
	CustomFlags: true,
	PrintFlags:  true,
}

CmdObfuscate is the command to obfuscate sensitive data in a slackdump recording.

var CmdRawOutput = &base.Command{
	Run:       nil,
	UsageLine: "slackdump tools rawoutput [flags] <id>",
	Short:     "record raw API output",
	Long: `
# Rawoutput Tool

Rawoutput produces a log file with the raw API output (as received from Slack
API).

Running this tool may be requested by developers.

` + "`id`" + ` is the ID or URL of the workspace (for example ` + "`sdump` or `https://sdump.slack.com`)",
	CustomFlags: false,
	FlagMask:    cfg.OmitAll,
	PrintFlags:  true,
	RequireAuth: true,
	Commands:    nil,
	HideWizard:  true,
}

var CmdRecord = &base.Command{
	UsageLine:  "slackdump tools record",
	Short:      "chunk record commands",
	Commands:   []*base.Command{cmdRecordStream, cmdRecordState},
	HideWizard: true,
}

var CmdThread = &base.Command{
	Run:       nil,
	UsageLine: "slackdump tools thread [flags]",
	Short:     "thread utilities",
	Long: `
Thread is an utility that provides some useful functions for
testing, i.e. deletion of the threads, or generation of large threads.
`,
	FlagMask:    cfg.OmitAll,
	PrintFlags:  true,
	CustomFlags: true,
}

var CmdUninstall = &base.Command{
	UsageLine:   "slackdump tools uninstall",
	Short:       "performs uninstallation of components",
	RequireAuth: false,
	FlagMask:    cfg.OmitAll,
	Run:         runUninstall,
	PrintFlags:  true,
}

var CmdWizDebug = &base.Command{
	UsageLine:  "slackdump tools wizdebug",
	Short:      "run the wizard debug command",
	Run:        runWizDebug,
	PrintFlags: true,
}

Types

type Credentials

type Credentials struct {
	Token   string         `json:"token,omitempty"`
	Cookies []*http.Cookie `json:"cookie,omitempty"`
}

type ErrObfIncompat

type ErrObfIncompat struct {
	OutType string
	InType  string
	OutName string
	InName  string
}

func (*ErrObfIncompat) Error

func (e *ErrObfIncompat) Error() string