Class SliverClient

Constructors

constructor

new SliverClient(config: SliverClientConfig): SliverClient
Parameters
- config: SliverClientConfig
Returns SliverClient
- Defined in client.ts:425

Properties

`Readonly`beacon$

beacon$: Observable<clientpb.Event> = ...

`Readonly`client$

client$: Observable<clientpb.Event & { Client: clientpb.Client }> = ...

`Readonly`config

config: SliverClientConfig

`Readonly`event$

event$: Observable<clientpb.Event> = ...

`Readonly`job$

job$: Observable<clientpb.Event & { Job: clientpb.Job }> = ...

`Readonly`session$

session$: Observable<clientpb.Event & { Session: clientpb.Session }> = ...

`Readonly`taskResult$

taskResult$: Observable<clientpb.Event> = ...

`Static` `Readonly`EVENT_BEACON_REGISTERED

EVENT_BEACON_REGISTERED: "beacon-registered"

`Static` `Readonly`EVENT_BEACON_TASKRESULT

EVENT_BEACON_TASKRESULT: "beacon-taskresult"

Accessors

isConnected

get isConnected(): boolean
Returns boolean
- Defined in client.ts:438

rpc

get rpc(): SliverRPCClient
Returns SliverRPCClient
- Defined in client.ts:431

Methods

beacons

beacons(timeoutSeconds?: number): Promise<clientpb.Beacon[]>
Parameters
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<clientpb.Beacon[]>
- Defined in client.ts:725

canaries

canaries(timeoutSeconds?: number): Promise<clientpb.Canaries>
Parameters
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<clientpb.Canaries>
- Defined in client.ts:635

connect

connect(): Promise<SliverClient>
Returns Promise<SliverClient>
- Defined in client.ts:442

deleteImplantBuild

deleteImplantBuild(name: string, timeoutSeconds?: number): Promise<void>
Parameters
- name: string
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<void>
- Defined in client.ts:629

deleteImplantProfile

deleteImplantProfile(name: string, timeoutSeconds?: number): Promise<void>
Parameters
- name: string
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<void>
- Defined in client.ts:647

disconnect

disconnect(): Promise<void>
Returns Promise<void>
- Defined in client.ts:464

generate

generate(
config: clientpb.ImplantConfig,
timeoutSeconds?: number,
): Promise<undefined | commonpb.File>
Parameters
- config: clientpb.ImplantConfig
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<undefined | commonpb.File>
- Defined in client.ts:613

getBeacons

getBeacons(timeoutSeconds?: number): Promise<clientpb.Beacons>
Parameters
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<clientpb.Beacons>
- Defined in client.ts:511

getJobs

getJobs(timeoutSeconds?: number): Promise<clientpb.Jobs>
Parameters
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<clientpb.Jobs>
- Defined in client.ts:515

getOperators

getOperators(timeoutSeconds?: number): Promise<clientpb.Operators>
Parameters
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<clientpb.Operators>
- Defined in client.ts:503

getSessions

getSessions(timeoutSeconds?: number): Promise<clientpb.Sessions>
Parameters
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<clientpb.Sessions>
- Defined in client.ts:507

getVersion

getVersion(timeoutSeconds?: number): Promise<clientpb.Version>
Parameters
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<clientpb.Version>
- Defined in client.ts:499

implantBuilds

implantBuilds(timeoutSeconds?: number): Promise<clientpb.ImplantBuilds>
Parameters
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<clientpb.ImplantBuilds>
- Defined in client.ts:625

implantProfiles

implantProfiles(timeoutSeconds?: number): Promise<clientpb.ImplantProfiles>
Parameters
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<clientpb.ImplantProfiles>
- Defined in client.ts:639

interactBeacon

interactBeacon(beaconId: string): InteractiveBeacon
Parameters
- beaconId: string
Returns InteractiveBeacon
- Defined in client.ts:742

interactSession

interactSession(sessionId: string): InteractiveSession
Parameters
- sessionId: string
Returns InteractiveSession
- Defined in client.ts:735

jobs

jobs(timeoutSeconds?: number): Promise<clientpb.Job[]>
Parameters
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<clientpb.Job[]>
- Defined in client.ts:730

killJob

killJob(jobId: number, timeoutSeconds?: number): Promise<clientpb.KillJob>
Parameters
- jobId: number
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<clientpb.KillJob>
- Defined in client.ts:519

lootAdd

lootAdd(loot: clientpb.Loot, timeoutSeconds?: number): Promise<clientpb.Loot>
Parameters
- loot: clientpb.Loot
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<clientpb.Loot>
- Defined in client.ts:660

lootAll

lootAll(timeoutSeconds?: number): Promise<clientpb.Loot[]>
Parameters
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<clientpb.Loot[]>
- Defined in client.ts:653

lootContent

lootContent(lootId: string, timeoutSeconds?: number): Promise<clientpb.Loot>
Parameters
- lootId: string
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<clientpb.Loot>
- Defined in client.ts:674

lootRemove

lootRemove(lootId: string, timeoutSeconds?: number): Promise<void>
Parameters
- lootId: string
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<void>
- Defined in client.ts:668

lootUpdate

lootUpdate(loot: clientpb.Loot, timeoutSeconds?: number): Promise<clientpb.Loot>
Parameters
- loot: clientpb.Loot
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<clientpb.Loot>
- Defined in client.ts:664

operators

operators(timeoutSeconds?: number): Promise<clientpb.Operator[]>
Parameters
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<clientpb.Operator[]>
- Defined in client.ts:715

regenerate

regenerate(
implantName: string,
timeoutSeconds?: number,
): Promise<undefined | commonpb.File>
Parameters
- implantName: string
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<undefined | commonpb.File>
- Defined in client.ts:618

restartJobs

restartJobs(jobIds: number[], timeoutSeconds?: number): Promise<void>
Parameters
- jobIds: number[]
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<void>
- Defined in client.ts:523

rmBeacon

rmBeacon(beaconId: string, timeoutSeconds?: number): Promise<void>
Parameters
- beaconId: string
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<void>
- Defined in client.ts:746

rpcHost

rpcHost(): string
Returns string
- Defined in client.ts:427

saveImplantProfile

saveImplantProfile(
profile: clientpb.ImplantProfile,
timeoutSeconds?: number,
): Promise<clientpb.ImplantProfile>
Parameters
- profile: clientpb.ImplantProfile
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<clientpb.ImplantProfile>
- Defined in client.ts:643

sessions

sessions(timeoutSeconds?: number): Promise<clientpb.Session[]>
Parameters
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<clientpb.Session[]>
- Defined in client.ts:720

startDNSListener

startDNSListener(
    domains: string[],
    canaries: boolean,
    host: string,
    port: number,
    enforceOTP?: boolean,
    timeoutSeconds?: number,
): Promise<clientpb.ListenerJob>
Parameters
- domains: string[]
- canaries: boolean
- host: string
- port: number
- enforceOTP: boolean = false
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<clientpb.ListenerJob>
- Defined in client.ts:546

startHTTPListener

startHTTPListener(
    domain: string,
    host: string,
    port: number,
    website?: string,
    enforceOTP?: boolean,
    timeoutSeconds?: number,
): Promise<clientpb.ListenerJob>
Parameters
- domain: string
- host: string
- port: number
- website: string = ""
- enforceOTP: boolean = false
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<clientpb.ListenerJob>
- Defined in client.ts:562

startHTTPSListener

startHTTPSListener(
    domain: string,
    host: string,
    port: number,
    website?: string,
    acme?: boolean,
    cert?: Buffer<ArrayBufferLike>,
    key?: Buffer<ArrayBufferLike>,
    enforceOTP?: boolean,
    timeoutSeconds?: number,
): Promise<clientpb.ListenerJob>
Parameters
- domain: string
- host: string
- port: number
- website: string = ""
- acme: boolean = false
- Optionalcert: Buffer<ArrayBufferLike>
- Optionalkey: Buffer<ArrayBufferLike>
- enforceOTP: boolean = false
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<clientpb.ListenerJob>
- Defined in client.ts:578

startMTLSListener

startMTLSListener(
    host: string,
    port: number,
    timeoutSeconds?: number,
): Promise<clientpb.ListenerJob>
Parameters
- host: string
- port: number
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<clientpb.ListenerJob>
- Defined in client.ts:529

startTCPStagerListener

startTCPStagerListener(
    host: string,
    port: number,
    data: Buffer,
    timeoutSeconds?: number,
): Promise<clientpb.StagerListener>
Parameters
- host: string
- port: number
- data: Buffer
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<clientpb.StagerListener>
- Defined in client.ts:607

startWGListener

startWGListener(
    host: string,
    port: number,
    tunIP: string,
    nPort: number,
    keyPort: number,
    timeoutSeconds?: number,
): Promise<clientpb.ListenerJob>
Parameters
- host: string
- port: number
- tunIP: string
- nPort: number
- keyPort: number
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<clientpb.ListenerJob>
- Defined in client.ts:533

website

website(name: string, timeoutSeconds?: number): Promise<clientpb.Website>
Parameters
- name: string
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<clientpb.Website>
- Defined in client.ts:685

websiteAddContent

websiteAddContent(
    name: string,
    contents: Record<string, clientpb.WebContent>,
    timeoutSeconds?: number,
): Promise<clientpb.Website>
Parameters
- name: string
- contents: Record<string, clientpb.WebContent>
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<clientpb.Website>
- Defined in client.ts:695

websiteRemove

websiteRemove(name: string, timeoutSeconds?: number): Promise<void>
Parameters
- name: string
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<void>
- Defined in client.ts:689

websiteRemoveContent

websiteRemoveContent(
    name: string,
    paths: string[],
    timeoutSeconds?: number,
): Promise<clientpb.Website>
Parameters
- name: string
- paths: string[]
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<clientpb.Website>
- Defined in client.ts:707

websites

websites(timeoutSeconds?: number): Promise<clientpb.Website[]>
Parameters
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<clientpb.Website[]>
- Defined in client.ts:678

websiteUpdateContent

websiteUpdateContent(
    name: string,
    contents: Record<string, clientpb.WebContent>,
    timeoutSeconds?: number,
): Promise<clientpb.Website>
Parameters
- name: string
- contents: Record<string, clientpb.WebContent>
- timeoutSeconds: number = DEFAULT_TIMEOUT_SECONDS
Returns Promise<clientpb.Website>
- Defined in client.ts:701

Class SliverClient

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SliverClient

Properties

Readonlybeacon$

Readonlyclient$

Readonlyconfig

Readonlyevent$

Readonlyjob$

Readonlysession$

ReadonlytaskResult$

Static ReadonlyEVENT_BEACON_REGISTERED

Static ReadonlyEVENT_BEACON_TASKRESULT

Accessors

isConnected

Returns boolean

rpc

Returns SliverRPCClient

Methods

beacons

Parameters

Returns Promise<clientpb.Beacon[]>

canaries

Parameters

Returns Promise<clientpb.Canaries>

connect

Returns Promise<SliverClient>

deleteImplantBuild

Parameters

Returns Promise<void>

deleteImplantProfile

Parameters

Returns Promise<void>

disconnect

Returns Promise<void>

generate

Parameters

Returns Promise<undefined | commonpb.File>

getBeacons

Parameters

Returns Promise<clientpb.Beacons>

getJobs

Parameters

Returns Promise<clientpb.Jobs>

getOperators

Parameters

Returns Promise<clientpb.Operators>

getSessions

Parameters

Returns Promise<clientpb.Sessions>

getVersion

Parameters

Returns Promise<clientpb.Version>

implantBuilds

Parameters

Returns Promise<clientpb.ImplantBuilds>

implantProfiles

Parameters

Returns Promise<clientpb.ImplantProfiles>

interactBeacon

Parameters

Returns InteractiveBeacon

interactSession

Parameters

Returns InteractiveSession

jobs

Parameters

Returns Promise<clientpb.Job[]>

killJob

Parameters

Returns Promise<clientpb.KillJob>

lootAdd

Parameters

`Readonly`beacon$

`Readonly`client$

`Readonly`config

`Readonly`event$

`Readonly`job$

`Readonly`session$

`Readonly`taskResult$

`Static` `Readonly`EVENT_BEACON_REGISTERED

`Static` `Readonly`EVENT_BEACON_TASKRESULT