mirror of
https://github.com/gravitational/teleport.git
synced 2026-10-29 17:58:15 +08:00
Alan Parra
dba49bfad6
Introduce new make targets to check and add license headers to files
("make lint-license" and "make fix-license"). License checking is now a part of
"make lint" as well.
Initial attempts used goheader, but it caused "make lint-go" to become about 9x
slower (if not more), plus it only targets go files. Google's addlicense is fast
enough and targets however many file types we want.
Existing files that were missing licenses got the header added, using the
current year as the license date.
* Introduce lint-license and fix-license make targets
* Ignore generated files
* Add license to go files
* Replace irregular licenses with standard copyright/license
* Add license to proto files
* Install addlicense in build.assets Dockerfile
86 lines
2.5 KiB
Go
86 lines
2.5 KiB
Go
// Copyright 2021 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 (
|
|
"bufio"
|
|
"os"
|
|
"strings"
|
|
|
|
"github.com/gravitational/teleport"
|
|
|
|
log "github.com/sirupsen/logrus"
|
|
)
|
|
|
|
// ReadEnvironmentFile will read environment variables from a passed in location.
|
|
// Lines that start with "#" or empty lines are ignored. Assignments are in the
|
|
// form name=value and no variable expansion occurs.
|
|
func ReadEnvironmentFile(filename string) ([]string, error) {
|
|
// open the users environment file. if we don't find a file, move on as
|
|
// having this file for the user is optional.
|
|
file, err := os.Open(filename)
|
|
if err != nil {
|
|
log.Warnf("Unable to open environment file %v: %v, skipping", filename, err)
|
|
return []string{}, nil
|
|
}
|
|
defer file.Close()
|
|
|
|
var lineno int
|
|
var envs []string
|
|
|
|
scanner := bufio.NewScanner(file)
|
|
for scanner.Scan() {
|
|
line := strings.TrimSpace(scanner.Text())
|
|
|
|
// follow the lead of OpenSSH and don't allow more than 1,000 environment variables
|
|
// https://github.com/openssh/openssh-portable/blob/master/session.c#L873-L874
|
|
lineno = lineno + 1
|
|
if lineno > teleport.MaxEnvironmentFileLines {
|
|
log.Warnf("Too many lines in environment file %v, returning first %v lines", filename, teleport.MaxEnvironmentFileLines)
|
|
return envs, nil
|
|
}
|
|
|
|
// empty lines or lines that start with # are ignored
|
|
if line == "" || line[0] == '#' {
|
|
continue
|
|
}
|
|
|
|
// split on first =, if not found, log it and continue
|
|
idx := strings.Index(line, "=")
|
|
if idx == -1 {
|
|
log.Debugf("Bad line %v while reading %v: no = separator found", lineno, filename)
|
|
continue
|
|
}
|
|
|
|
// split key and value and make sure that key has a name
|
|
key := line[:idx]
|
|
value := line[idx+1:]
|
|
if strings.TrimSpace(key) == "" {
|
|
log.Debugf("Bad line %v while reading %v: key without name", lineno, filename)
|
|
continue
|
|
}
|
|
|
|
envs = append(envs, key+"="+value)
|
|
}
|
|
|
|
err = scanner.Err()
|
|
if err != nil {
|
|
log.Warnf("Unable to read environment file %v: %v, skipping", filename, err)
|
|
return []string{}, nil
|
|
}
|
|
|
|
return envs, nil
|
|
}
|