Class MalInt

Main entry point for interacting with a MaaS repository through a forge.

Index

Methods

buildContainer buildMalware generateMalwareConfiguration generateServerConfiguration getClientSideConfigurations getServerPlainText getServerSecrets getServerSideConfigurations getStatesConfigurations setServerHostname waitForContainer waitForMalware createMalInt

Methods

buildContainer

buildContainer(
registryCredentials: { password: string; url: string; username: string },
): Promise<Result<number, BuildContainerError>>
Dispatches the server container build workflow. Returns an active container build if one is already running.
Parameters
- registryCredentials: { password: string; url: string; username: string }
Returns Promise<Result<number, BuildContainerError>>
- Defined in index.ts:82

buildMalware

buildMalware(configuration: object): Promise<Result<number, BuildMalwareError>>
Writes the malware configuration and dispatches the malware build workflow.
Parameters
- configuration: object
Returns Promise<Result<number, BuildMalwareError>>
- Defined in index.ts:133

generateMalwareConfiguration

generateMalwareConfiguration(): Promise<
Result<object, GenerateMalwareConfigurationError>,
>
Generates the malware configuration by resolving functions and references. Uses server-side configuration definitions as the source.

Returns Promise<Result<object, GenerateMalwareConfigurationError>>
- Defined in index.ts:401

generateServerConfiguration

generateServerConfiguration(): Promise<
Result<object, GenerateServerConfigurationError>,
>
Generates the server configuration by resolving functions and references. Uses server-side configuration definitions as the source.

Returns Promise<Result<object, GenerateServerConfigurationError>>
- Defined in index.ts:370

getClientSideConfigurations

getClientSideConfigurations(): Promise<
    Result<
        | {
            malware?: { schema: object; ui: object };
            server?: { schema: object; ui: object };
        }
        | undefined,
        GetConfigurationsError,
    >,
>
Loads client-side configuration definitions from the repository.

Returns Promise<
    Result<
        | {
            malware?: { schema: object; ui: object };
            server?: { schema: object; ui: object };
        }
        | undefined,
        GetConfigurationsError,
    >,
>
- Defined in index.ts:287

getServerPlainText

getServerPlainText(): Promise<
    Result<
        { name: string; path: string[]; value: unknown }[],
        GenerateServerConfigurationError,
    >,
>
Returns generated server variables marked as plaintext.

Returns Promise<
    Result<
        { name: string; path: string[]; value: unknown }[],
        GenerateServerConfigurationError,
    >,
>
- Defined in index.ts:441

getServerSecrets

getServerSecrets(): Promise<
    Result<
        { name: string; path: string[]; value: unknown }[],
        GenerateServerConfigurationError,
    >,
>
Returns generated server variables marked as secrets.

Returns Promise<
    Result<
        { name: string; path: string[]; value: unknown }[],
        GenerateServerConfigurationError,
    >,
>
- Defined in index.ts:420

getServerSideConfigurations

getServerSideConfigurations(): Promise<
Result<{ malware: object; server?: object }, GetConfigurationsError>,
>
Loads server-side configuration definitions from the repository.

Returns Promise<Result<{ malware: object; server?: object }, GetConfigurationsError>>
- Defined in index.ts:243

getStatesConfigurations

getStatesConfigurations(): Promise<
    Result<
        | {
            instance?: { schema: object; ui: object };
            victims?: { schema: object; ui: object };
        }
        | undefined,
        GetConfigurationsError,
    >,
>
Loads state configuration definitions from the repository.

Returns Promise<
    Result<
        | {
            instance?: { schema: object; ui: object };
            victims?: { schema: object; ui: object };
        }
        | undefined,
        GetConfigurationsError,
    >,
>
- Defined in index.ts:328

setServerHostname

setServerHostname(hostname: string): Result<void, ZodError<unknown>>
Sets the hostname used by networking handlers.
Parameters
- hostname: string
Returns Result<void, ZodError<unknown>>
- Defined in index.ts:462

waitForContainer

waitForContainer(
runIdentifier: number,
pollInterval?: number,
): Promise<Result<void, WaitForContainerError>>
Polls a container build run until it completes.
Parameters
- runIdentifier: number
- pollInterval: number = 5000
Returns Promise<Result<void, WaitForContainerError>>
- Defined in index.ts:167

waitForMalware

waitForMalware(
runIdentifier: number,
pollInterval?: number,
): Promise<Result<Buffer<ArrayBufferLike>, WaitForMalwareError>>
Polls a malware build run until it completes and downloads the artifact.
Parameters
- runIdentifier: number
- pollInterval: number = 5000
Returns Promise<Result<Buffer<ArrayBufferLike>, WaitForMalwareError>>
- Defined in index.ts:202

`Static`createMalInt

createMalInt(
repository: Repository,
forgeKind: Forgejo,
): Promise<Result<MalInt, CreateMalIntError>>
Creates a MalInt instance by loading the repository configuration.
Parameters
- repository: Repository
- forgeKind: Forgejo
Returns Promise<Result<MalInt, CreateMalIntError>>
- Defined in index.ts:62

Class MalInt

Index

Methods

Methods

buildContainer

Parameters

Returns Promise<Result<number, BuildContainerError>>

buildMalware

Parameters

Returns Promise<Result<number, BuildMalwareError>>

generateMalwareConfiguration

Returns Promise<Result<object, GenerateMalwareConfigurationError>>

generateServerConfiguration

Returns Promise<Result<object, GenerateServerConfigurationError>>

getClientSideConfigurations

Returns Promise<
    Result<
        | {
            malware?: { schema: object; ui: object };
            server?: { schema: object; ui: object };
        }
        | undefined,
        GetConfigurationsError,
    >,
>

getServerPlainText

Returns Promise<
    Result<
        { name: string; path: string[]; value: unknown }[],
        GenerateServerConfigurationError,
    >,
>

getServerSecrets

Returns Promise<
    Result<
        { name: string; path: string[]; value: unknown }[],
        GenerateServerConfigurationError,
    >,
>

getServerSideConfigurations

Returns Promise<Result<{ malware: object; server?: object }, GetConfigurationsError>>

getStatesConfigurations

Returns Promise<
    Result<
        | {
            instance?: { schema: object; ui: object };
            victims?: { schema: object; ui: object };
        }
        | undefined,
        GetConfigurationsError,
    >,
>

setServerHostname

Parameters

Returns Result<void, ZodError<unknown>>

waitForContainer

Parameters

Returns Promise<Result<void, WaitForContainerError>>

waitForMalware

Parameters

Returns Promise<Result<Buffer<ArrayBufferLike>, WaitForMalwareError>>

`Static`createMalInt

Parameters

Returns Promise<Result<MalInt, CreateMalIntError>>

Settings

On This Page

Class MalInt

Index

Methods

Methods

buildContainer

Parameters

Returns Promise<Result<number, BuildContainerError>>

buildMalware

Parameters

Returns Promise<Result<number, BuildMalwareError>>

generateMalwareConfiguration

Returns Promise<Result<object, GenerateMalwareConfigurationError>>

generateServerConfiguration

Returns Promise<Result<object, GenerateServerConfigurationError>>

getClientSideConfigurations

Returns Promise< Result< | { malware?: { schema: object; ui: object }; server?: { schema: object; ui: object }; } | undefined, GetConfigurationsError, >,>

getServerPlainText

Returns Promise< Result< { name: string; path: string[]; value: unknown }[], GenerateServerConfigurationError, >,>

getServerSecrets

Returns Promise< Result< { name: string; path: string[]; value: unknown }[], GenerateServerConfigurationError, >,>

getServerSideConfigurations

Returns Promise<Result<{ malware: object; server?: object }, GetConfigurationsError>>

getStatesConfigurations

Returns Promise< Result< | { instance?: { schema: object; ui: object }; victims?: { schema: object; ui: object }; } | undefined, GetConfigurationsError, >,>

setServerHostname

Parameters

Returns Result<void, ZodError<unknown>>

waitForContainer

Parameters

Returns Promise<Result<void, WaitForContainerError>>

waitForMalware

Parameters

Returns Promise<Result<Buffer<ArrayBufferLike>, WaitForMalwareError>>

StaticcreateMalInt

Parameters

Returns Promise<Result<MalInt, CreateMalIntError>>

Settings

On This Page

Returns Promise<
Result<
| {
malware?: { schema: object; ui: object };
server?: { schema: object; ui: object };
}
| undefined,
GetConfigurationsError,
>,
>

Returns Promise<
Result<
{ name: string; path: string[]; value: unknown }[],
GenerateServerConfigurationError,
>,
>

Returns Promise<
Result<
{ name: string; path: string[]; value: unknown }[],
GenerateServerConfigurationError,
>,
>

Returns Promise<
Result<
| {
instance?: { schema: object; ui: object };
victims?: { schema: object; ui: object };
}
| undefined,
GetConfigurationsError,
>,
>

`Static`createMalInt