openssh-server

OpenSSH server module for testing SSH connections.

Installation

dagger install github.com/sagikazarmark/daggerverse/openssh-server@v0.1.0

OpensshServer !

Name	Type	Description
container	Container	Custom container to use as a base container. OpenSSH server MUST be installed.

Example

func (m *myModule) example() *OpensshServer  {
	return dag.
			OpensshServer()
}

@function
def example() -> dag.OpensshServer:
	return (
		dag.openssh_server()
	)

@func()
example(): OpensshServer {
	return dag
		.opensshServer()
}

Container !

Example

func (m *myModule) example() *Container  {
	return dag.
			OpensshServer().
			Container()
}

@function
def example() -> dagger.Container:
	return (
		dag.openssh_server()
		.container()
	)

@func()
example(): Container {
	return dag
		.opensshServer()
		.container()
}

Mount a custom SSH configuration file (with .conf extension).

OpensshServer !

Name	Type	Default Value	Description
name	String !	-	No description provided
file	File !	-	No description provided

Example

func (m *myModule) example(name string, file *File) *OpensshServer  {
	return dag.
			OpensshServer().
			WithConfig(name, file)
}

@function
def example(name: str, file: dagger.File) -> dag.OpensshServer:
	return (
		dag.openssh_server()
		.with_config(name, file)
	)

@func()
example(name: string, file: File): OpensshServer {
	return dag
		.opensshServer()
		.withConfig(name, file)
}

Returns the SSH host keys.

Directory !

Example

func (m *myModule) example() *Directory  {
	return dag.
			OpensshServer().
			HostKeys()
}

@function
def example() -> dagger.Directory:
	return (
		dag.openssh_server()
		.host_keys()
	)

@func()
example(): Directory {
	return dag
		.opensshServer()
		.hostKeys()
}

Return a formatted SSH known_hosts file.

File !

Name	Type	Default Value	Description
host	String !	-	No description provided

Example

func (m *myModule) example(host string) *File  {
	return dag.
			OpensshServer().
			KnownHosts(host)
}

@function
def example(host: str) -> dagger.File:
	return (
		dag.openssh_server()
		.known_hosts(host)
	)

@func()
example(host: string): File {
	return dag
		.opensshServer()
		.knownHosts(host)
}

Authorize a public key. By default, the key is authorized for the root user.

OpensshServer !

Name	Type	Default Value	Description
publicKey	File !	-	No description provided
user	String	-	Authorize the key for this user.

Example

func (m *myModule) example(publicKey *File) *OpensshServer  {
	return dag.
			OpensshServer().
			WithAuthorizedKey(publicKey)
}

@function
def example(public_key: dagger.File) -> dag.OpensshServer:
	return (
		dag.openssh_server()
		.with_authorized_key(public_key)
	)

@func()
example(publicKey: File): OpensshServer {
	return dag
		.opensshServer()
		.withAuthorizedKey(publicKey)
}

Return a service that runs the OpenSSH server.

Service !

Name	Type	Default Value	Description
port	Integer	22	No description provided

Example

func (m *myModule) example() *Service  {
	return dag.
			OpensshServer().
			Service()
}

@function
def example() -> dagger.Service:
	return (
		dag.openssh_server()
		.service()
	)

@func()
example(): Service {
	return dag
		.opensshServer()
		.service()
}