Movatterモバイル変換


[0]ホーム

URL:


Alert GO-2024-3228: Coder vulnerable to post-auth URL redirection to untrusted site ('Open Redirect') in github.com/coder/coder
Notice  The highest tagged major version isv2.

pty

package
v0.27.3Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 1, 2023 License:AGPL-3.0Imports:17Imported by:0

Details

Repository

github.com/coder/coder

Links

Documentation

Index

Constants

This section is empty.

Variables

View Source
var ErrClosed =xerrors.New("pty: closed")

ErrClosed is returned when a PTY is used after it has been closed.

Functions

funcStart

func Start(cmd *Cmd, opt ...StartOption) (PTYCmd,Process,error)

Start the command in a TTY. The calling code must not use cmd after passing it to the PTY, andinstead rely on the returned Process to manage the command/process.

Types

typeCmdadded inv0.23.1

type Cmd struct {Contextcontext.ContextPathstringArgs    []stringEnv     []stringDirstring}

Cmd is a drop-in replacement for exec.Cmd with most of the same API, butit exposes the context.Context to our PTY code so that we can still kill theprocess when the Context expires. This is required because on Windows, we don'tstart the command using the `exec` library, so we have to manage the contextourselves.

funcCommandadded inv0.23.1

func Command(namestring, arg ...string) *Cmd

funcCommandContextadded inv0.23.1

func CommandContext(ctxcontext.Context, namestring, arg ...string) *Cmd

func (*Cmd)AsExecadded inv0.23.1

func (c *Cmd) AsExec() *exec.Cmd

typeOptionadded inv0.8.15

type Option func(*ptyOptions)

Options represents a an option for a PTY.

funcWithGPGTTYadded inv0.14.0

func WithGPGTTY()Option

WithGPGTTY sets the GPG_TTY environment variable to the PTY name. This onlyapplies to non-Windows platforms.

funcWithLoggeradded inv0.8.15

func WithLogger(logger *log.Logger)Option

WithLogger sets a logger for logging errors.

funcWithSSHRequestadded inv0.8.15

func WithSSHRequest(reqssh.Pty)Option

WithSSHRequest applies the ssh.Pty request to the PTY.

Only partially supported on Windows (e.g. window size).

typePTY

type PTY interface {io.Closer// Resize sets the size of the PTY.Resize(heightuint16, widthuint16)error// Name of the TTY. Example on Linux would be "/dev/pts/1".Name()string// Output handles TTY output.//// cmd.SetOutput(pty.Output()) would be used to specify a command// uses the output stream for writing.//// The same stream could be read to validate output.Output()ReadWriter// Input handles TTY input.//// cmd.SetInput(pty.Input()) would be used to specify a command// uses the PTY input for reading.//// The same stream would be used to provide user input: pty.Input().Write(...)Input()ReadWriter}

PTY is a minimal interface for interacting with pseudo-TTY where thisprocess retains access to _both_ ends of the pseudo-TTY (i.e. `ptm` & `pts`on Linux).

funcNew

func New(opts ...Option) (PTY,error)

New constructs a new Pty.

typePTYCmdadded inv0.23.0

type PTYCmd interface {io.Closer// Resize sets the size of the PTY.Resize(heightuint16, widthuint16)error// OutputReader returns an io.Reader for reading the output from the process// controlled by the pseudo-TTYOutputReader()io.Reader// InputWriter returns an io.Writer for writing into to the process// controlled by the pseudo-TTYInputWriter()io.Writer}

PTYCmd is an interface for interacting with a pseudo-TTY where we controlonly one end, and the other end has been passed to a running os.Process.nolint:revive

typeProcessadded inv0.8.2

type Process interface {// Wait for the command to complete.  Returned error is as for exec.Cmd.Wait()Wait()error// Kill the command process.  Returned error is as for os.Process.Kill()Kill()error}

Process represents a process running in a PTY. We need to trigger special processing on the PTYon process completion, meaning that we will have goroutines calling Wait() on the process. Sincethe caller will also typically wait for the process, and it is not safe for multiple goroutinesto Wait() on a process, this abstraction provides a goroutine-safe interface for interacting withthe process.

typeReadWriteradded inv0.6.0

type ReadWriter struct {Readerio.ReaderWriterio.Writer}

ReadWriter is an implementation of io.ReadWriter that wraps two separateunderlying file descriptors, one for reading and one for writing, and allowsthem to be accessed separately.

func (ReadWriter)Readadded inv0.6.0

func (rwReadWriter) Read(p []byte) (int,error)

func (ReadWriter)Writeadded inv0.6.0

func (rwReadWriter) Write(p []byte) (int,error)

typeStartOptionadded inv0.8.15

type StartOption func(*startOptions)

StartOption represents a configuration option passed to Start.

funcWithPTYOptionadded inv0.8.15

func WithPTYOption(opts ...Option)StartOption

WithPTYOption applies the given options to the underlying PTY.

typeWithFlagsadded inv0.6.0

type WithFlags interface {PTY// EchoEnabled determines whether local echo is currently enabled for this terminal.EchoEnabled() (bool,error)}

WithFlags represents a PTY whose flags can be inspected, in particularto determine whether local echo is enabled.

Source Files

View all Source files

Directories

PathSynopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f orF : Jump to
y orY : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic.Learn more.

[8]ページ先頭

©2009-2025 Movatter.jp