mirror of
https://github.com/gravitational/teleport.git
synced 2026-11-02 06:08:23 +08:00
Alan Parra
a75fcc21d8
Update metalinter, fix a few lint warnings and replace deprecated linters. `deadcode`, `structcheck` and `varcheck` are abandoned and now replaced by [`unused`][1]. Since 1.19, `go fmt` reformats godocs according to https://go.dev/doc/comment. I've done a bulk-reformatting of the codebase to keep the linter happy. Backporting is mostly harmless (the exception being `lib/services/role_test.go`, that for some reason breaks the _old_ linter using the new format). [1]: https://golangci-lint.run/usage/linters/ * Bump golangci-lint version * Replace abandoned linters * Fix bodyclose on lib/auth/github.com * Fix bodyclose on lib/kube/proxy/streamproto/proto_test.go * Fix bodyclose on lib/srv/alpnproxy/proxy_test.go * Fix bodyclose on lib/web/conn_upgrade_test.go * Silence staticcheck on lib/kube/proxy/forwarder_test.go * Silence staticcheck on lib/utils/certs_test.go * Address BuildNameToCertificate deprecation warnings * Run `go fmt ./...` * Run `go fmt ./...` on api/ * Ignore formatting in role_test.go * Remove redundant initializers in lib/srv/uacc/ * Update e/
66 lines
2.1 KiB
Go
66 lines
2.1 KiB
Go
/*
|
|
Copyright 2015 Gravitational, Inc.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
|
|
*/
|
|
|
|
package utils
|
|
|
|
import (
|
|
"net"
|
|
"time"
|
|
)
|
|
|
|
// TimeoutConn wraps an existing net.Conn and adds read/write timeouts
|
|
// for it, allowing to implement "disconnect after XX of idle time" policy
|
|
//
|
|
// Usage example:
|
|
// tc := utils.ObeyIdleTimeout(conn, time.Second * 30, "ssh connection")
|
|
// io.Copy(tc, xxx)
|
|
type TimeoutConn struct {
|
|
net.Conn
|
|
TimeoutDuration time.Duration
|
|
|
|
// Name is only useful for debugging/logging, it's a convenient
|
|
// way to tag every idle connection
|
|
OwnerName string
|
|
}
|
|
|
|
// ObeyIdleTimeout wraps an existing network connection with timeout-obeying
|
|
// Write() and Read() - it will drop the connection after 'timeout' on idle
|
|
//
|
|
// Example:
|
|
// ObeyIdletimeout(conn, time.Second * 60, "api server").
|
|
func ObeyIdleTimeout(conn net.Conn, timeout time.Duration, ownerName string) net.Conn {
|
|
return &TimeoutConn{
|
|
Conn: conn,
|
|
TimeoutDuration: timeout,
|
|
OwnerName: ownerName,
|
|
}
|
|
}
|
|
|
|
func (tc *TimeoutConn) Read(p []byte) (n int, err error) {
|
|
// note: checking for errors here does not buy anything: some net.Conn interface
|
|
// implementations (sshConn, pipe) simply return "not supported" error
|
|
tc.Conn.SetReadDeadline(time.Now().Add(tc.TimeoutDuration))
|
|
return tc.Conn.Read(p)
|
|
}
|
|
|
|
func (tc *TimeoutConn) Write(p []byte) (n int, err error) {
|
|
// note: checking for errors here does not buy anything: some net.Conn interface
|
|
// implementations (sshConn, pipe) simply return "not supported" error
|
|
tc.Conn.SetWriteDeadline(time.Now().Add(tc.TimeoutDuration))
|
|
return tc.Conn.Write(p)
|
|
}
|