pax_global_header00006660000000000000000000000064145254322620014517gustar00rootroot0000000000000052 comment=f188b6dbd525024ba5e580fbd4cb3b85e4868f82 pty-1.1.21/000077500000000000000000000000001452543226200124155ustar00rootroot00000000000000pty-1.1.21/.editorconfig000066400000000000000000000017241452543226200150760ustar00rootroot00000000000000root = true # Sane defaults. [*] # Always use unix end of line. end_of_line = lf # Always insert a new line at the end of files. insert_final_newline = true # Don't leave trailing whitespaces. trim_trailing_whitespace = true # Default to utf8 encoding. charset = utf-8 # Space > tab for consistent aligns. indent_style = space # Default to 2 spaces for indent/tabs. indent_size = 2 # Flag long lines. max_line_length = 140 # Explicitly define settings for commonly used files. [*.go] indent_style = tab indent_size = 8 [*.feature] indent_style = space indent_size = 2 [*.json] indent_style = space indent_size = 2 [*.{yml,yaml}] indent_style = space indent_size = 2 [*.tf] indent_style = space indent_size = 2 [*.md] # Don't check line lenghts in files. max_line_length = 0 [{Makefile,*.mk}] indent_style = tab indent_size = 8 [{Dockerfile,Dockerfile.*}] indent_size = 4 [*.sql] indent_size = 2 pty-1.1.21/.github/000077500000000000000000000000001452543226200137555ustar00rootroot00000000000000pty-1.1.21/.github/workflows/000077500000000000000000000000001452543226200160125ustar00rootroot00000000000000pty-1.1.21/.github/workflows/crosscompile.yml000066400000000000000000000004521452543226200212400ustar00rootroot00000000000000--- name: Crosscompile "on": push: branches: - master jobs: test: name: Run ./test_crosscompile.sh runs-on: ubuntu-latest steps: - name: Checkout repo uses: actions/checkout@v4 - name: Run ./test_crosscompile.sh run: ./test_crosscompile.sh pty-1.1.21/.github/workflows/test.yml000066400000000000000000000030141452543226200175120ustar00rootroot00000000000000--- name: Test "on": push: branches: - master pull_request: branches: - master jobs: test: name: "Test go ${{ matrix.go_version }} on ${{ matrix.platform }}" runs-on: ${{ matrix.platform }} strategy: matrix: platform: - ubuntu-latest - macos-latest go_version: # Test the two currently supported releases. # (https://go.dev/doc/devel/release#policy). - stable - oldstable include: # Also sanity test a very old release on linux. - platform: ubuntu-latest go_version: 1.6.x steps: # 1.6 doesn't seem to default GOPATH to anything, # so we set it explicitly here. - if: ${{ matrix.go_version == '1.6.x' }} name: Set GOPATH run: echo "GOPATH=$HOME/go" >> $GITHUB_ENV - name: Set up Go ${{ matrix.go_version }} uses: actions/setup-go@v4 with: go-version: ${{ matrix.go_version }} check-latest: true - name: Checkout repo uses: actions/checkout@v4 - name: Build run: go build -v # Skip tests for 1.6 as we use modern Go. # If the main lib builds and tests pass on other versions, we are good. - if: ${{ matrix.go_version != '1.6.x' }} name: Single Test run: go test -v # Run the tests again 100 times without verbose. - if: ${{ matrix.go_version != '1.6.x' }} name: Many Tests run: go test -count=100 -timeout=10s pty-1.1.21/.gitignore000066400000000000000000000000331452543226200144010ustar00rootroot00000000000000[568].out _go* _test* _obj pty-1.1.21/.golangci.yml000066400000000000000000000447521452543226200150150ustar00rootroot00000000000000--- # Reference: https://golangci-lint.run/usage/configuration/ run: timeout: 5m # modules-download-mode: vendor # Include test files. tests: true skip-dirs: [] skip-files: [] output: # colored-line-number|line-number|json|tab|checkstyle|code-climate, default is "colored-line-number". format: colored-line-number print-issued-lines: true print-linter-name: true # Linter specific settings. See below in the `linter.enable` section for details on what each linter is doing. linters-settings: dogsled: # Checks assignments with too many blank identifiers. Default is 2. max-blank-identifiers: 2 dupl: # Tokens count to trigger issue. threshold: 150 errcheck: # Report about not checking of errors in type assertions: `a := b.(MyStruct)`. # Enabled as this is often overlooked by developers. check-type-assertions: true # Report about assignment of errors to blank identifier: `num, _ := strconv.Atoi(numStr)`. # Disabled as we consider that if the developer did type `_`, it was on purpose. # Note that while this isn't enforced by the linter, each and every case of ignored error should # be accompanied with a comment explaining why that error is being discarded. check-blank: false exhaustive: # Indicates that switch statements are to be considered exhaustive if a # 'default' case is present, even if all enum members aren't listed in the # switch. default-signifies-exhaustive: false funlen: # funlen checks the number of lines/statements in a function. # While is is always best to keep functions short for readability, maintainability and testing, # the default are a bit too strict (60 lines / 40 statements), increase it to be more flexible. lines: 160 statements: 70 # NOTE: We don't set `gci` for import order as it supports only one prefix. Use `goimports.local-prefixes` instead. gocognit: # Minimal code complexity to report, defaults to 30 in gocognit, defaults 10 in golangci. # Use 15 as it allows for some flexibility while preventing too much complexity. # NOTE: Similar to gocyclo. min-complexity: 35 nestif: # Minimal complexity of if statements to report. min-complexity: 8 goconst: # Minimal length of string constant. min-len: 4 # Minimal occurrences count to trigger. # Increase the default from 3 to 5 as small number of const usage can reduce readability instead of improving it. min-occurrences: 5 gocritic: # Which checks should be disabled; can't be combined with 'enabled-checks'. # See https://go-critic.github.io/overview#checks-overview # To check which checks are enabled run `GL_DEBUG=gocritic golangci-lint run` disabled-checks: - hugeParam # Very strict check on the size of variables being copied. Too strict for most developer. # Enable multiple checks by tags, run `GL_DEBUG=gocritic golangci-lint run` to see all tags and checks. # Empty list by default. See https://github.com/go-critic/go-critic#usage -> section "Tags". enabled-tags: - diagnostic - style - opinionated - performance settings: rangeValCopy: sizeThreshold: 1024 # Increase the allowed copied bytes in range. cyclop: max-complexity: 35 gocyclo: # Similar check as gocognit. # NOTE: We might be able to remove this linter as it is redundant with gocyclo. It is in golangci-lint, so we keep it for now. min-complexity: 35 godot: # Check all top-level comments, not only declarations. check-all: true gofmt: # simplify code: gofmt with `-s` option. simplify: true # NOTE: the goheader settings are set per-project. goimports: # Put imports beginning with prefix after 3rd-party packages. # It's a comma-separated list of prefixes. local-prefixes: "github.com/creack/pty" golint: # Minimal confidence for issues, default is 0.8. min-confidence: 0.8 gosimple: # Select the Go version to target. The default is '1.13'. go: "1.18" # https://staticcheck.io/docs/options#checks checks: ["all"] gosec: govet: # Enable all available checks from go vet. enable-all: false # Report about shadowed variables. check-shadowing: true # NOTE: depguard is disabled as it is very slow and made redundant by gomodguard. lll: # Make sure everyone is on the same level, fix the tab width to go's default. tab-width: 8 # Increase the default max line length to give more flexibility. Forcing newlines can reduce readability instead of improving it. line-length: 180 misspell: locale: US ignore-words: nakedret: # Make an issue if func has more lines of code than this setting and it has naked returns; default is 30. # NOTE: Consider setting this to 1 to prevent naked returns. max-func-lines: 30 nolintlint: # Prevent ununsed directive to avoid stale comments. allow-unused: false # Require an explanation of nonzero length after each nolint directive. require-explanation: true # Exclude following linters from requiring an explanation. # NOTE: It is strongly discouraged to put anything in there. allow-no-explanation: [] # Enable to require nolint directives to mention the specific linter being suppressed. This ensurce the developer understand the reason being the error. require-specific: true prealloc: # NOTE: For most programs usage of prealloc will be a premature optimization. # Keep thing simple, pre-alloc what is obvious and profile the program for more complex scenarios. # simple: true # Checkonly on simple loops that have no returns/breaks/continues/gotos in them. range-loops: true # Check range loops, true by default for-loops: false # Check suggestions on for loops, false by default rowserrcheck: packages: [] staticcheck: # Select the Go version to target. The default is '1.13'. go: "1.18" # https://staticcheck.io/docs/options#checks checks: ["all"] stylecheck: # Select the Go version to target. The default is '1.13'. go: "1.18" # https://staticcheck.io/docs/options#checks checks: ["all"] # "-ST1000", "-ST1003", "-ST1016", "-ST1020", "-ST1021", "-ST1022"] tagliatelle: # Check the struck tag name case. case: # Use the struct field name to check the name of the struct tag. use-field-name: false rules: # Any struct tag type can be used. # support string case: `camel`, `pascal`, `kebab`, `snake`, `goCamel`, `goPascal`, `goKebab`, `goSnake`, `upper`, `lower` json: snake firestore: camel yaml: camel xml: camel bson: camel avro: snake mapstructure: kebab envconfig: upper unparam: # Don't create an error if an exported code have static params being used. It is often expected in libraries. # NOTE: It would be nice if this linter would differentiate between a main package and a lib. check-exported: true unused: {} whitespace: multi-if: false # Enforces newlines (or comments) after every multi-line if statement multi-func: false # Enforces newlines (or comments) after every multi-line function signature # Run `golangci-lint help linters` to get the full list of linter with their description. linters: disable-all: true # NOTE: enable-all is deprecated because too many people don't pin versions... # We still require explicit documentation on why some linters are disabled. # disable: # - depguard # Go linter that checks if package imports are in a list of acceptable packages [fast: true, auto-fix: false] # - exhaustivestruct # Checks if all struct's fields are initialized [fast: true, auto-fix: false] # - forbidigo # Forbids identifiers [fast: true, auto-fix: false] # - gci # Gci control golang package import order and make it always deterministic. [fast: true, auto-fix: true] # - godox # Tool for detection of FIXME, TODO and other comment keywords [fast: true, auto-fix: false] # - goerr113 # Golang linter to check the errors handling expressions [fast: true, auto-fix: false] # - golint # Golint differs from gofmt. Gofmt reformats Go source code, whereas golint prints out style mistakes [fast: false, auto-fix: false] # - gomnd # An analyzer to detect magic numbers. [fast: true, auto-fix: false] # - gomoddirectives # Manage the use of 'replace', 'retract', and 'excludes' directives in go.mod. [fast: true, auto-fix: false] # - interfacer # Linter that suggests narrower interface types [fast: false, auto-fix: false] # - maligned # Tool to detect Go structs that would take less memory if their fields were sorted [fast: false, auto-fix: false] # - nlreturn # nlreturn checks for a new line before return and branch statements to increase code clarity [fast: true, auto-fix: false] # - scopelint # Scopelint checks for unpinned variables in go programs [fast: true, auto-fix: false] # - wrapcheck # Checks that errors returned from external packages are wrapped [fast: false, auto-fix: false] # - wsl # Whitespace Linter - Forces you to use empty lines! [fast: true, auto-fix: false] # disable-reasons: # - depguard # Checks whitelisted/blacklisted import path, but runs way too slow. Not that useful. # - exhaustivestruct # Good concept, but not mature enough (errors on not assignable fields like locks) and too noisy when using AWS SDK as most fields are unused. # - forbidigo # Great idea, but too strict out of the box. Probably will re-enable soon. # - gci # Conflicts with goimports/gofumpt. # - godox # Don't fail when finding TODO, FIXME, etc. # - goerr113 # Too many false positives. # - golint # Deprecated (since v1.41.0) due to: The repository of the linter has been archived by the owner. Replaced by revive. # - gomnd # Checks for magic numbers. Disabled due to too many false positives not configurable (03/01/2020 v1.23.7). # - gomoddirectives # Doesn't support //nolint to whitelist. # - interfacer # Deprecated (since v1.38.0) due to: The repository of the linter has been archived by the owner. # - maligned # Deprecated (since v1.38.0) due to: The repository of the linter has been archived by the owner. Replaced by govet 'fieldalignment'. # - nlreturn # Actually reduces readability in most cases. # - scopelint # Deprecated (since v1.39.0) due to: The repository of the linter has been deprecated by the owner. Replaced by exportloopref. # - wrapcheck # Good concept, but always warns for http coded errors. Need to re-enable and whitelist our error package. # - wsl # Forces to add newlines around blocks. Lots of false positives, not that useful. enable: - asciicheck # Simple linter to check that your code does not contain non-ASCII identifiers [fast: true, auto-fix: false] - bodyclose # checks whether HTTP response body is closed successfully [fast: false, auto-fix: false] - cyclop # checks function and package cyclomatic complexity [fast: false, auto-fix: false] - dogsled # Checks assignments with too many blank identifiers (e.g. x, _, _, _, := f()) [fast: true, auto-fix: false] - dupl # Tool for code clone detection [fast: true, auto-fix: false] - durationcheck # check for two durations multiplied together [fast: false, auto-fix: false] - errcheck # Errcheck is a program for checking for unchecked errors in go programs. These unchecked errors can be critical bugs in some cases [fast: false, auto-fix: false] - errname # Checks that sentinel errors are prefixed with the `Err` and error types are suffixed with the `Error`. [fast: false, auto-fix: false] - errorlint # go-errorlint is a source code linter for Go software that can be used to find code that will cause problems with the error wrapping scheme introduced in Go 1.13. [fast: false, auto-fix: false] - exhaustive # check exhaustiveness of enum switch statements [fast: false, auto-fix: false] - exportloopref # checks for pointers to enclosing loop variables [fast: false, auto-fix: false] - forcetypeassert # finds forced type assertions [fast: true, auto-fix: false] - funlen # Tool for detection of long functions [fast: true, auto-fix: false] - gochecknoglobals # check that no global variables exist [fast: true, auto-fix: false] - gochecknoinits # Checks that no init functions are present in Go code [fast: true, auto-fix: false] - gocognit # Computes and checks the cognitive complexity of functions [fast: true, auto-fix: false] - goconst # Finds repeated strings that could be replaced by a constant [fast: true, auto-fix: false] - gocritic # Provides many diagnostics that check for bugs, performance and style issues. [fast: false, auto-fix: false] - gocyclo # Computes and checks the cyclomatic complexity of functions [fast: true, auto-fix: false] - godot # Check if comments end in a period [fast: true, auto-fix: true] - gofmt # Gofmt checks whether code was gofmt-ed. By default this tool runs with -s option to check for code simplification [fast: true, auto-fix: true] - gofumpt # Gofumpt checks whether code was gofumpt-ed. [fast: true, auto-fix: true] - goheader # Checks is file header matches to pattern [fast: true, auto-fix: false] - goimports # Goimports does everything that gofmt does. Additionally it checks unused imports [fast: true, auto-fix: true] - gomodguard # Allow and block list linter for direct Go module dependencies. This is different from depguard where there are different block types for example version constraints and module recommendations. [fast: true, auto-fix: false] - goprintffuncname # Checks that printf-like functions are named with `f` at the end [fast: true, auto-fix: false] - gosec # (gas): Inspects source code for security problems [fast: false, auto-fix: false] - gosimple # (megacheck): Linter for Go source code that specializes in simplifying a code [fast: false, auto-fix: false] - govet # (vet, vetshadow): Vet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format string [fast: false, auto-fix: false] - importas # Enforces consistent import aliases [fast: false, auto-fix: false] - ineffassign # Detects when assignments to existing variables are not used [fast: true, auto-fix: false] - lll # Reports long lines [fast: true, auto-fix: false] - makezero # Finds slice declarations with non-zero initial length [fast: false, auto-fix: false] - misspell # Finds commonly misspelled English words in comments [fast: true, auto-fix: true] - nakedret # Finds naked returns in functions greater than a specified function length [fast: true, auto-fix: false] - nestif # Reports deeply nested if statements [fast: true, auto-fix: false] - nilerr # Finds the code that returns nil even if it checks that the error is not nil. [fast: false, auto-fix: false] - noctx # noctx finds sending http request without context.Context [fast: false, auto-fix: false] - nolintlint # Reports ill-formed or insufficient nolint directives [fast: true, auto-fix: false] - paralleltest # paralleltest detects missing usage of t.Parallel() method in your Go test [fast: true, auto-fix: false] - prealloc # Finds slice declarations that could potentially be preallocated [fast: true, auto-fix: false] - predeclared # find code that shadows one of Go's predeclared identifiers [fast: true, auto-fix: false] - promlinter # Check Prometheus metrics naming via promlint [fast: true, auto-fix: false] - revive # Fast, configurable, extensible, flexible, and beautiful linter for Go. Drop-in replacement of golint. [fast: false, auto-fix: false] # Disabled due to generic. Work in progress upstream. # - rowserrcheck # checks whether Err of rows is checked successfully [fast: false, auto-fix: false] # Disabled due to generic. Work in progress upstream. # - sqlclosecheck # Checks that sql.Rows and sql.Stmt are closed. [fast: false, auto-fix: false] - staticcheck # (megacheck): Staticcheck is a go vet on steroids, applying a ton of static analysis checks [fast: false, auto-fix: false] - stylecheck # Stylecheck is a replacement for golint [fast: false, auto-fix: false] # Disabled due to generic. Work in progress upstream. # - tagliatelle # Checks the struct tags. [fast: true, auto-fix: false] # - testpackage # linter that makes you use a separate _test package [fast: true, auto-fix: false] - thelper # thelper detects golang test helpers without t.Helper() call and checks the consistency of test helpers [fast: false, auto-fix: false] - tparallel # tparallel detects inappropriate usage of t.Parallel() method in your Go test codes [fast: false, auto-fix: false] - typecheck # Like the front-end of a Go compiler, parses and type-checks Go code [fast: false, auto-fix: false] - unconvert # Remove unnecessary type conversions [fast: false, auto-fix: false] - unparam # Reports unused function parameters [fast: false, auto-fix: false] # Disabled due to way too many false positive in go1.20. # - unused # (megacheck): Checks Go code for unused constants, variables, functions and types [fast: false, auto-fix: false] # Disabled due to generic. Work in progress upstream. # - wastedassign # wastedassign finds wasted assignment statements. [fast: false, auto-fix: false] - whitespace # Tool for detection of leading and trailing whitespace [fast: true, auto-fix: true] issues: exclude: # Allow shadowing of 'err'. - 'shadow: declaration of "err" shadows declaration' # Allow shadowing of `ctx`. - 'shadow: declaration of "ctx" shadows declaration' # Maximum issues count per one linter. Set to 0 to disable. Default is 50. max-per-linter: 10 # Disable default excludes. Always be explicit on what we exclude. exclude-use-default: false # Exclude some linters from running on tests files. exclude-rules: [] pty-1.1.21/Dockerfile.golang000066400000000000000000000005111452543226200156520ustar00rootroot00000000000000ARG GOVERSION=1.18.2 FROM golang:${GOVERSION} # Set base env. ARG GOOS=linux ARG GOARCH=amd64 ENV GOOS=${GOOS} GOARCH=${GOARCH} CGO_ENABLED=0 GOFLAGS='-v -ldflags=-s -ldflags=-w' # Pre compile the stdlib for 386/arm (32bits). RUN go build -a std # Add the code to the image. WORKDIR pty ADD . . # Build the lib. RUN go build pty-1.1.21/LICENSE000066400000000000000000000020401452543226200134160ustar00rootroot00000000000000Copyright (c) 2011 Keith Rarick Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. pty-1.1.21/README.md000066400000000000000000000044211452543226200136750ustar00rootroot00000000000000# pty Pty is a Go package for using unix pseudo-terminals. ## Install ```sh go get github.com/creack/pty ``` ## Examples Note that those examples are for demonstration purpose only, to showcase how to use the library. They are not meant to be used in any kind of production environment. ### Command ```go package main import ( "io" "os" "os/exec" "github.com/creack/pty" ) func main() { c := exec.Command("grep", "--color=auto", "bar") f, err := pty.Start(c) if err != nil { panic(err) } go func() { f.Write([]byte("foo\n")) f.Write([]byte("bar\n")) f.Write([]byte("baz\n")) f.Write([]byte{4}) // EOT }() io.Copy(os.Stdout, f) } ``` ### Shell ```go package main import ( "io" "log" "os" "os/exec" "os/signal" "syscall" "github.com/creack/pty" "golang.org/x/term" ) func test() error { // Create arbitrary command. c := exec.Command("bash") // Start the command with a pty. ptmx, err := pty.Start(c) if err != nil { return err } // Make sure to close the pty at the end. defer func() { _ = ptmx.Close() }() // Best effort. // Handle pty size. ch := make(chan os.Signal, 1) signal.Notify(ch, syscall.SIGWINCH) go func() { for range ch { if err := pty.InheritSize(os.Stdin, ptmx); err != nil { log.Printf("error resizing pty: %s", err) } } }() ch <- syscall.SIGWINCH // Initial resize. defer func() { signal.Stop(ch); close(ch) }() // Cleanup signals when done. // Set stdin in raw mode. oldState, err := term.MakeRaw(int(os.Stdin.Fd())) if err != nil { panic(err) } defer func() { _ = term.Restore(int(os.Stdin.Fd()), oldState) }() // Best effort. // Copy stdin to the pty and the pty to stdout. // NOTE: The goroutine will keep reading until the next keystroke before returning. go func() { _, _ = io.Copy(ptmx, os.Stdin) }() _, _ = io.Copy(os.Stdout, ptmx) return nil } func main() { if err := test(); err != nil { log.Fatal(err) } } ``` pty-1.1.21/asm_solaris_amd64.s000066400000000000000000000006631452543226200161150ustar00rootroot00000000000000// Copyright 2014 The Go Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. //go:build gc //+build gc #include "textflag.h" // // System calls for amd64, Solaris are implemented in runtime/syscall_solaris.go // TEXT ·sysvicall6(SB),NOSPLIT,$0-88 JMP syscall·sysvicall6(SB) TEXT ·rawSysvicall6(SB),NOSPLIT,$0-88 JMP syscall·rawSysvicall6(SB) pty-1.1.21/doc.go000066400000000000000000000005341452543226200135130ustar00rootroot00000000000000// Package pty provides functions for working with Unix terminals. package pty import ( "errors" "os" ) // ErrUnsupported is returned if a function is not // available on the current platform. var ErrUnsupported = errors.New("unsupported") // Open a pty and its corresponding tty. func Open() (pty, tty *os.File, err error) { return open() } pty-1.1.21/doc_test.go000066400000000000000000000131441452543226200145530ustar00rootroot00000000000000package pty import ( "os" "testing" ) func TestOpen(t *testing.T) { t.Parallel() openClose(t) } func TestName(t *testing.T) { t.Parallel() pty, tty := openClose(t) // Check name isn't empty. There's variation on what exactly the OS calls these files. if pty.Name() == "" { t.Error("Pty name was empty.") } if tty.Name() == "" { t.Error("Tty name was empty.") } } // TestOpenByName ensures that the name associated with the tty is valid // and can be opened and used if passed by file name (rather than passing // the existing open file descriptor). func TestOpenByName(t *testing.T) { t.Parallel() pty, tty := openClose(t) // Get the pty/tty pair. // Manually open the tty from the exiting name. ttyFile, err := os.OpenFile(tty.Name(), os.O_RDWR, 0o600) noError(t, err, "Failed to open tty file") defer func() { _ = ttyFile.Close() }() // Ensure we can write to the newly opened tty file and read on the pty. text := []byte("ping") n, err := ttyFile.Write(text) // Write the text to the manually open tty. noError(t, err, "Unexpected error from Write") // Make sure it didn't fail. assert(t, len(text), n, "Unexpected count returned from Write") // Assert the number of bytes written. buffer := readN(t, pty, len(text), "Unexpected error from pty Read") assertBytes(t, text, buffer, "Unexpected result result returned from pty Read") } func TestGetsize(t *testing.T) { t.Parallel() pty, tty := openClose(t) prows, pcols, err := Getsize(pty) noError(t, err, "Unexpected error from pty Getsize") trows, tcols, err := Getsize(tty) noError(t, err, "Unexpected error from tty Getsize") assert(t, prows, trows, "rows from Getsize on pty and tty should match") assert(t, pcols, tcols, "cols from Getsize on pty and tty should match") } func TestGetsizeFull(t *testing.T) { t.Parallel() pty, tty := openClose(t) psize, err := GetsizeFull(pty) noError(t, err, "Unexpected error from pty GetsizeFull") tsize, err := GetsizeFull(tty) noError(t, err, "Unexpected error from tty GetsizeFull") assert(t, psize.X, tsize.X, "X from GetsizeFull on pty and tty should match") assert(t, psize.Y, tsize.Y, "Y from GetsizeFull on pty and tty should match") assert(t, psize.Rows, tsize.Rows, "rows from GetsizeFull on pty and tty should match") assert(t, psize.Cols, tsize.Cols, "cols from GetsizeFull on pty and tty should match") } func TestSetsize(t *testing.T) { t.Parallel() pty, tty := openClose(t) psize, err := GetsizeFull(pty) noError(t, err, "Unexpected error from pty GetsizeFull") psize.X++ psize.Y++ psize.Rows++ psize.Cols++ noError(t, Setsize(tty, psize), "Unexpected error from Setsize") tsize, err := GetsizeFull(tty) noError(t, err, "Unexpected error from tty GetsizeFull") assert(t, psize.X, tsize.X, "Unexpected Getsize X result after Setsize") assert(t, psize.Y, tsize.Y, "Unexpected Getsize Y result after Setsize") assert(t, psize.Rows, tsize.Rows, "Unexpected Getsize Rows result after Setsize") assert(t, psize.Cols, tsize.Cols, "Unexpected Getsize Cols result after Setsize") } func TestReadWriteText(t *testing.T) { t.Parallel() pty, tty := openClose(t) // Write to tty, read from pty. { text := []byte("ping") n, err := tty.Write(text) noError(t, err, "Unexpected error from tty Write") assert(t, n, len(text), "Unexpected count returned from tty Write") buffer := readN(t, pty, len(text), "Unexpected error from pty Read") assertBytes(t, text, buffer, "Unexpected result returned from pty Read") } // Write to pty, read from tty. // We need to send a \n otherwise this will block in the terminal driver. { text := []byte("pong\n") n, err := pty.Write(text) noError(t, err, "Unexpected error from pty Write") assert(t, n, len(text), "Unexpected count returned from pty Write") // Expect the raw text back when reading from tty. buffer := readN(t, tty, len(text), "Unexpected error from tty Read") assertBytes(t, text, buffer, "Unexpected result returned from tty Read") // Read the echo back from pty. Expect LF to be CRLF. expect := []byte("pong\r\n") buffer = readN(t, pty, len(expect), "Unexpected error from pty Read") assertBytes(t, expect, buffer, "Unexpected result returned from pty Read") } } func TestReadWriteControls(t *testing.T) { t.Parallel() pty, tty := openClose(t) // Write the start of a line to pty. n, err := pty.WriteString("pind") // Intentional typo. noError(t, err, "Unexpected error from Write initial text") // Make sure it didn't fail. assert(t, 4, n, "Unexpected count returned from Write initial text") // Assert the number of bytes written. // Backspace that last char. n, err = pty.WriteString("\b") // "Remove" the typo. noError(t, err, "Unexpected error from Write backspace") // Make sure it didn't fail. assert(t, 1, n, "Unexpected count returned from Write backspace") // Assert the number of bytes written. // Write the correct char and a LF. n, err = pty.WriteString("g\n") // Fix the typo. noError(t, err, "Unexpected error from Write fixed text") // Make sure it didn't fail. assert(t, 2, n, "Unexpected count returned from Write fixed text") // Assert the number of bytes written. // Read the line. buffer := readN(t, tty, 7, "Unexpected error from tty Read") assertBytes(t, []byte("pind\bg\n"), buffer, "Unexpected result returned from tty Read") // Read the echo back from pty. buffer = readN(t, pty, 9, "Unexpected error from pty Read") assertBytes(t, []byte("pind^Hg\r\n"), buffer, "Unexpected result returned from pty Read") } pty-1.1.21/go.mod000066400000000000000000000000461452543226200135230ustar00rootroot00000000000000module github.com/creack/pty go 1.13 pty-1.1.21/helpers_test.go000066400000000000000000000024461452543226200154530ustar00rootroot00000000000000package pty import ( "bytes" "fmt" "io" "os" "testing" ) // openCloses opens a pty/tty pair and stages the closing as part of the cleanup. func openClose(t *testing.T) (pty, tty *os.File) { t.Helper() pty, tty, err := Open() if err != nil { t.Fatalf("Unexpected error from Open: %s.", err) } t.Cleanup(func() { if err := tty.Close(); err != nil { t.Errorf("Unexpected error from tty Close: %s.", err) } if err := pty.Close(); err != nil { t.Errorf("Unexpected error from pty Close: %s.", err) } }) return pty, tty } func noError(t *testing.T, err error, msg string) { t.Helper() if err != nil { t.Fatalf("%s: %s.", msg, err) } } func assert[T comparable](t *testing.T, a, b T, msg string) { t.Helper() if a != b { t.Errorf("%s: %v != %v.", msg, a, b) } } // When asserting bytes, we want to display the diff, which may contain control characters. func assertBytes(t *testing.T, a, b []byte, msg string) { t.Helper() if !bytes.Equal(a, b) { t.Errorf("%s: %v != %v.", msg, a, b) } } // Read a specific number of bytes from r, assert it didn't fail and return the bytes. func readN(t *testing.T, r io.Reader, n int, msg string) []byte { t.Helper() buf := make([]byte, n) _, err := io.ReadFull(r, buf) noError(t, err, fmt.Sprintf("%s: %s", msg, err)) return buf } pty-1.1.21/io_test.go000066400000000000000000000065051452543226200144200ustar00rootroot00000000000000//go:build go1.12 // +build go1.12 package pty import ( "context" "errors" "os" "runtime" "sync" "testing" "time" ) const ( errMarker byte = 0xEE timeout = time.Second ) //nolint:gochecknoglobals // Expected global lock to avoid potential race on (*os.File).Fd(). var glTestFdLock sync.Mutex // Check that SetDeadline() works for ptmx. // Outstanding Read() calls must be interrupted by deadline. // // https://github.com/creack/pty/issues/162 // //nolint:paralleltest // Potential in (*os.File).Fd(). func TestReadDeadline(t *testing.T) { t.Skip("Disabling while investigating race.") ptmx, success := prepare(t) if err := ptmx.SetDeadline(time.Now().Add(timeout / 10)); err != nil { if errors.Is(err, os.ErrNoDeadline) { t.Skipf("Deadline is not supported on %s/%s.", runtime.GOOS, runtime.GOARCH) } else { t.Fatalf("Error: set deadline: %s.", err) } } buf := make([]byte, 1) n, err := ptmx.Read(buf) success() if err != nil && !errors.Is(err, os.ErrDeadlineExceeded) { t.Fatalf("Unexpected read error: %s.", err) } if n != 0 && buf[0] != errMarker { t.Errorf("Received unexpected data from pmtx (%d bytes): 0x%X; err=%v.", n, buf, err) } } // Check that ptmx.Close() interrupts outstanding ptmx.Read() calls. // // https://github.com/creack/pty/issues/114 // https://github.com/creack/pty/issues/88 // //nolint:paralleltest // Potential in (*os.File).Fd(). func TestReadClose(t *testing.T) { t.Skip("Disabling while investigating race.") ptmx, success := prepare(t) go func() { time.Sleep(timeout / 10) if err := ptmx.Close(); err != nil { t.Errorf("Failed to close ptmx: %s.", err) } }() buf := make([]byte, 1) n, err := ptmx.Read(buf) success() if err != nil && !errors.Is(err, os.ErrClosed) { t.Fatalf("Unexpected read error: %s.", err) } if n != 0 && buf[0] != errMarker { t.Errorf("Received unexpected data from pmtx (%d bytes): 0x%X; err=%v.", n, buf, err) } } // Open pty and setup watchdogs for graceful and not so graceful failure modes. func prepare(t *testing.T) (ptmx *os.File, done func()) { t.Helper() if runtime.GOOS == "darwin" { t.Log("creack/pty uses blocking i/o on darwin intentionally:") t.Log("> https://github.com/creack/pty/issues/52") t.Log("> https://github.com/creack/pty/pull/53") t.Log("> https://github.com/golang/go/issues/22099") t.SkipNow() } // Due to data race potential in (*os.File).Fd() // we should never run these two tests in parallel. glTestFdLock.Lock() t.Cleanup(glTestFdLock.Unlock) ptmx, pts, err := Open() if err != nil { t.Fatalf("Error: open: %s.\n", err) } t.Cleanup(func() { _ = ptmx.Close() }) t.Cleanup(func() { _ = pts.Close() }) ctx, done := context.WithCancel(context.Background()) t.Cleanup(done) go func() { select { case <-ctx.Done(): // ptmx.Read() did not block forever, yay! case <-time.After(timeout): if _, err := pts.Write([]byte{errMarker}); err != nil { // Unblock ptmx.Read(). t.Errorf("Failed to write to pts: %s.", err) } t.Error("ptmx.Read() was not unblocked.") done() // Cancel panic(). } }() go func() { select { case <-ctx.Done(): // Test has either failed or succeeded; it definitely did not hang. case <-time.After(timeout * 10 / 9): // Timeout + 11%. panic("ptmx.Read() was not unblocked; avoid hanging forever.") // Just in case. } }() return ptmx, done } pty-1.1.21/ioctl.go000066400000000000000000000011161452543226200140550ustar00rootroot00000000000000//go:build !windows && go1.12 // +build !windows,go1.12 package pty import "os" func ioctl(f *os.File, cmd, ptr uintptr) error { return ioctlInner(f.Fd(), cmd, ptr) // Fall back to blocking io. } // NOTE: Unused. Keeping for reference. func ioctlNonblock(f *os.File, cmd, ptr uintptr) error { sc, e := f.SyscallConn() if e != nil { return ioctlInner(f.Fd(), cmd, ptr) // Fall back to blocking io (old behavior). } ch := make(chan error, 1) defer close(ch) e = sc.Control(func(fd uintptr) { ch <- ioctlInner(fd, cmd, ptr) }) if e != nil { return e } e = <-ch return e } pty-1.1.21/ioctl_bsd.go000066400000000000000000000022161452543226200147070ustar00rootroot00000000000000//go:build darwin || dragonfly || freebsd || netbsd || openbsd // +build darwin dragonfly freebsd netbsd openbsd package pty // from const ( _IOC_VOID uintptr = 0x20000000 _IOC_OUT uintptr = 0x40000000 _IOC_IN uintptr = 0x80000000 _IOC_IN_OUT uintptr = _IOC_OUT | _IOC_IN _IOC_DIRMASK = _IOC_VOID | _IOC_OUT | _IOC_IN _IOC_PARAM_SHIFT = 13 _IOC_PARAM_MASK = (1 << _IOC_PARAM_SHIFT) - 1 ) func _IOC_PARM_LEN(ioctl uintptr) uintptr { return (ioctl >> 16) & _IOC_PARAM_MASK } func _IOC(inout uintptr, group byte, ioctl_num uintptr, param_len uintptr) uintptr { return inout | (param_len&_IOC_PARAM_MASK)<<16 | uintptr(group)<<8 | ioctl_num } func _IO(group byte, ioctl_num uintptr) uintptr { return _IOC(_IOC_VOID, group, ioctl_num, 0) } func _IOR(group byte, ioctl_num uintptr, param_len uintptr) uintptr { return _IOC(_IOC_OUT, group, ioctl_num, param_len) } func _IOW(group byte, ioctl_num uintptr, param_len uintptr) uintptr { return _IOC(_IOC_IN, group, ioctl_num, param_len) } func _IOWR(group byte, ioctl_num uintptr, param_len uintptr) uintptr { return _IOC(_IOC_IN_OUT, group, ioctl_num, param_len) } pty-1.1.21/ioctl_inner.go000066400000000000000000000005511452543226200152520ustar00rootroot00000000000000//go:build !windows && !solaris && !aix // +build !windows,!solaris,!aix package pty import "syscall" // Local syscall const values. const ( TIOCGWINSZ = syscall.TIOCGWINSZ TIOCSWINSZ = syscall.TIOCSWINSZ ) func ioctlInner(fd, cmd, ptr uintptr) error { _, _, e := syscall.Syscall(syscall.SYS_IOCTL, fd, cmd, ptr) if e != 0 { return e } return nil } pty-1.1.21/ioctl_legacy.go000066400000000000000000000003301452543226200153760ustar00rootroot00000000000000//go:build !windows && !go1.12 // +build !windows,!go1.12 package pty import "os" func ioctl(f *os.File, cmd, ptr uintptr) error { return ioctlInner(f.Fd(), cmd, ptr) // fall back to blocking io (old behavior) } pty-1.1.21/ioctl_solaris.go000066400000000000000000000021071452543226200156120ustar00rootroot00000000000000//go:build solaris // +build solaris package pty import ( "syscall" "unsafe" ) //go:cgo_import_dynamic libc_ioctl ioctl "libc.so" //go:linkname procioctl libc_ioctl var procioctl uintptr const ( // see /usr/include/sys/stropts.h I_PUSH = uintptr((int32('S')<<8 | 002)) I_STR = uintptr((int32('S')<<8 | 010)) I_FIND = uintptr((int32('S')<<8 | 013)) // see /usr/include/sys/ptms.h ISPTM = (int32('P') << 8) | 1 UNLKPT = (int32('P') << 8) | 2 PTSSTTY = (int32('P') << 8) | 3 ZONEPT = (int32('P') << 8) | 4 OWNERPT = (int32('P') << 8) | 5 // see /usr/include/sys/termios.h TIOCSWINSZ = (uint32('T') << 8) | 103 TIOCGWINSZ = (uint32('T') << 8) | 104 ) type strioctl struct { icCmd int32 icTimeout int32 icLen int32 icDP unsafe.Pointer } // Defined in asm_solaris_amd64.s. func sysvicall6(trap, nargs, a1, a2, a3, a4, a5, a6 uintptr) (r1, r2 uintptr, err syscall.Errno) func ioctlInner(fd, cmd, ptr uintptr) error { if _, _, errno := sysvicall6(uintptr(unsafe.Pointer(&procioctl)), 3, fd, cmd, ptr, 0, 0, 0); errno != 0 { return errno } return nil } pty-1.1.21/ioctl_unsupported.go000066400000000000000000000002351452543226200165260ustar00rootroot00000000000000//go:build aix // +build aix package pty const ( TIOCGWINSZ = 0 TIOCSWINSZ = 0 ) func ioctlInner(fd, cmd, ptr uintptr) error { return ErrUnsupported } pty-1.1.21/mktypes.bash000077500000000000000000000005201452543226200147500ustar00rootroot00000000000000#!/usr/bin/env bash GOOSARCH="${GOOS}_${GOARCH}" case "$GOOSARCH" in _* | *_ | _) echo 'undefined $GOOS_$GOARCH:' "$GOOSARCH" 1>&2 exit 1 ;; esac GODEFS="go tool cgo -godefs" $GODEFS types.go |gofmt > ztypes_$GOARCH.go case $GOOS in freebsd|dragonfly|netbsd|openbsd) $GODEFS types_$GOOS.go |gofmt > ztypes_$GOOSARCH.go ;; esac pty-1.1.21/pty_darwin.go000066400000000000000000000024011452543226200151210ustar00rootroot00000000000000//go:build darwin // +build darwin package pty import ( "errors" "os" "syscall" "unsafe" ) func open() (pty, tty *os.File, err error) { pFD, err := syscall.Open("/dev/ptmx", syscall.O_RDWR|syscall.O_CLOEXEC, 0) if err != nil { return nil, nil, err } p := os.NewFile(uintptr(pFD), "/dev/ptmx") // In case of error after this point, make sure we close the ptmx fd. defer func() { if err != nil { _ = p.Close() // Best effort. } }() sname, err := ptsname(p) if err != nil { return nil, nil, err } if err := grantpt(p); err != nil { return nil, nil, err } if err := unlockpt(p); err != nil { return nil, nil, err } t, err := os.OpenFile(sname, os.O_RDWR|syscall.O_NOCTTY, 0) if err != nil { return nil, nil, err } return p, t, nil } func ptsname(f *os.File) (string, error) { n := make([]byte, _IOC_PARM_LEN(syscall.TIOCPTYGNAME)) err := ioctl(f, syscall.TIOCPTYGNAME, uintptr(unsafe.Pointer(&n[0]))) if err != nil { return "", err } for i, c := range n { if c == 0 { return string(n[:i]), nil } } return "", errors.New("TIOCPTYGNAME string not NUL-terminated") } func grantpt(f *os.File) error { return ioctl(f, syscall.TIOCPTYGRANT, 0) } func unlockpt(f *os.File) error { return ioctl(f, syscall.TIOCPTYUNLK, 0) } pty-1.1.21/pty_dragonfly.go000066400000000000000000000031071452543226200156260ustar00rootroot00000000000000//go:build dragonfly // +build dragonfly package pty import ( "errors" "os" "strings" "syscall" "unsafe" ) // same code as pty_darwin.go func open() (pty, tty *os.File, err error) { p, err := os.OpenFile("/dev/ptmx", os.O_RDWR, 0) if err != nil { return nil, nil, err } // In case of error after this point, make sure we close the ptmx fd. defer func() { if err != nil { _ = p.Close() // Best effort. } }() sname, err := ptsname(p) if err != nil { return nil, nil, err } if err := grantpt(p); err != nil { return nil, nil, err } if err := unlockpt(p); err != nil { return nil, nil, err } t, err := os.OpenFile(sname, os.O_RDWR, 0) if err != nil { return nil, nil, err } return p, t, nil } func grantpt(f *os.File) error { _, err := isptmaster(f) return err } func unlockpt(f *os.File) error { _, err := isptmaster(f) return err } func isptmaster(f *os.File) (bool, error) { err := ioctl(f, syscall.TIOCISPTMASTER, 0) return err == nil, err } var ( emptyFiodgnameArg fiodgnameArg ioctl_FIODNAME = _IOW('f', 120, unsafe.Sizeof(emptyFiodgnameArg)) ) func ptsname(f *os.File) (string, error) { name := make([]byte, _C_SPECNAMELEN) fa := fiodgnameArg{Name: (*byte)(unsafe.Pointer(&name[0])), Len: _C_SPECNAMELEN, Pad_cgo_0: [4]byte{0, 0, 0, 0}} err := ioctl(f, ioctl_FIODNAME, uintptr(unsafe.Pointer(&fa))) if err != nil { return "", err } for i, c := range name { if c == 0 { s := "/dev/" + string(name[:i]) return strings.Replace(s, "ptm", "pts", -1), nil } } return "", errors.New("TIOCPTYGNAME string not NUL-terminated") } pty-1.1.21/pty_freebsd.go000066400000000000000000000030371452543226200152550ustar00rootroot00000000000000//go:build freebsd // +build freebsd package pty import ( "errors" "os" "syscall" "unsafe" ) func posixOpenpt(oflag int) (fd int, err error) { r0, _, e1 := syscall.Syscall(syscall.SYS_POSIX_OPENPT, uintptr(oflag), 0, 0) fd = int(r0) if e1 != 0 { err = e1 } return fd, err } func open() (pty, tty *os.File, err error) { fd, err := posixOpenpt(syscall.O_RDWR | syscall.O_CLOEXEC) if err != nil { return nil, nil, err } p := os.NewFile(uintptr(fd), "/dev/pts") // In case of error after this point, make sure we close the pts fd. defer func() { if err != nil { _ = p.Close() // Best effort. } }() sname, err := ptsname(p) if err != nil { return nil, nil, err } t, err := os.OpenFile("/dev/"+sname, os.O_RDWR, 0) if err != nil { return nil, nil, err } return p, t, nil } func isptmaster(f *os.File) (bool, error) { err := ioctl(f, syscall.TIOCPTMASTER, 0) return err == nil, err } var ( emptyFiodgnameArg fiodgnameArg ioctlFIODGNAME = _IOW('f', 120, unsafe.Sizeof(emptyFiodgnameArg)) ) func ptsname(f *os.File) (string, error) { master, err := isptmaster(f) if err != nil { return "", err } if !master { return "", syscall.EINVAL } const n = _C_SPECNAMELEN + 1 var ( buf = make([]byte, n) arg = fiodgnameArg{Len: n, Buf: (*byte)(unsafe.Pointer(&buf[0]))} ) if err := ioctl(f, ioctlFIODGNAME, uintptr(unsafe.Pointer(&arg))); err != nil { return "", err } for i, c := range buf { if c == 0 { return string(buf[:i]), nil } } return "", errors.New("FIODGNAME string not NUL-terminated") } pty-1.1.21/pty_linux.go000066400000000000000000000022561452543226200150040ustar00rootroot00000000000000//go:build linux // +build linux package pty import ( "os" "strconv" "syscall" "unsafe" ) func open() (pty, tty *os.File, err error) { p, err := os.OpenFile("/dev/ptmx", os.O_RDWR, 0) if err != nil { return nil, nil, err } // In case of error after this point, make sure we close the ptmx fd. defer func() { if err != nil { _ = p.Close() // Best effort. } }() sname, err := ptsname(p) if err != nil { return nil, nil, err } if err := unlockpt(p); err != nil { return nil, nil, err } t, err := os.OpenFile(sname, os.O_RDWR|syscall.O_NOCTTY, 0) //nolint:gosec // Expected Open from a variable. if err != nil { return nil, nil, err } return p, t, nil } func ptsname(f *os.File) (string, error) { var n _C_uint err := ioctl(f, syscall.TIOCGPTN, uintptr(unsafe.Pointer(&n))) //nolint:gosec // Expected unsafe pointer for Syscall call. if err != nil { return "", err } return "/dev/pts/" + strconv.Itoa(int(n)), nil } func unlockpt(f *os.File) error { var u _C_int // use TIOCSPTLCK with a pointer to zero to clear the lock. return ioctl(f, syscall.TIOCSPTLCK, uintptr(unsafe.Pointer(&u))) //nolint:gosec // Expected unsafe pointer for Syscall call. } pty-1.1.21/pty_netbsd.go000066400000000000000000000026011452543226200151160ustar00rootroot00000000000000//go:build netbsd // +build netbsd package pty import ( "errors" "os" "syscall" "unsafe" ) func open() (pty, tty *os.File, err error) { p, err := os.OpenFile("/dev/ptmx", os.O_RDWR, 0) if err != nil { return nil, nil, err } // In case of error after this point, make sure we close the ptmx fd. defer func() { if err != nil { _ = p.Close() // Best effort. } }() sname, err := ptsname(p) if err != nil { return nil, nil, err } if err := grantpt(p); err != nil { return nil, nil, err } // In NetBSD unlockpt() does nothing, so it isn't called here. t, err := os.OpenFile(sname, os.O_RDWR|syscall.O_NOCTTY, 0) if err != nil { return nil, nil, err } return p, t, nil } func ptsname(f *os.File) (string, error) { /* * from ptsname(3): The ptsname() function is equivalent to: * struct ptmget pm; * ioctl(fd, TIOCPTSNAME, &pm) == -1 ? NULL : pm.sn; */ var ptm ptmget if err := ioctl(f, uintptr(ioctl_TIOCPTSNAME), uintptr(unsafe.Pointer(&ptm))); err != nil { return "", err } name := make([]byte, len(ptm.Sn)) for i, c := range ptm.Sn { name[i] = byte(c) if c == 0 { return string(name[:i]), nil } } return "", errors.New("TIOCPTSNAME string not NUL-terminated") } func grantpt(f *os.File) error { /* * from grantpt(3): Calling grantpt() is equivalent to: * ioctl(fd, TIOCGRANTPT, 0); */ return ioctl(f, uintptr(ioctl_TIOCGRANTPT), 0) } pty-1.1.21/pty_openbsd.go000066400000000000000000000017331452543226200152760ustar00rootroot00000000000000//go:build openbsd // +build openbsd package pty import ( "os" "syscall" "unsafe" ) func cInt8ToString(in []int8) string { var s []byte for _, v := range in { if v == 0 { break } s = append(s, byte(v)) } return string(s) } func open() (pty, tty *os.File, err error) { /* * from ptm(4): * The PTMGET command allocates a free pseudo terminal, changes its * ownership to the caller, revokes the access privileges for all previous * users, opens the file descriptors for the pty and tty devices and * returns them to the caller in struct ptmget. */ p, err := os.OpenFile("/dev/ptm", os.O_RDWR|syscall.O_CLOEXEC, 0) if err != nil { return nil, nil, err } defer p.Close() var ptm ptmget if err := ioctl(p, uintptr(ioctl_PTMGET), uintptr(unsafe.Pointer(&ptm))); err != nil { return nil, nil, err } pty = os.NewFile(uintptr(ptm.Cfd), cInt8ToString(ptm.Cn[:])) tty = os.NewFile(uintptr(ptm.Sfd), cInt8ToString(ptm.Sn[:])) return pty, tty, nil } pty-1.1.21/pty_solaris.go000066400000000000000000000071341452543226200153210ustar00rootroot00000000000000//go:build solaris // +build solaris package pty /* based on: http://src.illumos.org/source/xref/illumos-gate/usr/src/lib/libc/port/gen/pt.c */ import ( "errors" "os" "strconv" "syscall" "unsafe" ) func open() (pty, tty *os.File, err error) { ptmxfd, err := syscall.Open("/dev/ptmx", syscall.O_RDWR|syscall.O_NOCTTY, 0) if err != nil { return nil, nil, err } p := os.NewFile(uintptr(ptmxfd), "/dev/ptmx") // In case of error after this point, make sure we close the ptmx fd. defer func() { if err != nil { _ = p.Close() // Best effort. } }() sname, err := ptsname(p) if err != nil { return nil, nil, err } if err := grantpt(p); err != nil { return nil, nil, err } if err := unlockpt(p); err != nil { return nil, nil, err } ptsfd, err := syscall.Open(sname, os.O_RDWR|syscall.O_NOCTTY, 0) if err != nil { return nil, nil, err } t := os.NewFile(uintptr(ptsfd), sname) // In case of error after this point, make sure we close the pts fd. defer func() { if err != nil { _ = t.Close() // Best effort. } }() // pushing terminal driver STREAMS modules as per pts(7) for _, mod := range []string{"ptem", "ldterm", "ttcompat"} { if err := streamsPush(t, mod); err != nil { return nil, nil, err } } return p, t, nil } func ptsname(f *os.File) (string, error) { dev, err := ptsdev(f) if err != nil { return "", err } fn := "/dev/pts/" + strconv.FormatInt(int64(dev), 10) if err := syscall.Access(fn, 0); err != nil { return "", err } return fn, nil } func unlockpt(f *os.File) error { istr := strioctl{ icCmd: UNLKPT, icTimeout: 0, icLen: 0, icDP: nil, } return ioctl(f, I_STR, uintptr(unsafe.Pointer(&istr))) } func minor(x uint64) uint64 { return x & 0377 } func ptsdev(f *os.File) (uint64, error) { istr := strioctl{ icCmd: ISPTM, icTimeout: 0, icLen: 0, icDP: nil, } if err := ioctl(f, I_STR, uintptr(unsafe.Pointer(&istr))); err != nil { return 0, err } var errors = make(chan error, 1) var results = make(chan uint64, 1) defer close(errors) defer close(results) var err error var sc syscall.RawConn sc, err = f.SyscallConn() if err != nil { return 0, err } err = sc.Control(func(fd uintptr) { var status syscall.Stat_t if err := syscall.Fstat(int(fd), &status); err != nil { results <- 0 errors <- err } results <- uint64(minor(status.Rdev)) errors <- nil }) if err != nil { return 0, err } return <-results, <-errors } type ptOwn struct { rUID int32 rGID int32 } func grantpt(f *os.File) error { if _, err := ptsdev(f); err != nil { return err } pto := ptOwn{ rUID: int32(os.Getuid()), // XXX should first attempt to get gid of DEFAULT_TTY_GROUP="tty" rGID: int32(os.Getgid()), } istr := strioctl{ icCmd: OWNERPT, icTimeout: 0, icLen: int32(unsafe.Sizeof(strioctl{})), icDP: unsafe.Pointer(&pto), } if err := ioctl(f, I_STR, uintptr(unsafe.Pointer(&istr))); err != nil { return errors.New("access denied") } return nil } // streamsPush pushes STREAMS modules if not already done so. func streamsPush(f *os.File, mod string) error { buf := []byte(mod) // XXX I_FIND is not returning an error when the module // is already pushed even though truss reports a return // value of 1. A bug in the Go Solaris syscall interface? // XXX without this we are at risk of the issue // https://www.illumos.org/issues/9042 // but since we are not using libc or XPG4.2, we should not be // double-pushing modules if err := ioctl(f, I_FIND, uintptr(unsafe.Pointer(&buf[0]))); err != nil { return nil } return ioctl(f, I_PUSH, uintptr(unsafe.Pointer(&buf[0]))) } pty-1.1.21/pty_unsupported.go000066400000000000000000000004211452543226200162250ustar00rootroot00000000000000//go:build !linux && !darwin && !freebsd && !dragonfly && !netbsd && !openbsd && !solaris // +build !linux,!darwin,!freebsd,!dragonfly,!netbsd,!openbsd,!solaris package pty import ( "os" ) func open() (pty, tty *os.File, err error) { return nil, nil, ErrUnsupported } pty-1.1.21/run.go000066400000000000000000000026241452543226200135540ustar00rootroot00000000000000package pty import ( "os" "os/exec" "syscall" ) // Start assigns a pseudo-terminal tty os.File to c.Stdin, c.Stdout, // and c.Stderr, calls c.Start, and returns the File of the tty's // corresponding pty. // // Starts the process in a new session and sets the controlling terminal. func Start(cmd *exec.Cmd) (*os.File, error) { return StartWithSize(cmd, nil) } // StartWithAttrs assigns a pseudo-terminal tty os.File to c.Stdin, c.Stdout, // and c.Stderr, calls c.Start, and returns the File of the tty's // corresponding pty. // // This will resize the pty to the specified size before starting the command if a size is provided. // The `attrs` parameter overrides the one set in c.SysProcAttr. // // This should generally not be needed. Used in some edge cases where it is needed to create a pty // without a controlling terminal. func StartWithAttrs(c *exec.Cmd, sz *Winsize, attrs *syscall.SysProcAttr) (*os.File, error) { pty, tty, err := Open() if err != nil { return nil, err } defer func() { _ = tty.Close() }() // Best effort. if sz != nil { if err := Setsize(pty, sz); err != nil { _ = pty.Close() // Best effort. return nil, err } } if c.Stdout == nil { c.Stdout = tty } if c.Stderr == nil { c.Stderr = tty } if c.Stdin == nil { c.Stdin = tty } c.SysProcAttr = attrs if err := c.Start(); err != nil { _ = pty.Close() // Best effort. return nil, err } return pty, err } pty-1.1.21/start.go000066400000000000000000000012361452543226200141030ustar00rootroot00000000000000//go:build !windows // +build !windows package pty import ( "os" "os/exec" "syscall" ) // StartWithSize assigns a pseudo-terminal tty os.File to c.Stdin, c.Stdout, // and c.Stderr, calls c.Start, and returns the File of the tty's // corresponding pty. // // This will resize the pty to the specified size before starting the command. // Starts the process in a new session and sets the controlling terminal. func StartWithSize(cmd *exec.Cmd, ws *Winsize) (*os.File, error) { if cmd.SysProcAttr == nil { cmd.SysProcAttr = &syscall.SysProcAttr{} } cmd.SysProcAttr.Setsid = true cmd.SysProcAttr.Setctty = true return StartWithAttrs(cmd, ws, cmd.SysProcAttr) } pty-1.1.21/start_windows.go000066400000000000000000000007621452543226200156600ustar00rootroot00000000000000//go:build windows // +build windows package pty import ( "os" "os/exec" ) // StartWithSize assigns a pseudo-terminal tty os.File to c.Stdin, c.Stdout, // and c.Stderr, calls c.Start, and returns the File of the tty's // corresponding pty. // // This will resize the pty to the specified size before starting the command. // Starts the process in a new session and sets the controlling terminal. func StartWithSize(cmd *exec.Cmd, ws *Winsize) (*os.File, error) { return nil, ErrUnsupported } pty-1.1.21/test_crosscompile.sh000077500000000000000000000036661452543226200165300ustar00rootroot00000000000000#!/usr/bin/env sh # Test script checking that all expected os/arch compile properly. # Does not actually test the logic, just the compilation so we make sure we don't break code depending on the lib. echo2() { echo $@ >&2 } trap end 0 end() { [ "$?" = 0 ] && echo2 "Pass." || (echo2 "Fail."; exit 1) } cross() { os=$1 shift echo2 "Build for $os." for arch in $@; do echo2 " - $os/$arch" GOOS=$os GOARCH=$arch go build done echo2 } set -e cross linux amd64 386 arm arm64 ppc64 ppc64le s390x mips mipsle mips64 mips64le riscv64 cross darwin amd64 arm64 cross freebsd amd64 386 arm arm64 riscv64 cross netbsd amd64 386 arm arm64 cross openbsd amd64 386 arm arm64 cross dragonfly amd64 cross solaris amd64 # Not expected to work but should still compile. cross windows amd64 386 arm # TODO: Fix compilation error on openbsd/arm. # TODO: Merge the solaris PR. # Some os/arch require a different compiler. Run in docker. if ! hash docker; then # If docker is not present, stop here. return fi # Golang dropped support for darwin 32bits since go1.15. Make sure the lib still compile with go1.14 on those archs. echo2 "Build for darwin (32bits)." echo2 " - darwin/386" docker build -t creack-pty-test -f Dockerfile.golang --build-arg=GOVERSION=1.14 --build-arg=GOOS=darwin --build-arg=GOARCH=386 . echo2 " - darwin/arm" docker build -t creack-pty-test -f Dockerfile.golang --build-arg=GOVERSION=1.14 --build-arg=GOOS=darwin --build-arg=GOARCH=arm . # Run a single test for an old go version. Would be best with go1.0, but not available on Dockerhub. # Using 1.6 as it is the base version for the RISCV compiler. # Would also be better to run all the tests, not just one, need to refactor this file to allow for specifc archs per version. echo2 "Build for linux - go1.6." echo2 " - linux/amd64" docker build -t creack-pty-test -f Dockerfile.golang --build-arg=GOVERSION=1.6 --build-arg=GOOS=linux --build-arg=GOARCH=amd64 . pty-1.1.21/types.go000066400000000000000000000001451452543226200141100ustar00rootroot00000000000000//go:build ignore // +build ignore package pty import "C" type ( _C_int C.int _C_uint C.uint ) pty-1.1.21/types_dragonfly.go000066400000000000000000000004121452543226200161520ustar00rootroot00000000000000//go:build ignore // +build ignore package pty /* #define _KERNEL #include #include #include */ import "C" const ( _C_SPECNAMELEN = C.SPECNAMELEN /* max length of devicename */ ) type fiodgnameArg C.struct_fiodname_args pty-1.1.21/types_freebsd.go000066400000000000000000000003441452543226200156030ustar00rootroot00000000000000//go:build ignore // +build ignore package pty /* #include #include */ import "C" const ( _C_SPECNAMELEN = C.SPECNAMELEN /* max length of devicename */ ) type fiodgnameArg C.struct_fiodgname_arg pty-1.1.21/types_netbsd.go000066400000000000000000000003551452543226200154520ustar00rootroot00000000000000//go:build ignore // +build ignore package pty /* #include #include #include */ import "C" type ptmget C.struct_ptmget var ( ioctl_TIOCPTSNAME = C.TIOCPTSNAME ioctl_TIOCGRANTPT = C.TIOCGRANTPT ) pty-1.1.21/types_openbsd.go000066400000000000000000000002731452543226200156240ustar00rootroot00000000000000//go:build ignore // +build ignore package pty /* #include #include #include */ import "C" type ptmget C.struct_ptmget var ioctl_PTMGET = C.PTMGET pty-1.1.21/winsize.go000066400000000000000000000011741452543226200144370ustar00rootroot00000000000000package pty import "os" // InheritSize applies the terminal size of pty to tty. This should be run // in a signal handler for syscall.SIGWINCH to automatically resize the tty when // the pty receives a window size change notification. func InheritSize(pty, tty *os.File) error { size, err := GetsizeFull(pty) if err != nil { return err } return Setsize(tty, size) } // Getsize returns the number of rows (lines) and cols (positions // in each line) in terminal t. func Getsize(t *os.File) (rows, cols int, err error) { ws, err := GetsizeFull(t) if err != nil { return 0, 0, err } return int(ws.Rows), int(ws.Cols), nil } pty-1.1.21/winsize_unix.go000066400000000000000000000015511452543226200155010ustar00rootroot00000000000000//go:build !windows // +build !windows package pty import ( "os" "syscall" "unsafe" ) // Winsize describes the terminal size. type Winsize struct { Rows uint16 // ws_row: Number of rows (in cells). Cols uint16 // ws_col: Number of columns (in cells). X uint16 // ws_xpixel: Width in pixels. Y uint16 // ws_ypixel: Height in pixels. } // Setsize resizes t to s. func Setsize(t *os.File, ws *Winsize) error { //nolint:gosec // Expected unsafe pointer for Syscall call. return ioctl(t, syscall.TIOCSWINSZ, uintptr(unsafe.Pointer(ws))) } // GetsizeFull returns the full terminal size description. func GetsizeFull(t *os.File) (size *Winsize, err error) { var ws Winsize //nolint:gosec // Expected unsafe pointer for Syscall call. if err := ioctl(t, syscall.TIOCGWINSZ, uintptr(unsafe.Pointer(&ws))); err != nil { return nil, err } return &ws, nil } pty-1.1.21/winsize_unsupported.go000066400000000000000000000006521452543226200171070ustar00rootroot00000000000000//go:build windows // +build windows package pty import ( "os" ) // Winsize is a dummy struct to enable compilation on unsupported platforms. type Winsize struct { Rows, Cols, X, Y uint16 } // Setsize resizes t to s. func Setsize(*os.File, *Winsize) error { return ErrUnsupported } // GetsizeFull returns the full terminal size description. func GetsizeFull(*os.File) (*Winsize, error) { return nil, ErrUnsupported } pty-1.1.21/ztypes_386.go000066400000000000000000000002241452543226200147000ustar00rootroot00000000000000//go:build 386 // +build 386 // Created by cgo -godefs - DO NOT EDIT // cgo -godefs types.go package pty type ( _C_int int32 _C_uint uint32 ) pty-1.1.21/ztypes_amd64.go000066400000000000000000000002301452543226200152700ustar00rootroot00000000000000//go:build amd64 // +build amd64 // Created by cgo -godefs - DO NOT EDIT // cgo -godefs types.go package pty type ( _C_int int32 _C_uint uint32 ) pty-1.1.21/ztypes_arm.go000066400000000000000000000002241452543226200151370ustar00rootroot00000000000000//go:build arm // +build arm // Created by cgo -godefs - DO NOT EDIT // cgo -godefs types.go package pty type ( _C_int int32 _C_uint uint32 ) pty-1.1.21/ztypes_arm64.go000066400000000000000000000002301452543226200153060ustar00rootroot00000000000000//go:build arm64 // +build arm64 // Created by cgo -godefs - DO NOT EDIT // cgo -godefs types.go package pty type ( _C_int int32 _C_uint uint32 ) pty-1.1.21/ztypes_dragonfly_amd64.go000066400000000000000000000004061452543226200173420ustar00rootroot00000000000000//go:build amd64 && dragonfly // +build amd64,dragonfly // Created by cgo -godefs - DO NOT EDIT // cgo -godefs types_dragonfly.go package pty const ( _C_SPECNAMELEN = 0x3f ) type fiodgnameArg struct { Name *byte Len uint32 Pad_cgo_0 [4]byte } pty-1.1.21/ztypes_freebsd_386.go000066400000000000000000000003341452543226200163740ustar00rootroot00000000000000//go:build 386 && freebsd // +build 386,freebsd // Created by cgo -godefs - DO NOT EDIT // cgo -godefs types_freebsd.go package pty const ( _C_SPECNAMELEN = 0x3f ) type fiodgnameArg struct { Len int32 Buf *byte } pty-1.1.21/ztypes_freebsd_amd64.go000066400000000000000000000003771452543226200167760ustar00rootroot00000000000000//go:build amd64 && freebsd // +build amd64,freebsd // Created by cgo -godefs - DO NOT EDIT // cgo -godefs types_freebsd.go package pty const ( _C_SPECNAMELEN = 0x3f ) type fiodgnameArg struct { Len int32 Pad_cgo_0 [4]byte Buf *byte } pty-1.1.21/ztypes_freebsd_arm.go000066400000000000000000000003341452543226200166330ustar00rootroot00000000000000//go:build arm && freebsd // +build arm,freebsd // Created by cgo -godefs - DO NOT EDIT // cgo -godefs types_freebsd.go package pty const ( _C_SPECNAMELEN = 0x3f ) type fiodgnameArg struct { Len int32 Buf *byte } pty-1.1.21/ztypes_freebsd_arm64.go000066400000000000000000000003531452543226200170060ustar00rootroot00000000000000//go:build arm64 && freebsd // +build arm64,freebsd // Code generated by cmd/cgo -godefs; DO NOT EDIT. // cgo -godefs types_freebsd.go package pty const ( _C_SPECNAMELEN = 0xff ) type fiodgnameArg struct { Len int32 Buf *byte } pty-1.1.21/ztypes_freebsd_ppc64.go000066400000000000000000000003121452543226200170040ustar00rootroot00000000000000// Created by cgo -godefs - DO NOT EDIT // cgo -godefs types_freebsd.go package pty const ( _C_SPECNAMELEN = 0x3f ) type fiodgnameArg struct { Len int32 Pad_cgo_0 [4]byte Buf *byte } pty-1.1.21/ztypes_freebsd_riscv64.go000066400000000000000000000002661452543226200173600ustar00rootroot00000000000000// Code generated by cmd/cgo -godefs; DO NOT EDIT. // cgo -godefs types_freebsd.go package pty const ( _C_SPECNAMELEN = 0x3f ) type fiodgnameArg struct { Len int32 Buf *byte } pty-1.1.21/ztypes_loong64.go000066400000000000000000000002341452543226200156510ustar00rootroot00000000000000//go:build loong64 // +build loong64 // Created by cgo -godefs - DO NOT EDIT // cgo -godefs types.go package pty type ( _C_int int32 _C_uint uint32 ) pty-1.1.21/ztypes_mipsx.go000066400000000000000000000003501452543226200155200ustar00rootroot00000000000000//go:build (mips || mipsle || mips64 || mips64le) && linux // +build mips mipsle mips64 mips64le // +build linux // Created by cgo -godefs - DO NOT EDIT // cgo -godefs types.go package pty type ( _C_int int32 _C_uint uint32 ) pty-1.1.21/ztypes_netbsd_32bit_int.go000066400000000000000000000004071452543226200175170ustar00rootroot00000000000000//go:build (386 || amd64 || arm || arm64) && netbsd // +build 386 amd64 arm arm64 // +build netbsd package pty type ptmget struct { Cfd int32 Sfd int32 Cn [1024]int8 Sn [1024]int8 } var ( ioctl_TIOCPTSNAME = 0x48087448 ioctl_TIOCGRANTPT = 0x20007447 ) pty-1.1.21/ztypes_openbsd_32bit_int.go000066400000000000000000000003541452543226200176730ustar00rootroot00000000000000//go:build (386 || amd64 || arm || arm64 || mips64) && openbsd // +build 386 amd64 arm arm64 mips64 // +build openbsd package pty type ptmget struct { Cfd int32 Sfd int32 Cn [16]int8 Sn [16]int8 } var ioctl_PTMGET = 0x40287401 pty-1.1.21/ztypes_ppc.go000066400000000000000000000001661452543226200151470ustar00rootroot00000000000000// Created by cgo -godefs - DO NOT EDIT // cgo -godefs types.go package pty type ( _C_int int32 _C_uint uint32 ) pty-1.1.21/ztypes_ppc64.go000066400000000000000000000002301452543226200153110ustar00rootroot00000000000000//go:build ppc64 // +build ppc64 // Created by cgo -godefs - DO NOT EDIT // cgo -godefs types.go package pty type ( _C_int int32 _C_uint uint32 ) pty-1.1.21/ztypes_ppc64le.go000066400000000000000000000002341452543226200156360ustar00rootroot00000000000000//go:build ppc64le // +build ppc64le // Created by cgo -godefs - DO NOT EDIT // cgo -godefs types.go package pty type ( _C_int int32 _C_uint uint32 ) pty-1.1.21/ztypes_riscvx.go000066400000000000000000000002661452543226200157040ustar00rootroot00000000000000//go:build riscv || riscv64 // +build riscv riscv64 // Code generated by cmd/cgo -godefs; DO NOT EDIT. // cgo -godefs types.go package pty type ( _C_int int32 _C_uint uint32 ) pty-1.1.21/ztypes_s390x.go000066400000000000000000000002301452543226200152430ustar00rootroot00000000000000//go:build s390x // +build s390x // Created by cgo -godefs - DO NOT EDIT // cgo -godefs types.go package pty type ( _C_int int32 _C_uint uint32 ) pty-1.1.21/ztypes_sparcx.go000066400000000000000000000002661452543226200156660ustar00rootroot00000000000000//go:build sparc || sparc64 // +build sparc sparc64 // Code generated by cmd/cgo -godefs; DO NOT EDIT. // cgo -godefs types.go package pty type ( _C_int int32 _C_uint uint32 )