Myzel394/config-lsp
1
0
Fork 0
mirror of https://github.com/Myzel394/config-lsp.git synced 2025-06-19 07:25:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

chore: Improve structure; fix diagnostics bugs

Browse Source
This commit is contained in:
Myzel394 2024-07-30 21:00:55 +02:00
parent 4d7297e7b9
commit 33c32e4dd1
No known key found for this signature in database
GPG Key ID: DEC4AAB876F73185
27 changed files with 797 additions and 680 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
:w Normal file
View File

@ -0,0 +1,28 @@
package common
import docvalues "config-lsp/doc-values"
func AnalyzeValues(
parser SimpleConfigParser,
availableOptions map[string]Option,
) []docvalues.ValueError {
errors := make([]docvalues.ValueError, 0)
for optionName, line := range parser.Lines {
documentationOption := availableOptions[optionName]
err := documentationOption.Value.CheckIsValid(line.Value)
if err != nil {
errors = append(errors, docvalues.ValueError{
Line: line.Position.Line,
Option: optionName,
Value: line.Value,
DocError: err,
})
}
}
return errors
}

11
common/analyzer.go
View File

@ -1,10 +1,14 @@
package common package common
import (
docvalues "config-lsp/doc-values"
)
func AnalyzeValues( func AnalyzeValues(
parser SimpleConfigParser, parser SimpleConfigParser,
availableOptions map[string]Option, availableOptions map[string]Option,
) []ValueError { ) []docvalues.ValueError {
errors := make([]ValueError, 0) errors := make([]docvalues.ValueError, 0)
for optionName, line := range parser.Lines { for optionName, line := range parser.Lines {
documentationOption := availableOptions[optionName] documentationOption := availableOptions[optionName]
@ -12,7 +16,7 @@ func AnalyzeValues(
err := documentationOption.Value.CheckIsValid(line.Value) err := documentationOption.Value.CheckIsValid(line.Value)
if err != nil { if err != nil {
errors = append(errors, ValueError{ errors = append(errors, docvalues.ValueError{
Line: line.Position.Line, Line: line.Position.Line,
Option: optionName, Option: optionName,
Value: line.Value, Value: line.Value,
@ -23,4 +27,3 @@ func AnalyzeValues(
return errors return errors
} }

3
common/diagnostics.go
View File

@ -30,7 +30,7 @@ func DiagnoseOption(
uri protocol.DocumentUri, uri protocol.DocumentUri,
parser *SimpleConfigParser, parser *SimpleConfigParser,
optionName string, optionName string,
checkerFunc func (string, SimpleConfigPosition) []protocol.Diagnostic, checkerFunc func(string, SimpleConfigPosition) []protocol.Diagnostic,
) []protocol.Diagnostic { ) []protocol.Diagnostic {
option, err := parser.GetOption(optionName) option, err := parser.GetOption(optionName)
@ -41,4 +41,3 @@ func DiagnoseOption(
return checkerFunc(option.Value, option.Position) return checkerFunc(option.Value, option.Position)
} }

332
common/documentation.go
View File

@ -1,341 +1,15 @@
package common package common
import ( import (
"fmt" docvalues "config-lsp/doc-values"
"strconv"
"strings" "strings"
protocol "github.com/tliron/glsp/protocol_3_16" protocol "github.com/tliron/glsp/protocol_3_16"
) )
type Value interface {
GetTypeDescription() []string
CheckIsValid(value string) error
}
type EnumValue struct {
Values []string
// If `true`, the value MUST be one of the values in the Values array
// Otherwise an error is shown
// If `false`, the value is just a hint
EnforceValues bool
}
func (v EnumValue) GetTypeDescription() []string {
if len(v.Values) == 1 {
return []string{fmt.Sprintf("'%s'", v.Values[0])}
}
lines := make([]string, len(v.Values)+1)
lines[0] = "Enum of:"
for index, value := range v.Values {
lines[index+1] += "\t* " + value
}
return lines
}
func (v EnumValue) CheckIsValid(value string) error {
if !v.EnforceValues {
return nil
}
for _, validValue := range v.Values {
if validValue == value {
return nil
}
}
return ValueNotInEnumError{
ProvidedValue: value,
AvailableValues: v.Values,
}
}
type PositiveNumberValue struct{}
func (v PositiveNumberValue) GetTypeDescription() []string {
return []string{"Positive number"}
}
func (v PositiveNumberValue) CheckIsValid(value string) error {
number, err := strconv.Atoi(value)
if err != nil {
return NotANumberError{}
}
if number < 0 {
return NumberIsNotPositiveError{}
}
return nil
}
var SimpleDuplicatesExtractor = func(value string) string {
return value
}
var ExtractKeyDuplicatesExtractor = func(separator string) func(string) string {
return func(value string) string {
splitted := strings.Split(value, separator)
if len(splitted) == 0 {
return ""
}
return splitted[0]
}
}
var DuplicatesAllowedExtractor func(string) string = nil
type ArrayValue struct {
SubValue Value
Separator string
// If this function is nil, no duplicate check is done
// (value) => Extracted value
// This is used to extract the value from the user input,
// because you may want to preprocess the value before checking for duplicates
DuplicatesExtractor *(func(string) string)
}
func (v ArrayValue) GetTypeDescription() []string {
subValue := v.SubValue.(Value)
return append(
[]string{fmt.Sprintf("An Array separated by '%s' of:", v.Separator)},
subValue.GetTypeDescription()...,
)
}
func (v ArrayValue) CheckIsValid(value string) error {
values := strings.Split(value, v.Separator)
if v.DuplicatesExtractor != nil {
valuesOccurrences := SliceToMap(
Map(values, *v.DuplicatesExtractor),
0,
)
// Only continue if there are actually duplicate values
if len(values) != len(valuesOccurrences) {
for _, duplicateRawValue := range values {
duplicateValue := (*v.DuplicatesExtractor)(duplicateRawValue)
valuesOccurrences[duplicateValue]++
}
duplicateValues := FilterMapWhere(valuesOccurrences, func(_ string, value int) bool {
return value > 1
})
return ArrayContainsDuplicatesError{
Duplicates: KeysOfMap(duplicateValues),
}
}
}
for _, subValue := range values {
err := v.SubValue.CheckIsValid(subValue)
if err != nil {
return err
}
}
return nil
}
type OrValue struct {
Values []Value
}
func (v OrValue) GetTypeDescription() []string {
lines := make([]string, 0)
for _, subValueRaw := range v.Values {
subValue := subValueRaw.(Value)
subLines := subValue.GetTypeDescription()
for index, line := range subLines {
if strings.HasPrefix(line, "\t*") {
subLines[index] = "\t" + line
} else {
subLines[index] = "\t* " + line
}
}
lines = append(lines, subLines...)
}
return append(
[]string{"One of:"},
lines...,
)
}
func (v OrValue) CheckIsValid(value string) error {
var firstError error = nil
for _, subValue := range v.Values {
err := subValue.CheckIsValid(value)
if err == nil {
return nil
} else if firstError == nil {
firstError = err
}
}
return firstError
}
type StringValue struct{}
func (v StringValue) GetTypeDescription() []string {
return []string{"String"}
}
func (v StringValue) CheckIsValid(value string) error {
if value == "" {
return EmptyStringError{}
}
return nil
}
type CustomValue struct {
FetchValue func() Value
}
func (v CustomValue) GetTypeDescription() []string {
return []string{"Custom"}
}
func (v CustomValue) CheckIsValid(value string) error {
return v.FetchValue().CheckIsValid(value)
}
type Prefix struct {
Prefix string
Meaning string
}
type PrefixWithMeaningValue struct {
Prefixes []Prefix
SubValue Value
}
func (v PrefixWithMeaningValue) GetTypeDescription() []string {
subDescription := v.SubValue.GetTypeDescription()
prefixDescription := Map(v.Prefixes, func(prefix Prefix) string {
return fmt.Sprintf("_%s_ -> %s", prefix.Prefix, prefix.Meaning)
})
return append(subDescription,
append(
[]string{"The following prefixes are allowed:"},
prefixDescription...,
)...,
)
}
func (v PrefixWithMeaningValue) CheckIsValid(value string) error {
return v.SubValue.CheckIsValid(value)
}
type PathType uint8
const (
PathTypeExistenceOptional PathType = 0
PathTypeFile PathType = 1
PathTypeDirectory PathType = 2
)
type PathValue struct {
RequiredType PathType
}
func (v PathValue) GetTypeDescription() []string {
hints := make([]string, 0)
switch v.RequiredType {
case PathTypeExistenceOptional:
hints = append(hints, "Optional")
break
case PathTypeFile:
hints = append(hints, "File")
case PathTypeDirectory:
hints = append(hints, "Directory")
}
return []string{strings.Join(hints, ", ")}
}
func (v PathValue) CheckIsValid(value string) error {
if !DoesPathExist(value) {
return PathDoesNotExistError{}
}
isValid := false
if (v.RequiredType & PathTypeFile) == PathTypeFile {
isValid = isValid && IsPathFile(value)
}
if (v.RequiredType & PathTypeDirectory) == PathTypeDirectory {
isValid = isValid && IsPathDirectory(value)
}
if isValid {
return nil
}
return PathInvalidError{}
}
type KeyValueAssignmentValue struct {
Key Value
Value Value
Separator string
}
func (v KeyValueAssignmentValue) GetTypeDescription() []string {
return []string{
fmt.Sprintf("Key-Value pair in form of 'key%svalue'", v.Separator),
fmt.Sprintf("#### Key\n%s", strings.Join(v.Key.GetTypeDescription(), "\n")),
fmt.Sprintf("#### Value:\n%s", strings.Join(v.Value.GetTypeDescription(), "\n")),
}
}
func (v KeyValueAssignmentValue) CheckIsValid(value string) error {
parts := strings.Split(value, v.Separator)
if len(parts) == 1 && parts[0] == "" {
return nil
}
if len(parts) != 2 {
return KeyValueAssignmentError{}
}
err := v.Key.CheckIsValid(parts[0])
if err != nil {
return err
}
err = v.Value.CheckIsValid(parts[1])
if err != nil {
return err
}
return nil
}
type Option struct { type Option struct {
Documentation string Documentation string
Value Value Value docvalues.Value
} }
func GetDocumentation(o *Option) protocol.MarkupContent { func GetDocumentation(o *Option) protocol.MarkupContent {
@ -347,6 +21,6 @@ func GetDocumentation(o *Option) protocol.MarkupContent {
} }
} }
func NewOption(documentation string, value Value) Option { func NewOption(documentation string, value docvalues.Value) Option {
return Option{documentation, value} return Option{documentation, value}
} }

1
common/index.go Normal file
View File

@ -0,0 +1 @@
package common

18
common/parser.go
View File

@ -1,6 +1,7 @@
package common package common
import ( import (
docvalues "config-lsp/doc-values"
"regexp" "regexp"
"strings" "strings"
) )
@ -14,7 +15,6 @@ type SimpleConfigLine struct {
Position SimpleConfigPosition Position SimpleConfigPosition
} }
type SimpleConfigOptions struct { type SimpleConfigOptions struct {
Separator string Separator string
IgnorePattern regexp.Regexp IgnorePattern regexp.Regexp
@ -30,13 +30,13 @@ func (p *SimpleConfigParser) AddLine(line string, lineNumber uint32) (string, er
parts := strings.SplitN(line, p.Options.Separator, 2) parts := strings.SplitN(line, p.Options.Separator, 2)
if len(parts) == 0 { if len(parts) == 0 {
return "", MalformedLineError{} return "", docvalues.MalformedLineError{}
} }
option := parts[0] option := parts[0]
if _, exists := (*p.Options.AvailableOptions)[option]; !exists { if _, exists := (*p.Options.AvailableOptions)[option]; !exists {
return option, OptionUnknownError{} return option, docvalues.OptionUnknownError{}
} }
value := "" value := ""
@ -46,7 +46,7 @@ func (p *SimpleConfigParser) AddLine(line string, lineNumber uint32) (string, er
} }
if _, exists := p.Lines[option]; exists { if _, exists := p.Lines[option]; exists {
return option, OptionAlreadyExistsError{ return option, docvalues.OptionAlreadyExistsError{
AlreadyLine: p.Lines[option].Position.Line, AlreadyLine: p.Lines[option].Position.Line,
} }
} }
@ -94,12 +94,12 @@ func (p *SimpleConfigParser) GetOption(option string) (SimpleConfigLine, error)
Line: 0, Line: 0,
}, },
}, },
OptionUnknownError{} docvalues.OptionUnknownError{}
} }
func (p *SimpleConfigParser) ParseFromFile(content string) []OptionError { func (p *SimpleConfigParser) ParseFromFile(content string) []docvalues.OptionError {
lines := strings.Split(content, "\n") lines := strings.Split(content, "\n")
errors := make([]OptionError, 0) errors := make([]docvalues.OptionError, 0)
for index, line := range lines { for index, line := range lines {
if p.Options.IgnorePattern.MatchString(line) { if p.Options.IgnorePattern.MatchString(line) {
@ -109,7 +109,7 @@ func (p *SimpleConfigParser) ParseFromFile(content string) []OptionError {
option, err := p.AddLine(line, uint32(index)) option, err := p.AddLine(line, uint32(index))
if err != nil { if err != nil {
errors = append(errors, OptionError{ errors = append(errors, docvalues.OptionError{
Line: uint32(index), Line: uint32(index),
ProvidedOption: option, ProvidedOption: option,
DocError: err, DocError: err,
@ -132,5 +132,5 @@ func (p *SimpleConfigParser) FindByLineNumber(lineNumber uint32) (string, Simple
} }
} }
return "", SimpleConfigLine{Value: "", Position: SimpleConfigPosition{Line: 0}}, LineNotFoundError{} return "", SimpleConfigLine{Value: "", Position: SimpleConfigPosition{Line: 0}}, docvalues.LineNotFoundError{}
} }

11
doc-values/base-value.go Normal file
View File

@ -0,0 +1,11 @@
package docvalues
import (
protocol "github.com/tliron/glsp/protocol_3_16"
)
type Value interface {
GetTypeDescription() []string
CheckIsValid(value string) error
FetchCompletions(line string, cursor uint32) []protocol.CompletionItem
}

63
common/errors.go → doc-values/errors.go
View File

@ -1,8 +1,7 @@
package common package docvalues
import ( import (
"fmt" "fmt"
"strings"
"unicode/utf8" "unicode/utf8"
protocol "github.com/tliron/glsp/protocol_3_16" protocol "github.com/tliron/glsp/protocol_3_16"
@ -17,6 +16,7 @@ type OptionError struct {
ProvidedOption string ProvidedOption string
DocError error DocError error
} }
func (e OptionError) GetPublishDiagnosticsParams() protocol.Diagnostic { func (e OptionError) GetPublishDiagnosticsParams() protocol.Diagnostic {
severity := protocol.DiagnosticSeverityError severity := protocol.DiagnosticSeverityError
@ -46,6 +46,7 @@ type ValueError struct {
DocError error DocError error
} }
func (e ValueError) GetPublishDiagnosticsParams() protocol.Diagnostic { func (e ValueError) GetPublishDiagnosticsParams() protocol.Diagnostic {
severity := protocol.DiagnosticSeverityError severity := protocol.DiagnosticSeverityError
start := uint32(utf8.RuneCountInString(e.Option) + utf8.RuneCountInString(" ")) start := uint32(utf8.RuneCountInString(e.Option) + utf8.RuneCountInString(" "))
@ -77,13 +78,13 @@ func (e OptionAlreadyExistsError) Error() string {
return fmt.Sprintf("This option is already defined on line %d", e.AlreadyLine) return fmt.Sprintf("This option is already defined on line %d", e.AlreadyLine)
} }
type OptionUnknownError struct {} type OptionUnknownError struct{}
func (e OptionUnknownError) Error() string { func (e OptionUnknownError) Error() string {
return "This option does not exist" return "This option does not exist"
} }
type MalformedLineError struct {} type MalformedLineError struct{}
func (e MalformedLineError) Error() string { func (e MalformedLineError) Error() string {
return "Malformed line" return "Malformed line"
@ -94,57 +95,3 @@ type LineNotFoundError struct{}
func (e LineNotFoundError) Error() string { func (e LineNotFoundError) Error() string {
return "Line not found" return "Line not found"
} }
// Value errors
type ValueNotInEnumError struct {
AvailableValues []string
ProvidedValue string
}
func (e ValueNotInEnumError) Error() string {
return fmt.Sprintf("This value is not valid. Select one from: %s", strings.Join(e.AvailableValues, ","))
}
type NotANumberError struct{}
func (e NotANumberError) Error() string {
return "This must be number"
}
type NumberIsNotPositiveError struct{}
func (e NumberIsNotPositiveError) Error() string {
return "This number must be positive for this setting"
}
type EmptyStringError struct{}
func (e EmptyStringError) Error() string {
return "This setting may not be empty"
}
type ArrayContainsDuplicatesError struct {
Duplicates []string
}
func (e ArrayContainsDuplicatesError) Error() string {
return fmt.Sprintf("The following values are duplicated: %s", strings.Join(e.Duplicates, ","))
}
type PathDoesNotExistError struct{}
func (e PathDoesNotExistError) Error() string {
return "This path does not exist"
}
type KeyValueAssignmentError struct{}
func (e KeyValueAssignmentError) Error() string {
return "This is not valid key-value assignment"
}
type PathInvalidError struct{}
func (e PathInvalidError) Error() string {
return "This path is invalid"
}

5
common/extra-values.go → doc-values/extra-values.go
View File

@ -1,6 +1,7 @@
package common package docvalues
import ( import (
"config-lsp/utils"
"os" "os"
"strings" "strings"
) )
@ -63,7 +64,7 @@ func UserValue(separatorForMultiple string, enforceValues bool) Value {
enumValues := EnumValue{ enumValues := EnumValue{
EnforceValues: enforceValues, EnforceValues: enforceValues,
Values: Map(infos, func(info passwdInfo) string { Values: utils.Map(infos, func(info passwdInfo) string {
return info.Name return info.Name
}), }),
} }

101
doc-values/value-array.go Normal file
View File

@ -0,0 +1,101 @@
package docvalues
import (
"config-lsp/utils"
"fmt"
"strings"
protocol "github.com/tliron/glsp/protocol_3_16"
)
type ArrayContainsDuplicatesError struct {
Duplicates []string
}
func (e ArrayContainsDuplicatesError) Error() string {
return fmt.Sprintf("The following values are duplicated: %s", strings.Join(e.Duplicates, ","))
}
var SimpleDuplicatesExtractor = func(value string) string {
return value
}
var ExtractKeyDuplicatesExtractor = func(separator string) func(string) string {
return func(value string) string {
splitted := strings.Split(value, separator)
if len(splitted) == 0 {
return ""
}
return splitted[0]
}
}
var DuplicatesAllowedExtractor func(string) string = nil
type ArrayValue struct {
SubValue Value
Separator string
// If this function is nil, no duplicate check is done
// (value) => Extracted value
// This is used to extract the value from the user input,
// because you may want to preprocess the value before checking for duplicates
DuplicatesExtractor *(func(string) string)
}
func (v ArrayValue) GetTypeDescription() []string {
subValue := v.SubValue.(Value)
return append(
[]string{fmt.Sprintf("An Array separated by '%s' of:", v.Separator)},
subValue.GetTypeDescription()...,
)
}
func (v ArrayValue) CheckIsValid(value string) error {
values := strings.Split(value, v.Separator)
if v.DuplicatesExtractor != nil {
valuesOccurrences := utils.SliceToMap(
utils.Map(values, *v.DuplicatesExtractor),
0,
)
// Only continue if there are actually duplicate values
if len(values) != len(valuesOccurrences) {
for _, duplicateRawValue := range values {
duplicateValue := (*v.DuplicatesExtractor)(duplicateRawValue)
valuesOccurrences[duplicateValue]++
}
duplicateValues := utils.FilterMapWhere(valuesOccurrences, func(_ string, value int) bool {
return value > 1
})
return ArrayContainsDuplicatesError{
Duplicates: utils.KeysOfMap(duplicateValues),
}
}
}
for _, subValue := range values {
err := v.SubValue.CheckIsValid(subValue)
if err != nil {
return err
}
}
return nil
}
func (v ArrayValue) FetchCompletions(line string, cursor uint32) []protocol.CompletionItem {
relativePosition, found := utils.FindPreviousCharacter(line, v.Separator, int(cursor-1))
if found {
line = line[uint32(relativePosition):]
cursor -= uint32(relativePosition)
}
return v.SubValue.FetchCompletions(line, cursor)
}

21
doc-values/value-custom.go Normal file
View File

@ -0,0 +1,21 @@
package docvalues
import (
protocol "github.com/tliron/glsp/protocol_3_16"
)
type CustomValue struct {
FetchValue func() Value
}
func (v CustomValue) GetTypeDescription() []string {
return []string{"Custom"}
}
func (v CustomValue) CheckIsValid(value string) error {
return v.FetchValue().CheckIsValid(value)
}
func (v CustomValue) FetchCompletions(line string, cursor uint32) []protocol.CompletionItem {
return v.FetchValue().FetchCompletions(line, cursor)
}

73
doc-values/value-enum.go Normal file
View File

@ -0,0 +1,73 @@
package docvalues
import (
"fmt"
"strings"
protocol "github.com/tliron/glsp/protocol_3_16"
)
type ValueNotInEnumError struct {
AvailableValues []string
ProvidedValue string
}
func (e ValueNotInEnumError) Error() string {
return fmt.Sprintf("This value is not valid. Select one from: %s", strings.Join(e.AvailableValues, ","))
}
type EnumValue struct {
Values []string
// If `true`, the value MUST be one of the values in the Values array
// Otherwise an error is shown
// If `false`, the value is just a hint
EnforceValues bool
}
func (v EnumValue) GetTypeDescription() []string {
if len(v.Values) == 1 {
return []string{fmt.Sprintf("'%s'", v.Values[0])}
}
lines := make([]string, len(v.Values)+1)
lines[0] = "Enum of:"
for index, value := range v.Values {
lines[index+1] += "\t* " + value
}
return lines
}
func (v EnumValue) CheckIsValid(value string) error {
if !v.EnforceValues {
return nil
}
for _, validValue := range v.Values {
if validValue == value {
return nil
}
}
return ValueNotInEnumError{
ProvidedValue: value,
AvailableValues: v.Values,
}
}
func (v EnumValue) FetchCompletions(line string, cursor uint32) []protocol.CompletionItem {
completions := make([]protocol.CompletionItem, len(v.Values))
for index, value := range v.Values {
textFormat := protocol.InsertTextFormatPlainText
kind := protocol.CompletionItemKindEnum
completions[index] = protocol.CompletionItem{
Label: value,
InsertTextFormat: &textFormat,
Kind: &kind,
}
}
return completions
}

68
doc-values/value-key-value-assignment.go Normal file
View File

@ -0,0 +1,68 @@
package docvalues
import (
"config-lsp/utils"
"fmt"
"strings"
protocol "github.com/tliron/glsp/protocol_3_16"
)
type KeyValueAssignmentError struct{}
func (e KeyValueAssignmentError) Error() string {
return "This is not valid key-value assignment"
}
type KeyValueAssignmentValue struct {
Key Value
Value Value
Separator string
}
func (v KeyValueAssignmentValue) GetTypeDescription() []string {
return []string{
fmt.Sprintf("Key-Value pair in form of 'key%svalue'", v.Separator),
fmt.Sprintf("#### Key\n%s", strings.Join(v.Key.GetTypeDescription(), "\n")),
fmt.Sprintf("#### Value:\n%s", strings.Join(v.Value.GetTypeDescription(), "\n")),
}
}
func (v KeyValueAssignmentValue) CheckIsValid(value string) error {
parts := strings.Split(value, v.Separator)
if len(parts) == 1 && parts[0] == "" {
return nil
}
if len(parts) != 2 {
return KeyValueAssignmentError{}
}
err := v.Key.CheckIsValid(parts[0])
if err != nil {
return err
}
err = v.Value.CheckIsValid(parts[1])
if err != nil {
return err
}
return nil
}
func (v KeyValueAssignmentValue) FetchCompletions(line string, cursor uint32) []protocol.CompletionItem {
relativePosition, found := utils.FindPreviousCharacter(line, v.Separator, int(cursor-1))
if found {
line = line[uint32(relativePosition):]
cursor -= uint32(relativePosition)
return v.Value.FetchCompletions(line, cursor)
} else {
return v.Key.FetchCompletions(line, cursor)
}
}

58
doc-values/value-or.go Normal file
View File

@ -0,0 +1,58 @@
package docvalues
import (
protocol "github.com/tliron/glsp/protocol_3_16"
"strings"
)
type OrValue struct {
Values []Value
}
func (v OrValue) GetTypeDescription() []string {
lines := make([]string, 0)
for _, subValueRaw := range v.Values {
subValue := subValueRaw.(Value)
subLines := subValue.GetTypeDescription()
for index, line := range subLines {
if strings.HasPrefix(line, "\t*") {
subLines[index] = "\t" + line
} else {
subLines[index] = "\t* " + line
}
}
lines = append(lines, subLines...)
}
return append(
[]string{"One of:"},
lines...,
)
}
func (v OrValue) CheckIsValid(value string) error {
var firstError error = nil
for _, subValue := range v.Values {
err := subValue.CheckIsValid(value)
if err == nil {
return nil
} else if firstError == nil {
firstError = err
}
}
return firstError
}
func (v OrValue) FetchCompletions(line string, cursor uint32) []protocol.CompletionItem {
completions := make([]protocol.CompletionItem, 0)
for _, subValue := range v.Values {
completions = append(completions, subValue.FetchCompletions(line, cursor)...)
}
return completions
}

73
doc-values/value-path.go Normal file
View File

@ -0,0 +1,73 @@
package docvalues
import (
"config-lsp/utils"
protocol "github.com/tliron/glsp/protocol_3_16"
"strings"
)
type PathDoesNotExistError struct{}
func (e PathDoesNotExistError) Error() string {
return "This path does not exist"
}
type PathInvalidError struct{}
func (e PathInvalidError) Error() string {
return "This path is invalid"
}
type PathType uint8
const (
PathTypeExistenceOptional PathType = 0
PathTypeFile PathType = 1
PathTypeDirectory PathType = 2
)
type PathValue struct {
RequiredType PathType
}
func (v PathValue) GetTypeDescription() []string {
hints := make([]string, 0)
switch v.RequiredType {
case PathTypeExistenceOptional:
hints = append(hints, "Optional")
break
case PathTypeFile:
hints = append(hints, "File")
case PathTypeDirectory:
hints = append(hints, "Directory")
}
return []string{strings.Join(hints, ", ")}
}
func (v PathValue) CheckIsValid(value string) error {
if !utils.DoesPathExist(value) {
return PathDoesNotExistError{}
}
isValid := false
if (v.RequiredType & PathTypeFile) == PathTypeFile {
isValid = isValid && utils.IsPathFile(value)
}
if (v.RequiredType & PathTypeDirectory) == PathTypeDirectory {
isValid = isValid && utils.IsPathDirectory(value)
}
if isValid {
return nil
}
return PathInvalidError{}
}
func (v PathValue) FetchCompletions(line string, cursor uint32) []protocol.CompletionItem {
return []protocol.CompletionItem{}
}

40
doc-values/value-positive-number.go Normal file
View File

@ -0,0 +1,40 @@
package docvalues
import (
protocol "github.com/tliron/glsp/protocol_3_16"
"strconv"
)
type NotANumberError struct{}
func (e NotANumberError) Error() string {
return "This must be number"
}
type NumberIsNotPositiveError struct{}
func (e NumberIsNotPositiveError) Error() string {
return "This number must be positive"
}
type PositiveNumberValue struct{}
func (v PositiveNumberValue) GetTypeDescription() []string {
return []string{"A positive number"}
}
func (v PositiveNumberValue) CheckIsValid(value string) error {
number, err := strconv.Atoi(value)
if err != nil {
return NotANumberError{}
}
if number < 0 {
return NumberIsNotPositiveError{}
}
return nil
}
func (v PositiveNumberValue) FetchCompletions(line string, cursor uint32) []protocol.CompletionItem {
return []protocol.CompletionItem{}
}

51
doc-values/value-prefix.go Normal file
View File

@ -0,0 +1,51 @@
package docvalues
import (
"config-lsp/utils"
"fmt"
protocol "github.com/tliron/glsp/protocol_3_16"
)
type Prefix struct {
Prefix string
Meaning string
}
type PrefixWithMeaningValue struct {
Prefixes []Prefix
SubValue Value
}
func (v PrefixWithMeaningValue) GetTypeDescription() []string {
subDescription := v.SubValue.GetTypeDescription()
prefixDescription := utils.Map(v.Prefixes, func(prefix Prefix) string {
return fmt.Sprintf("_%s_ -> %s", prefix.Prefix, prefix.Meaning)
})
return append(subDescription,
append(
[]string{"The following prefixes are allowed:"},
prefixDescription...,
)...,
)
}
func (v PrefixWithMeaningValue) CheckIsValid(value string) error {
return v.SubValue.CheckIsValid(value)
}
func (v PrefixWithMeaningValue) FetchCompletions(line string, cursor uint32) []protocol.CompletionItem {
textFormat := protocol.InsertTextFormatPlainText
kind := protocol.CompletionItemKindText
prefixCompletions := utils.Map(v.Prefixes, func(prefix Prefix) protocol.CompletionItem {
return protocol.CompletionItem{
Label: prefix.Prefix,
Detail: &prefix.Meaning,
InsertTextFormat: &textFormat,
Kind: &kind,
}
})
return append(prefixCompletions, v.SubValue.FetchCompletions(line, cursor)...)
}

29
doc-values/value-string.go Normal file
View File

@ -0,0 +1,29 @@
package docvalues
import (
protocol "github.com/tliron/glsp/protocol_3_16"
)
type EmptyStringError struct{}
func (e EmptyStringError) Error() string {
return "This setting may not be empty"
}
type StringValue struct{}
func (v StringValue) GetTypeDescription() []string {
return []string{"String"}
}
func (v StringValue) CheckIsValid(value string) error {
if value == "" {
return EmptyStringError{}
}
return nil
}
func (v StringValue) FetchCompletions(line string, cursor uint32) []protocol.CompletionItem {
return []protocol.CompletionItem{}
}

1
handlers/index.go
View File

@ -0,0 +1 @@
package handlers

14
handlers/openssh/diagnose-ssh-options.go
View File

@ -9,7 +9,8 @@ import (
func DiagnoseSSHOptions( func DiagnoseSSHOptions(
context *glsp.Context, context *glsp.Context,
params *protocol.DidChangeTextDocumentParams, documentURI protocol.DocumentUri,
parser *common.SimpleConfigParser,
) []protocol.Diagnostic { ) []protocol.Diagnostic {
diagnostics := make([]protocol.Diagnostic, 0) diagnostics := make([]protocol.Diagnostic, 0)
@ -17,11 +18,11 @@ func DiagnoseSSHOptions(
diagnostics, diagnostics,
common.DiagnoseOption( common.DiagnoseOption(
context, context,
params.TextDocument.URI, documentURI,
&Parser, parser,
"Port", "Port",
func (value string, position common.SimpleConfigPosition) []protocol.Diagnostic { func(value string, position common.SimpleConfigPosition) []protocol.Diagnostic {
if (value == "22") { if value == "22" {
severity := protocol.DiagnosticSeverityWarning severity := protocol.DiagnosticSeverityWarning
return []protocol.Diagnostic{ return []protocol.Diagnostic{
@ -44,9 +45,8 @@ func DiagnoseSSHOptions(
return []protocol.Diagnostic{} return []protocol.Diagnostic{}
}, },
)... )...,
) )
return diagnostics return diagnostics
} }

49
handlers/openssh/diagnostics.go Normal file
View File

@ -0,0 +1,49 @@
package openssh
import (
"config-lsp/common"
docvalues "config-lsp/doc-values"
"config-lsp/utils"
"github.com/tliron/glsp"
protocol "github.com/tliron/glsp/protocol_3_16"
)
func DiagnoseParser(
context *glsp.Context,
documentURI protocol.DocumentUri,
content string,
) []protocol.Diagnostic {
diagnostics := make([]protocol.Diagnostic, 0)
diagnostics = append(
diagnostics,
utils.Map(
Parser.ParseFromFile(content),
func(err docvalues.OptionError) protocol.Diagnostic {
return err.GetPublishDiagnosticsParams()
},
)...,
)
diagnostics = append(
diagnostics,
utils.Map(
common.AnalyzeValues(Parser, Options),
func(err docvalues.ValueError) protocol.Diagnostic {
return err.GetPublishDiagnosticsParams()
},
)...,
)
diagnostics = append(
diagnostics,
DiagnoseSSHOptions(
context,
documentURI,
&Parser,
)...,
)
return diagnostics
}

21
handlers/openssh/documentation-utils.go
View File

@ -1,17 +1,17 @@
package openssh package openssh
import ( import (
"config-lsp/common" docvalues "config-lsp/doc-values"
"os/exec" "os/exec"
"strings" "strings"
) )
var BooleanEnumValue = common.EnumValue{ var BooleanEnumValue = docvalues.EnumValue{
EnforceValues: true, EnforceValues: true,
Values: []string{"yes", "no"}, Values: []string{"yes", "no"},
} }
var plusMinuxCaretPrefixes = []common.Prefix{ var plusMinuxCaretPrefixes = []docvalues.Prefix{
{ {
Prefix: "+", Prefix: "+",
Meaning: "Append to the default set", Meaning: "Append to the default set",
@ -26,11 +26,11 @@ var plusMinuxCaretPrefixes = []common.Prefix{
}, },
} }
var ChannelTimeoutExtractor = common.ExtractKeyDuplicatesExtractor("=") var ChannelTimeoutExtractor = docvalues.ExtractKeyDuplicatesExtractor("=")
func PrefixPlusMinusCaret(values []string) common.PrefixWithMeaningValue { func PrefixPlusMinusCaret(values []string) docvalues.PrefixWithMeaningValue {
return common.PrefixWithMeaningValue{ return docvalues.PrefixWithMeaningValue{
Prefixes: []common.Prefix{ Prefixes: []docvalues.Prefix{
{ {
Prefix: "+", Prefix: "+",
Meaning: "Append to the default set", Meaning: "Append to the default set",
@ -44,10 +44,10 @@ func PrefixPlusMinusCaret(values []string) common.PrefixWithMeaningValue {
Meaning: "Place at the head of the default set", Meaning: "Place at the head of the default set",
}, },
}, },
SubValue: common.ArrayValue{ SubValue: docvalues.ArrayValue{
Separator: ",", Separator: ",",
DuplicatesExtractor: &common.SimpleDuplicatesExtractor, DuplicatesExtractor: &docvalues.SimpleDuplicatesExtractor,
SubValue: common.EnumValue{ SubValue: docvalues.EnumValue{
Values: values, Values: values,
}, },
}, },
@ -88,4 +88,3 @@ func QueryOpenSSHOptions(
return availableQueries, nil return availableQueries, nil
} }

197
handlers/openssh/documentation.go
View File

@ -2,16 +2,17 @@ package openssh
import ( import (
"config-lsp/common" "config-lsp/common"
docvalues "config-lsp/doc-values"
) )
var Options = map[string]common.Option{ var Options = map[string]common.Option{
"AcceptEnv": common.NewOption( "AcceptEnv": common.NewOption(
`Specifies what environment variables sent by the client will be copied into the session's environ(7). See SendEnv and SetEnv in ssh_config(5) for how to configure the client. The TERM environment variable is always accepted whenever the client requests a pseudo-terminal as it is required by the protocol. Variables are specified by name, which may contain the wildcard characters ‘*’ and ‘?’. Multiple environment variables may be separated by whitespace or spread across multiple AcceptEnv directives. Be warned that some environment variables could be used to bypass restricted user environments. For this reason, care should be taken in the use of this directive. The default is not to accept any environment variables.`, `Specifies what environment variables sent by the client will be copied into the session's environ(7). See SendEnv and SetEnv in ssh_config(5) for how to configure the client. The TERM environment variable is always accepted whenever the client requests a pseudo-terminal as it is required by the protocol. Variables are specified by name, which may contain the wildcard characters ‘*’ and ‘?’. Multiple environment variables may be separated by whitespace or spread across multiple AcceptEnv directives. Be warned that some environment variables could be used to bypass restricted user environments. For this reason, care should be taken in the use of this directive. The default is not to accept any environment variables.`,
common.StringValue{}, docvalues.StringValue{},
), ),
"AddressFamily": common.NewOption( "AddressFamily": common.NewOption(
`Specifies which address family should be used by sshd(8). Valid arguments are any (the default), inet (use IPv4 only), or inet6 (use IPv6 only).`, `Specifies which address family should be used by sshd(8). Valid arguments are any (the default), inet (use IPv4 only), or inet6 (use IPv6 only).`,
common.EnumValue{ docvalues.EnumValue{
EnforceValues: true, EnforceValues: true,
Values: []string{"any", "inet", "inet6"}, Values: []string{"any", "inet", "inet6"},
}, },
@ -24,11 +25,11 @@ var Options = map[string]common.Option{
`This keyword can be followed by a list of group name patterns, separated by spaces. If specified, login is allowed only for users whose primary group or supplementary group list matches one of the patterns. Only group names are valid; a numerical group ID is not recognized. By default, login is allowed for all groups. The allow/deny groups directives are processed in the following order: DenyGroups, AllowGroups. `This keyword can be followed by a list of group name patterns, separated by spaces. If specified, login is allowed only for users whose primary group or supplementary group list matches one of the patterns. Only group names are valid; a numerical group ID is not recognized. By default, login is allowed for all groups. The allow/deny groups directives are processed in the following order: DenyGroups, AllowGroups.
See PATTERNS in ssh_config(5) for more information on patterns. This keyword may appear multiple times in sshd_config with each instance appending to the list.`, See PATTERNS in ssh_config(5) for more information on patterns. This keyword may appear multiple times in sshd_config with each instance appending to the list.`,
common.CustomValue{ docvalues.CustomValue{
FetchValue: func() common.Value { FetchValue: func() docvalues.Value {
return common.ArrayValue{ return docvalues.ArrayValue{
DuplicatesExtractor: &common.SimpleDuplicatesExtractor, DuplicatesExtractor: &docvalues.SimpleDuplicatesExtractor,
SubValue: common.StringValue{}, SubValue: docvalues.StringValue{},
Separator: " ", Separator: " ",
} }
}, },
@ -36,14 +37,14 @@ See PATTERNS in ssh_config(5) for more information on patterns. This keyword may
), ),
"AllowStreamLocalForwarding": common.NewOption( "AllowStreamLocalForwarding": common.NewOption(
`Specifies whether StreamLocal (Unix-domain socket) forwarding is permitted. The available options are yes (the default) or all to allow StreamLocal forwarding, no to prevent all StreamLocal forwarding, local to allow local (from the perspective of ssh(1)) forwarding only or remote to allow remote forwarding only. Note that disabling StreamLocal forwarding does not improve security unless users are also denied shell access, as they can always install their own forwarders.`, `Specifies whether StreamLocal (Unix-domain socket) forwarding is permitted. The available options are yes (the default) or all to allow StreamLocal forwarding, no to prevent all StreamLocal forwarding, local to allow local (from the perspective of ssh(1)) forwarding only or remote to allow remote forwarding only. Note that disabling StreamLocal forwarding does not improve security unless users are also denied shell access, as they can always install their own forwarders.`,
common.EnumValue{ docvalues.EnumValue{
EnforceValues: true, EnforceValues: true,
Values: []string{"yes", "all", "no", "local", "remote"}, Values: []string{"yes", "all", "no", "local", "remote"},
}, },
), ),
"AllowTcpForwarding": common.NewOption( "AllowTcpForwarding": common.NewOption(
`Specifies whether TCP forwarding is permitted. The available options are yes (the default) or all to allow TCP forwarding, no to prevent all TCP forwarding, local to allow local (from the perspective of ssh(1)) forwarding only or remote to allow remote forwarding only. Note that disabling TCP forwarding does not improve security unless users are also denied shell access, as they can always install their own forwarders.`, `Specifies whether TCP forwarding is permitted. The available options are yes (the default) or all to allow TCP forwarding, no to prevent all TCP forwarding, local to allow local (from the perspective of ssh(1)) forwarding only or remote to allow remote forwarding only. Note that disabling TCP forwarding does not improve security unless users are also denied shell access, as they can always install their own forwarders.`,
common.EnumValue{ docvalues.EnumValue{
EnforceValues: true, EnforceValues: true,
Values: []string{"yes", "all", "no", "local", "remote"}, Values: []string{"yes", "all", "no", "local", "remote"},
}, },
@ -51,7 +52,7 @@ See PATTERNS in ssh_config(5) for more information on patterns. This keyword may
"AllowUsers": common.NewOption( "AllowUsers": common.NewOption(
`This keyword can be followed by a list of user name patterns, separated by spaces. If specified, login is allowed only for user names that match one of the patterns. Only user names are valid; a numerical user ID is not recognized. By default, login is allowed for all users. If the pattern takes the form USER@HOST then USER and HOST are separately checked, restricting logins to particular users from particular hosts. HOST criteria may additionally contain addresses to match in CIDR address/masklen format. The allow/deny users directives are processed in the following order: DenyUsers, AllowUsers. `This keyword can be followed by a list of user name patterns, separated by spaces. If specified, login is allowed only for user names that match one of the patterns. Only user names are valid; a numerical user ID is not recognized. By default, login is allowed for all users. If the pattern takes the form USER@HOST then USER and HOST are separately checked, restricting logins to particular users from particular hosts. HOST criteria may additionally contain addresses to match in CIDR address/masklen format. The allow/deny users directives are processed in the following order: DenyUsers, AllowUsers.
See PATTERNS in ssh_config(5) for more information on patterns. This keyword may appear multiple times in sshd_config with each instance appending to the list.`, See PATTERNS in ssh_config(5) for more information on patterns. This keyword may appear multiple times in sshd_config with each instance appending to the list.`,
common.UserValue(" ", false), docvalues.UserValue(" ", false),
), ),
"AuthenticationMethods": common.NewOption( "AuthenticationMethods": common.NewOption(
`Specifies the authentication methods that must be successfully completed for a user to be granted access. This option must be followed by one or more lists of comma-separated authentication method names, or by the single string any to indicate the default behaviour of accepting any single authentication method. If the default is overridden, then successful authentication requires completion of every method in at least one of these lists. `Specifies the authentication methods that must be successfully completed for a user to be granted access. This option must be followed by one or more lists of comma-separated authentication method names, or by the single string any to indicate the default behaviour of accepting any single authentication method. If the default is overridden, then successful authentication requires completion of every method in at least one of these lists.
@ -60,14 +61,14 @@ See PATTERNS in ssh_config(5) for more information on patterns. This keyword may
If the publickey method is listed more than once, sshd(8) verifies that keys that have been used successfully are not reused for subsequent authentications. For example, "publickey,publickey" requires successful authentication using two different public keys.PATTERNS If the publickey method is listed more than once, sshd(8) verifies that keys that have been used successfully are not reused for subsequent authentications. For example, "publickey,publickey" requires successful authentication using two different public keys.PATTERNS
Note that each authentication method listed should also be explicitly enabled in the configuration. Note that each authentication method listed should also be explicitly enabled in the configuration.
The available authentication methods are: "gssapi-with-mic", "hostbased", "keyboard-interactive", "none" (used for access to password-less accounts when PermitEmptyPasswords is enabled), "password" and "publickey".`, The available authentication methods are: "gssapi-with-mic", "hostbased", "keyboard-interactive", "none" (used for access to password-less accounts when PermitEmptyPasswords is enabled), "password" and "publickey".`,
common.OrValue{ docvalues.OrValue{
Values: []common.Value{ Values: []docvalues.Value{
common.EnumValue{ docvalues.EnumValue{
EnforceValues: true, EnforceValues: true,
Values: []string{"any"}, Values: []string{"any"},
}, },
common.ArrayValue{ docvalues.ArrayValue{
SubValue: common.EnumValue{ SubValue: docvalues.EnumValue{
EnforceValues: true, EnforceValues: true,
Values: []string{ Values: []string{
"none", "none",
@ -98,41 +99,41 @@ See PATTERNS in ssh_config(5) for more information on patterns. This keyword may
"AuthorizedKeysCommand": common.NewOption( "AuthorizedKeysCommand": common.NewOption(
`Specifies a program to be used to look up the user's public keys. The program must be owned by root, not writable by group or others and specified by an absolute path. Arguments to AuthorizedKeysCommand accept the tokens described in the “TOKENS” section. If no arguments are specified then the username of the target user is used. `Specifies a program to be used to look up the user's public keys. The program must be owned by root, not writable by group or others and specified by an absolute path. Arguments to AuthorizedKeysCommand accept the tokens described in the “TOKENS” section. If no arguments are specified then the username of the target user is used.
The program should produce on standard output zero or more lines of authorized_keys output (see “AUTHORIZED_KEYS” in sshd(8)). AuthorizedKeysCommand is tried after the usual AuthorizedKeysFile files and will not be executed if a matching key is found there. By default, no AuthorizedKeysCommand is run.`, The program should produce on standard output zero or more lines of authorized_keys output (see “AUTHORIZED_KEYS” in sshd(8)). AuthorizedKeysCommand is tried after the usual AuthorizedKeysFile files and will not be executed if a matching key is found there. By default, no AuthorizedKeysCommand is run.`,
common.StringValue{}, docvalues.StringValue{},
), ),
"AuthorizedKeysCommandUser": common.NewOption( "AuthorizedKeysCommandUser": common.NewOption(
`Specifies the user under whose account the AuthorizedKeysCommand is run. It is recommended to use a dedicated user that has no other role on the host than running authorized keys commands. If AuthorizedKeysCommand is specified but AuthorizedKeysCommandUser is not, then sshd(8) will refuse to start.`, `Specifies the user under whose account the AuthorizedKeysCommand is run. It is recommended to use a dedicated user that has no other role on the host than running authorized keys commands. If AuthorizedKeysCommand is specified but AuthorizedKeysCommandUser is not, then sshd(8) will refuse to start.`,
common.UserValue("", true), docvalues.UserValue("", true),
), ),
"AuthorizedKeysFile": common.NewOption( "AuthorizedKeysFile": common.NewOption(
`Specifies the file that contains the public keys used for user authentication. The format is described in the AUTHORIZED_KEYS FILE FORMAT section of sshd(8). Arguments to AuthorizedKeysFile accept the tokens described in the “TOKENS” section. After expansion, AuthorizedKeysFile is taken to be an absolute path or one relative to the user's home directory. Multiple files may be listed, separated by whitespace. Alternately this option may be set to none to skip checking for user keys in files. The default is ".ssh/authorized_keys .ssh/authorized_keys2".`, `Specifies the file that contains the public keys used for user authentication. The format is described in the AUTHORIZED_KEYS FILE FORMAT section of sshd(8). Arguments to AuthorizedKeysFile accept the tokens described in the “TOKENS” section. After expansion, AuthorizedKeysFile is taken to be an absolute path or one relative to the user's home directory. Multiple files may be listed, separated by whitespace. Alternately this option may be set to none to skip checking for user keys in files. The default is ".ssh/authorized_keys .ssh/authorized_keys2".`,
common.ArrayValue{ docvalues.ArrayValue{
SubValue: common.StringValue{}, SubValue: docvalues.StringValue{},
Separator: " ", Separator: " ",
DuplicatesExtractor: &common.DuplicatesAllowedExtractor, DuplicatesExtractor: &docvalues.DuplicatesAllowedExtractor,
}, },
), ),
"AuthorizedPrincipalsCommand": common.NewOption( "AuthorizedPrincipalsCommand": common.NewOption(
`Specifies a program to be used to generate the list of allowed certificate principals as per AuthorizedPrincipalsFile. The program must be owned by root, not writable by group or others and specified by an absolute path. Arguments to AuthorizedPrincipalsCommand accept the tokens described in the “TOKENS” section. If no arguments are specified then the username of the target user is used. `Specifies a program to be used to generate the list of allowed certificate principals as per AuthorizedPrincipalsFile. The program must be owned by root, not writable by group or others and specified by an absolute path. Arguments to AuthorizedPrincipalsCommand accept the tokens described in the “TOKENS” section. If no arguments are specified then the username of the target user is used.
The program should produce on standard output zero or more lines of AuthorizedPrincipalsFile output. If either AuthorizedPrincipalsCommand or AuthorizedPrincipalsFile is specified, then certificates offered by the client for authentication must contain a principal that is listed. By default, no AuthorizedPrincipalsCommand is run.`, The program should produce on standard output zero or more lines of AuthorizedPrincipalsFile output. If either AuthorizedPrincipalsCommand or AuthorizedPrincipalsFile is specified, then certificates offered by the client for authentication must contain a principal that is listed. By default, no AuthorizedPrincipalsCommand is run.`,
common.StringValue{}, docvalues.StringValue{},
), ),
"AuthorizedPrincipalsCommandUser": common.NewOption( "AuthorizedPrincipalsCommandUser": common.NewOption(
`Specifies the user under whose account the AuthorizedPrincipalsCommand is run. It is recommended to use a dedicated user that has no other role on the host than running authorized principals commands. If AuthorizedPrincipalsCommand is specified but AuthorizedPrincipalsCommandUser is not, then sshd(8) will refuse to start.`, `Specifies the user under whose account the AuthorizedPrincipalsCommand is run. It is recommended to use a dedicated user that has no other role on the host than running authorized principals commands. If AuthorizedPrincipalsCommand is specified but AuthorizedPrincipalsCommandUser is not, then sshd(8) will refuse to start.`,
common.UserValue("", true), docvalues.UserValue("", true),
), ),
"AuthorizedPrincipalsFile": common.NewOption( "AuthorizedPrincipalsFile": common.NewOption(
`Specifies a file that lists principal names that are accepted for certificate authentication. When using certificates signed by a key listed in TrustedUserCAKeys, this file lists names, one of which must appear in the certificate for it to be accepted for authentication. Names are listed one per line preceded by key options (as described in “AUTHORIZED_KEYS FILE FORMAT” in sshd(8)). Empty lines and comments starting with ‘#’ are ignored. `Specifies a file that lists principal names that are accepted for certificate authentication. When using certificates signed by a key listed in TrustedUserCAKeys, this file lists names, one of which must appear in the certificate for it to be accepted for authentication. Names are listed one per line preceded by key options (as described in “AUTHORIZED_KEYS FILE FORMAT” in sshd(8)). Empty lines and comments starting with ‘#’ are ignored.
Arguments to AuthorizedPrincipalsFile accept the tokens described in the “TOKENS” section. After expansion, AuthorizedPrincipalsFile is taken to be an absolute path or one relative to the user's home directory. The default is none, i.e. not to use a principals file – in this case, the username of the user must appear in a certificate's principals list for it to be accepted. Arguments to AuthorizedPrincipalsFile accept the tokens described in the “TOKENS” section. After expansion, AuthorizedPrincipalsFile is taken to be an absolute path or one relative to the user's home directory. The default is none, i.e. not to use a principals file – in this case, the username of the user must appear in a certificate's principals list for it to be accepted.
Note that AuthorizedPrincipalsFile is only used when authentication proceeds using a CA listed in TrustedUserCAKeys and is not consulted for certification authorities trusted via ~/.ssh/authorized_keys, though the principals= key option offers a similar facility (see sshd(8) for details).`, Note that AuthorizedPrincipalsFile is only used when authentication proceeds using a CA listed in TrustedUserCAKeys and is not consulted for certification authorities trusted via ~/.ssh/authorized_keys, though the principals= key option offers a similar facility (see sshd(8) for details).`,
common.PathValue{ docvalues.PathValue{
RequiredType: common.PathTypeFile, RequiredType: docvalues.PathTypeFile,
}, },
), ),
"Banner": common.NewOption(`The contents of the specified file are sent to the remote user before authentication is allowed. If the argument is none then no banner is displayed. By default, no banner is displayed.`, "Banner": common.NewOption(`The contents of the specified file are sent to the remote user before authentication is allowed. If the argument is none then no banner is displayed. By default, no banner is displayed.`,
common.PathValue{ docvalues.PathValue{
RequiredType: common.PathTypeFile, RequiredType: docvalues.PathTypeFile,
}, },
), ),
"CASignatureAlgorithms": common.NewOption( "CASignatureAlgorithms": common.NewOption(
@ -140,8 +141,8 @@ See PATTERNS in ssh_config(5) for more information on patterns. This keyword may
ssh-ed25519,ecdsa-sha2-nistp256, ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, sk-ssh-ed25519@openssh.com, sk-ecdsa-sha2-nistp256@openssh.com, rsa-sha2-512,rsa-sha2-256 ssh-ed25519,ecdsa-sha2-nistp256, ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, sk-ssh-ed25519@openssh.com, sk-ecdsa-sha2-nistp256@openssh.com, rsa-sha2-512,rsa-sha2-256
If the specified list begins with a ‘+’ character, then the specified algorithms will be appended to the default set instead of replacing them. If the specified list begins with a ‘-’ character, then the specified algorithms (including wildcards) will be removed from the default set instead of replacing them. If the specified list begins with a ‘+’ character, then the specified algorithms will be appended to the default set instead of replacing them. If the specified list begins with a ‘-’ character, then the specified algorithms (including wildcards) will be removed from the default set instead of replacing them.
Certificates signed using other algorithms will not be accepted for public key or host-based authentication.`, Certificates signed using other algorithms will not be accepted for public key or host-based authentication.`,
common.PrefixWithMeaningValue{ docvalues.PrefixWithMeaningValue{
Prefixes: []common.Prefix{ Prefixes: []docvalues.Prefix{
{ {
Prefix: "+", Prefix: "+",
Meaning: "Appende to the default set", Meaning: "Appende to the default set",
@ -151,10 +152,10 @@ See PATTERNS in ssh_config(5) for more information on patterns. This keyword may
Meaning: "Remove from the default set", Meaning: "Remove from the default set",
}, },
}, },
SubValue: common.ArrayValue{ SubValue: docvalues.ArrayValue{
Separator: ",", Separator: ",",
DuplicatesExtractor: &common.DuplicatesAllowedExtractor, DuplicatesExtractor: &docvalues.DuplicatesAllowedExtractor,
SubValue: common.StringValue{}, SubValue: docvalues.StringValue{},
}, },
}, },
), ),
@ -173,12 +174,12 @@ See PATTERNS in ssh_config(5) for more information on patterns. This keyword may
Note that in all the above cases, terminating an inactive session does not guarantee to remove all resources associated with the session, e.g. shell processes or X11 clients relating to the session may continue to execute. Note that in all the above cases, terminating an inactive session does not guarantee to remove all resources associated with the session, e.g. shell processes or X11 clients relating to the session may continue to execute.
Moreover, terminating an inactive channel or session does not necessarily close the SSH connection, nor does it prevent a client from requesting another channel of the same type. In particular, expiring an inactive forwarding session does not prevent another identical forwarding from being subsequently created. Moreover, terminating an inactive channel or session does not necessarily close the SSH connection, nor does it prevent a client from requesting another channel of the same type. In particular, expiring an inactive forwarding session does not prevent another identical forwarding from being subsequently created.
The default is not to expire channels of any type for inactivity.`, The default is not to expire channels of any type for inactivity.`,
common.ArrayValue{ docvalues.ArrayValue{
Separator: " ", Separator: " ",
DuplicatesExtractor: &ChannelTimeoutExtractor, DuplicatesExtractor: &ChannelTimeoutExtractor,
SubValue: common.KeyValueAssignmentValue{ SubValue: docvalues.KeyValueAssignmentValue{
Separator: "=", Separator: "=",
Key: common.EnumValue{ Key: docvalues.EnumValue{
Values: []string{ Values: []string{
"global", "global",
"agent-connection", "agent-connection",
@ -189,15 +190,15 @@ See PATTERNS in ssh_config(5) for more information on patterns. This keyword may
"x11-connection", "x11-connection",
}, },
}, },
Value: common.StringValue{}, Value: docvalues.StringValue{},
}, },
}, },
), ),
"ChrootDirectory": common.NewOption(`Specifies the pathname of a directory to chroot(2) to after authentication. At session startup sshd(8) checks that all components of the pathname are root-owned directories which are not writable by group or others. After the chroot, sshd(8) changes the working directory to the user's home directory. Arguments to ChrootDirectory accept the tokens described in the “TOKENS” section. "ChrootDirectory": common.NewOption(`Specifies the pathname of a directory to chroot(2) to after authentication. At session startup sshd(8) checks that all components of the pathname are root-owned directories which are not writable by group or others. After the chroot, sshd(8) changes the working directory to the user's home directory. Arguments to ChrootDirectory accept the tokens described in the “TOKENS” section.
The ChrootDirectory must contain the necessary files and directories to support the user's session. For an interactive session this requires at least a shell, typically sh(1), and basic /dev nodes such as null(4), zero(4), stdin(4), stdout(4), stderr(4), and tty(4) devices. For file transfer sessions using SFTP no additional configuration of the environment is necessary if the in-process sftp-server is used, though sessions which use logging may require /dev/log inside the chroot directory on some operating systems (see sftp-server(8) for details). The ChrootDirectory must contain the necessary files and directories to support the user's session. For an interactive session this requires at least a shell, typically sh(1), and basic /dev nodes such as null(4), zero(4), stdin(4), stdout(4), stderr(4), and tty(4) devices. For file transfer sessions using SFTP no additional configuration of the environment is necessary if the in-process sftp-server is used, though sessions which use logging may require /dev/log inside the chroot directory on some operating systems (see sftp-server(8) for details).
For safety, it is very important that the directory hierarchy be prevented from modification by other processes on the system (especially those outside the jail). Misconfiguration can lead to unsafe environments which sshd(8) cannot detect. For safety, it is very important that the directory hierarchy be prevented from modification by other processes on the system (especially those outside the jail). Misconfiguration can lead to unsafe environments which sshd(8) cannot detect.
The default is none, indicating not to chroot(2).`, The default is none, indicating not to chroot(2).`,
common.StringValue{}, docvalues.StringValue{},
), ),
"Ciphers": common.NewOption(`Specifies the ciphers allowed. Multiple ciphers must be comma-separated. If the specified list begins with a ‘+’ character, then the specified ciphers will be appended to the default set instead of replacing them. If the specified list begins with a ‘-’ character, then the specified ciphers (including wildcards) will be removed from the default set instead of replacing them. If the specified list begins with a ‘^’ character, then the specified ciphers will be placed at the head of the default set. "Ciphers": common.NewOption(`Specifies the ciphers allowed. Multiple ciphers must be comma-separated. If the specified list begins with a ‘+’ character, then the specified ciphers will be appended to the default set instead of replacing them. If the specified list begins with a ‘-’ character, then the specified ciphers (including wildcards) will be removed from the default set instead of replacing them. If the specified list begins with a ‘^’ character, then the specified ciphers will be placed at the head of the default set.
The supported ciphers are: The supported ciphers are:
@ -220,15 +221,15 @@ See PATTERNS in ssh_config(5) for more information on patterns. This keyword may
), ),
"ClientAliveCountMax": common.NewOption(`Sets the number of client alive messages which may be sent without sshd(8) receiving any messages back from the client. If this threshold is reached while client alive messages are being sent, sshd will disconnect the client, terminating the session. It is important to note that the use of client alive messages is very different from TCPKeepAlive. The client alive messages are sent through the encrypted channel and therefore will not be spoofable. The TCP keepalive option enabled by TCPKeepAlive is spoofable. The client alive mechanism is valuable when the client or server depend on knowing when a connection has become unresponsive. "ClientAliveCountMax": common.NewOption(`Sets the number of client alive messages which may be sent without sshd(8) receiving any messages back from the client. If this threshold is reached while client alive messages are being sent, sshd will disconnect the client, terminating the session. It is important to note that the use of client alive messages is very different from TCPKeepAlive. The client alive messages are sent through the encrypted channel and therefore will not be spoofable. The TCP keepalive option enabled by TCPKeepAlive is spoofable. The client alive mechanism is valuable when the client or server depend on knowing when a connection has become unresponsive.
// The default value is 3. If ClientAliveInterval is set to 15, and ClientAliveCountMax is left at the default, unresponsive SSH clients will be disconnected after approximately 45 seconds. Setting a zero ClientAliveCountMax disables connection termination.`, // The default value is 3. If ClientAliveInterval is set to 15, and ClientAliveCountMax is left at the default, unresponsive SSH clients will be disconnected after approximately 45 seconds. Setting a zero ClientAliveCountMax disables connection termination.`,
common.PositiveNumberValue{}, docvalues.PositiveNumberValue{},
), ),
"ClientAliveInterval": common.NewOption( "ClientAliveInterval": common.NewOption(
`Sets a timeout interval in seconds after which if no data has been received from the client, sshd(8) will send a message through the encrypted channel to request a response from the client. The default is 0, indicating that these messages will not be sent to the client.`, `Sets a timeout interval in seconds after which if no data has been received from the client, sshd(8) will send a message through the encrypted channel to request a response from the client. The default is 0, indicating that these messages will not be sent to the client.`,
common.PositiveNumberValue{}, docvalues.PositiveNumberValue{},
), ),
"Compression": common.NewOption( "Compression": common.NewOption(
`Specifies whether compression is enabled after the user has authenticated successfully. The argument must be yes, delayed (a legacy synonym for yes) or no. The default is yes.`, `Specifies whether compression is enabled after the user has authenticated successfully. The argument must be yes, delayed (a legacy synonym for yes) or no. The default is yes.`,
common.EnumValue{ docvalues.EnumValue{
EnforceValues: true, EnforceValues: true,
Values: []string{ Values: []string{
"yes", "yes",
@ -241,7 +242,7 @@ See PATTERNS in ssh_config(5) for more information on patterns. This keyword may
// See PATTERNS in ssh_config(5) for more information on patterns. This keyword may appear multiple times in sshd_config with each instance appending to the list.`, // See PATTERNS in ssh_config(5) for more information on patterns. This keyword may appear multiple times in sshd_config with each instance appending to the list.`,
"DenyUsers": common.NewOption(`This keyword can be followed by a list of user name patterns, separated by spaces. Login is disallowed for user names that match one of the patterns. Only user names are valid; a numerical user ID is not recognized. By default, login is allowed for all users. If the pattern takes the form USER@HOST then USER and HOST are separately checked, restricting logins to particular users from particular hosts. HOST criteria may additionally contain addresses to match in CIDR address/masklen format. The allow/deny users directives are processed in the following order: DenyUsers, AllowUsers. "DenyUsers": common.NewOption(`This keyword can be followed by a list of user name patterns, separated by spaces. Login is disallowed for user names that match one of the patterns. Only user names are valid; a numerical user ID is not recognized. By default, login is allowed for all users. If the pattern takes the form USER@HOST then USER and HOST are separately checked, restricting logins to particular users from particular hosts. HOST criteria may additionally contain addresses to match in CIDR address/masklen format. The allow/deny users directives are processed in the following order: DenyUsers, AllowUsers.
See PATTERNS in ssh_config(5) for more information on patterns. This keyword may appear multiple times in sshd_config with each instance appending to the list.`, See PATTERNS in ssh_config(5) for more information on patterns. This keyword may appear multiple times in sshd_config with each instance appending to the list.`,
common.UserValue(" ", false), docvalues.UserValue(" ", false),
), ),
"DisableForwarding": common.NewOption( "DisableForwarding": common.NewOption(
`Disables all forwarding features, including X11, ssh-agent(1), TCP and StreamLocal. This option overrides all other forwarding-related options and may simplify restricted configurations.`, `Disables all forwarding features, including X11, ssh-agent(1), TCP and StreamLocal. This option overrides all other forwarding-related options and may simplify restricted configurations.`,
@ -253,7 +254,7 @@ See PATTERNS in ssh_config(5) for more information on patterns. This keyword may
), ),
"FingerprintHash": common.NewOption( "FingerprintHash": common.NewOption(
`Specifies the hash algorithm used when logging key fingerprints. Valid options are: md5 and sha256. The default is sha256.`, `Specifies the hash algorithm used when logging key fingerprints. Valid options are: md5 and sha256. The default is sha256.`,
common.EnumValue{ docvalues.EnumValue{
EnforceValues: true, EnforceValues: true,
Values: []string{ Values: []string{
"md5", "md5",
@ -263,7 +264,7 @@ See PATTERNS in ssh_config(5) for more information on patterns. This keyword may
), ),
"ForceCommand": common.NewOption( "ForceCommand": common.NewOption(
`Forces the execution of the command specified by ForceCommand, ignoring any command supplied by the client and ~/.ssh/rc if present. The command is invoked by using the user's login shell with the -c option. This applies to shell, command, or subsystem execution. It is most useful inside a Match block. The command originally supplied by the client is available in the SSH_ORIGINAL_COMMAND environment variable. Specifying a command of internal-sftp will force the use of an in- process SFTP server that requires no support files when used with ChrootDirectory. The default is none.`, `Forces the execution of the command specified by ForceCommand, ignoring any command supplied by the client and ~/.ssh/rc if present. The command is invoked by using the user's login shell with the -c option. This applies to shell, command, or subsystem execution. It is most useful inside a Match block. The command originally supplied by the client is available in the SSH_ORIGINAL_COMMAND environment variable. Specifying a command of internal-sftp will force the use of an in- process SFTP server that requires no support files when used with ChrootDirectory. The default is none.`,
common.StringValue{}, docvalues.StringValue{},
), ),
"GatewayPorts": common.NewOption( "GatewayPorts": common.NewOption(
`Specifies whether remote hosts are allowed to connect to ports forwarded for the client. By default, sshd(8) binds remote port forwardings to the loopback address. This prevents other remote hosts from connecting to forwarded ports. GatewayPorts can be used to specify that sshd should allow remote port forwardings to bind to non-loopback addresses, thus allowing other hosts to connect. The argument may be no to force remote port forwardings to be available to the local host only, yes to force remote port forwardings to bind to the wildcard address, or clientspecified to allow the client to select the address to which the forwarding is bound. The default is no.`, `Specifies whether remote hosts are allowed to connect to ports forwarded for the client. By default, sshd(8) binds remote port forwardings to the loopback address. This prevents other remote hosts from connecting to forwarded ports. GatewayPorts can be used to specify that sshd should allow remote port forwardings to bind to non-loopback addresses, thus allowing other hosts to connect. The argument may be no to force remote port forwardings to be available to the local host only, yes to force remote port forwardings to bind to the wildcard address, or clientspecified to allow the client to select the address to which the forwarding is bound. The default is no.`,
@ -284,8 +285,8 @@ See PATTERNS in ssh_config(5) for more information on patterns. This keyword may
"HostbasedAcceptedAlgorithms": common.NewOption(`Specifies the signature algorithms that will be accepted for hostbased authentication as a list of comma-separated patterns. Alternately if the specified list begins with a ‘+’ character, then the specified signature algorithms will be appended to the default set instead of replacing them. If the specified list begins with a ‘-’ character, then the specified signature algorithms (including wildcards) will be removed from the default set instead of replacing them. If the specified list begins with a ‘^’ character, then the specified signature algorithms will be placed at the head of the default set. The default for this option is: "HostbasedAcceptedAlgorithms": common.NewOption(`Specifies the signature algorithms that will be accepted for hostbased authentication as a list of comma-separated patterns. Alternately if the specified list begins with a ‘+’ character, then the specified signature algorithms will be appended to the default set instead of replacing them. If the specified list begins with a ‘-’ character, then the specified signature algorithms (including wildcards) will be removed from the default set instead of replacing them. If the specified list begins with a ‘^’ character, then the specified signature algorithms will be placed at the head of the default set. The default for this option is:
ssh-ed25519-cert-v01@openssh.com, ecdsa-sha2-nistp256-cert-v01@openssh.com, ecdsa-sha2-nistp384-cert-v01@openssh.com, ecdsa-sha2-nistp521-cert-v01@openssh.com, sk-ssh-ed25519-cert-v01@openssh.com, sk-ecdsa-sha2-nistp256-cert-v01@openssh.com, rsa-sha2-512-cert-v01@openssh.com, rsa-sha2-256-cert-v01@openssh.com, ssh-ed25519, ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, sk-ssh-ed25519@openssh.com, sk-ecdsa-sha2-nistp256@openssh.com, rsa-sha2-512,rsa-sha2-256 ssh-ed25519-cert-v01@openssh.com, ecdsa-sha2-nistp256-cert-v01@openssh.com, ecdsa-sha2-nistp384-cert-v01@openssh.com, ecdsa-sha2-nistp521-cert-v01@openssh.com, sk-ssh-ed25519-cert-v01@openssh.com, sk-ecdsa-sha2-nistp256-cert-v01@openssh.com, rsa-sha2-512-cert-v01@openssh.com, rsa-sha2-256-cert-v01@openssh.com, ssh-ed25519, ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, sk-ssh-ed25519@openssh.com, sk-ecdsa-sha2-nistp256@openssh.com, rsa-sha2-512,rsa-sha2-256
The list of available signature algorithms may also be obtained using "ssh -Q HostbasedAcceptedAlgorithms". This was formerly named HostbasedAcceptedKeyTypes.`, The list of available signature algorithms may also be obtained using "ssh -Q HostbasedAcceptedAlgorithms". This was formerly named HostbasedAcceptedKeyTypes.`,
common.CustomValue{ docvalues.CustomValue{
FetchValue: func() common.Value { FetchValue: func() docvalues.Value {
options, err := QueryOpenSSHOptions("HostbasedAcceptedAlgorithms") options, err := QueryOpenSSHOptions("HostbasedAcceptedAlgorithms")
if err != nil { if err != nil {
@ -307,30 +308,30 @@ See PATTERNS in ssh_config(5) for more information on patterns. This keyword may
), ),
"HostCertificate": common.NewOption( "HostCertificate": common.NewOption(
`Specifies a file containing a public host certificate. The certificate's public key must match a private host key already specified by HostKey. The default behaviour of sshd(8) is not to load any certificates.`, `Specifies a file containing a public host certificate. The certificate's public key must match a private host key already specified by HostKey. The default behaviour of sshd(8) is not to load any certificates.`,
common.StringValue{}, docvalues.StringValue{},
), ),
"HostKey": common.NewOption(`Specifies a file containing a private host key used by SSH. The defaults are /etc/ssh/ssh_host_ecdsa_key, /etc/ssh/ssh_host_ed25519_key and /etc/ssh/ssh_host_rsa_key. "HostKey": common.NewOption(`Specifies a file containing a private host key used by SSH. The defaults are /etc/ssh/ssh_host_ecdsa_key, /etc/ssh/ssh_host_ed25519_key and /etc/ssh/ssh_host_rsa_key.
Note that sshd(8) will refuse to use a file if it is group/world-accessible and that the HostKeyAlgorithms option restricts which of the keys are actually used by sshd(8). Note that sshd(8) will refuse to use a file if it is group/world-accessible and that the HostKeyAlgorithms option restricts which of the keys are actually used by sshd(8).
It is possible to have multiple host key files. It is also possible to specify public host key files instead. In this case operations on the private key will be delegated to an ssh-agent(1).`, It is possible to have multiple host key files. It is also possible to specify public host key files instead. In this case operations on the private key will be delegated to an ssh-agent(1).`,
common.StringValue{}, docvalues.StringValue{},
), ),
"HostKeyAgent": common.NewOption( "HostKeyAgent": common.NewOption(
`Identifies the UNIX-domain socket used to communicate with an agent that has access to the private host keys. If the string "SSH_AUTH_SOCK" is specified, the location of the socket will be read from the SSH_AUTH_SOCK environment variable.`, `Identifies the UNIX-domain socket used to communicate with an agent that has access to the private host keys. If the string "SSH_AUTH_SOCK" is specified, the location of the socket will be read from the SSH_AUTH_SOCK environment variable.`,
common.OrValue{ docvalues.OrValue{
Values: []common.Value{ Values: []docvalues.Value{
common.EnumValue{ docvalues.EnumValue{
EnforceValues: true, EnforceValues: true,
Values: []string{"SSH_AUTH_SOCK"}, Values: []string{"SSH_AUTH_SOCK"},
}, },
common.StringValue{}, docvalues.StringValue{},
}, },
}, },
), ),
"HostKeyAlgorithms": common.NewOption(`Specifies the host key signature algorithms that the server offers. The default for this option is: "HostKeyAlgorithms": common.NewOption(`Specifies the host key signature algorithms that the server offers. The default for this option is:
ssh-ed25519-cert-v01@openssh.com, ecdsa-sha2-nistp256-cert-v01@openssh.com, ecdsa-sha2-nistp384-cert-v01@openssh.com, ecdsa-sha2-nistp521-cert-v01@openssh.com, sk-ssh-ed25519-cert-v01@openssh.com, sk-ecdsa-sha2-nistp256-cert-v01@openssh.com, rsa-sha2-512-cert-v01@openssh.com, rsa-sha2-256-cert-v01@openssh.com, ssh-ed25519, ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, sk-ssh-ed25519@openssh.com, sk-ecdsa-sha2-nistp256@openssh.com, rsa-sha2-512,rsa-sha2-256 ssh-ed25519-cert-v01@openssh.com, ecdsa-sha2-nistp256-cert-v01@openssh.com, ecdsa-sha2-nistp384-cert-v01@openssh.com, ecdsa-sha2-nistp521-cert-v01@openssh.com, sk-ssh-ed25519-cert-v01@openssh.com, sk-ecdsa-sha2-nistp256-cert-v01@openssh.com, rsa-sha2-512-cert-v01@openssh.com, rsa-sha2-256-cert-v01@openssh.com, ssh-ed25519, ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, sk-ssh-ed25519@openssh.com, sk-ecdsa-sha2-nistp256@openssh.com, rsa-sha2-512,rsa-sha2-256
The list of available signature algorithms may also be obtained using "ssh -Q HostKeyAlgorithms".`, The list of available signature algorithms may also be obtained using "ssh -Q HostKeyAlgorithms".`,
common.CustomValue{ docvalues.CustomValue{
FetchValue: func() common.Value { FetchValue: func() docvalues.Value {
options, _ := QueryOpenSSHOptions("HostKeyAlgorithms") options, _ := QueryOpenSSHOptions("HostKeyAlgorithms")
return PrefixPlusMinusCaret(options) return PrefixPlusMinusCaret(options)
@ -339,7 +340,7 @@ See PATTERNS in ssh_config(5) for more information on patterns. This keyword may
), ),
"IgnoreRhosts": common.NewOption(`Specifies whether to ignore per-user .rhosts and .shosts files during HostbasedAuthentication. The system-wide /etc/hosts.equiv and /etc/shosts.equiv are still used regardless of this setting. "IgnoreRhosts": common.NewOption(`Specifies whether to ignore per-user .rhosts and .shosts files during HostbasedAuthentication. The system-wide /etc/hosts.equiv and /etc/shosts.equiv are still used regardless of this setting.
Accepted values are yes (the default) to ignore all per- user files, shosts-only to allow the use of .shosts but to ignore .rhosts or no to allow both .shosts and rhosts.`, Accepted values are yes (the default) to ignore all per- user files, shosts-only to allow the use of .shosts but to ignore .rhosts or no to allow both .shosts and rhosts.`,
common.EnumValue{ docvalues.EnumValue{
EnforceValues: true, EnforceValues: true,
Values: []string{"yes", "shosts-only", "no"}, Values: []string{"yes", "shosts-only", "no"},
}, },
@ -349,19 +350,19 @@ See PATTERNS in ssh_config(5) for more information on patterns. This keyword may
BooleanEnumValue, BooleanEnumValue,
), ),
"Include": common.NewOption(`Include the specified configuration file(s). Multiple pathnames may be specified and each pathname may contain glob(7) wildcards that will be expanded and processed in lexical order. Files without absolute paths are assumed to be in /etc/ssh. An Include directive may appear inside a Match block to perform conditional inclusion.`, "Include": common.NewOption(`Include the specified configuration file(s). Multiple pathnames may be specified and each pathname may contain glob(7) wildcards that will be expanded and processed in lexical order. Files without absolute paths are assumed to be in /etc/ssh. An Include directive may appear inside a Match block to perform conditional inclusion.`,
common.StringValue{}, docvalues.StringValue{},
), ),
"IPQoS": common.NewOption(`Specifies the IPv4 type-of-service or DSCP class for the connection. Accepted values are af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs0, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, le, lowdelay, throughput, reliability, a numeric value, or none to use the operating system default. This option may take one or two arguments, separated by whitespace. If one argument is specified, it is used as the packet class unconditionally. If two values are specified, the first is automatically selected for interactive sessions and the second for non-interactive sessions. The default is af21 (Low-Latency Data) for interactive sessions and cs1 (Lower Effort) for non-interactive sessions.`, "IPQoS": common.NewOption(`Specifies the IPv4 type-of-service or DSCP class for the connection. Accepted values are af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs0, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef, le, lowdelay, throughput, reliability, a numeric value, or none to use the operating system default. This option may take one or two arguments, separated by whitespace. If one argument is specified, it is used as the packet class unconditionally. If two values are specified, the first is automatically selected for interactive sessions and the second for non-interactive sessions. The default is af21 (Low-Latency Data) for interactive sessions and cs1 (Lower Effort) for non-interactive sessions.`,
common.OrValue{ docvalues.OrValue{
Values: []common.Value{ Values: []docvalues.Value{
common.PositiveNumberValue{}, docvalues.PositiveNumberValue{},
common.EnumValue{ docvalues.EnumValue{
Values: []string{"none"}, Values: []string{"none"},
}, },
common.ArrayValue{ docvalues.ArrayValue{
Separator: " ", Separator: " ",
SubValue: common.EnumValue{ SubValue: docvalues.EnumValue{
EnforceValues: true, EnforceValues: true,
Values: []string{ Values: []string{
"af11", "af12", "af13", "af11", "af12", "af13",
@ -417,10 +418,10 @@ See PATTERNS in ssh_config(5) for more information on patterns. This keyword may
// ListenAddress hostname|address [rdomain domain] ListenAddress hostname:port [rdomain domain] ListenAddress IPv4_address:port [rdomain domain] ListenAddress [hostname|address]:port [rdomain domain] // ListenAddress hostname|address [rdomain domain] ListenAddress hostname:port [rdomain domain] ListenAddress IPv4_address:port [rdomain domain] ListenAddress [hostname|address]:port [rdomain domain]
// The optional rdomain qualifier requests sshd(8) listen in an explicit routing domain. If port is not specified, sshd will listen on the address and all Port options specified. The default is to listen on all local addresses on the current default routing domain. Multiple ListenAddress options are permitted. For more information on routing domains, see rdomain(4).`, // The optional rdomain qualifier requests sshd(8) listen in an explicit routing domain. If port is not specified, sshd will listen on the address and all Port options specified. The default is to listen on all local addresses on the current default routing domain. Multiple ListenAddress options are permitted. For more information on routing domains, see rdomain(4).`,
"LoginGraceTime": common.NewOption(`The server disconnects after this time if the user has not successfully logged in. If the value is 0, there is no time limit. The default is 120 seconds.`, "LoginGraceTime": common.NewOption(`The server disconnects after this time if the user has not successfully logged in. If the value is 0, there is no time limit. The default is 120 seconds.`,
common.PositiveNumberValue{}, docvalues.PositiveNumberValue{},
), ),
"LogLevel": common.NewOption(`Gives the verbosity level that is used when logging messages from sshd(8). The possible values are: QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3. The default is INFO. DEBUG and DEBUG1 are equivalent. DEBUG2 and DEBUG3 each specify higher levels of debugging output. Logging with a DEBUG level violates the privacy of users and is not recommended.`, "LogLevel": common.NewOption(`Gives the verbosity level that is used when logging messages from sshd(8). The possible values are: QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3. The default is INFO. DEBUG and DEBUG1 are equivalent. DEBUG2 and DEBUG3 each specify higher levels of debugging output. Logging with a DEBUG level violates the privacy of users and is not recommended.`,
common.EnumValue{ docvalues.EnumValue{
EnforceValues: true, EnforceValues: true,
Values: []string{ Values: []string{
"QUIET", "QUIET",
@ -472,16 +473,16 @@ See PATTERNS in ssh_config(5) for more information on patterns. This keyword may
// The patterns in an Address criteria may additionally contain addresses to match in CIDR address/masklen format, such as 192.0.2.0/24 or 2001:db8::/32. Note that the mask length provided must be consistent with the address - it is an error to specify a mask length that is too long for the address or one with bits set in this host portion of the address. For example, 192.0.2.0/33 and 192.0.2.0/8, respectively. // The patterns in an Address criteria may additionally contain addresses to match in CIDR address/masklen format, such as 192.0.2.0/24 or 2001:db8::/32. Note that the mask length provided must be consistent with the address - it is an error to specify a mask length that is too long for the address or one with bits set in this host portion of the address. For example, 192.0.2.0/33 and 192.0.2.0/8, respectively.
// Only a subset of keywords may be used on the lines following a Match keyword. Available keywords are AcceptEnv, AllowAgentForwarding, AllowGroups, AllowStreamLocalForwarding, AllowTcpForwarding, AllowUsers, AuthenticationMethods, AuthorizedKeysCommand, AuthorizedKeysCommandUser, AuthorizedKeysFile, AuthorizedPrincipalsCommand, AuthorizedPrincipalsCommandUser, AuthorizedPrincipalsFile, Banner, CASignatureAlgorithms, ChannelTimeout, ChrootDirectory, ClientAliveCountMax, ClientAliveInterval, DenyGroups, DenyUsers, DisableForwarding, ExposeAuthInfo, ForceCommand, GatewayPorts, GSSAPIAuthentication, HostbasedAcceptedAlgorithms, HostbasedAuthentication, HostbasedUsesNameFromPacketOnly, IgnoreRhosts, Include, IPQoS, KbdInteractiveAuthentication, KerberosAuthentication, LogLevel, MaxAuthTries, MaxSessions, PasswordAuthentication, PermitEmptyPasswords, PermitListen, PermitOpen, PermitRootLogin, PermitTTY, PermitTunnel, PermitUserRC, PubkeyAcceptedAlgorithms, PubkeyAuthentication, PubkeyAuthOptions, RekeyLimit, RevokedKeys, RDomain, SetEnv, StreamLocalBindMask, StreamLocalBindUnlink, TrustedUserCAKeys, UnusedConnectionTimeout, X11DisplayOffset, X11Forwarding and X11UseLocalhost.`, // Only a subset of keywords may be used on the lines following a Match keyword. Available keywords are AcceptEnv, AllowAgentForwarding, AllowGroups, AllowStreamLocalForwarding, AllowTcpForwarding, AllowUsers, AuthenticationMethods, AuthorizedKeysCommand, AuthorizedKeysCommandUser, AuthorizedKeysFile, AuthorizedPrincipalsCommand, AuthorizedPrincipalsCommandUser, AuthorizedPrincipalsFile, Banner, CASignatureAlgorithms, ChannelTimeout, ChrootDirectory, ClientAliveCountMax, ClientAliveInterval, DenyGroups, DenyUsers, DisableForwarding, ExposeAuthInfo, ForceCommand, GatewayPorts, GSSAPIAuthentication, HostbasedAcceptedAlgorithms, HostbasedAuthentication, HostbasedUsesNameFromPacketOnly, IgnoreRhosts, Include, IPQoS, KbdInteractiveAuthentication, KerberosAuthentication, LogLevel, MaxAuthTries, MaxSessions, PasswordAuthentication, PermitEmptyPasswords, PermitListen, PermitOpen, PermitRootLogin, PermitTTY, PermitTunnel, PermitUserRC, PubkeyAcceptedAlgorithms, PubkeyAuthentication, PubkeyAuthOptions, RekeyLimit, RevokedKeys, RDomain, SetEnv, StreamLocalBindMask, StreamLocalBindUnlink, TrustedUserCAKeys, UnusedConnectionTimeout, X11DisplayOffset, X11Forwarding and X11UseLocalhost.`,
"MaxAuthTries": common.NewOption(`Specifies the maximum number of authentication attempts permitted per connection. Once the number of failures reaches half this value, additional failures are logged. The default is 6.`, "MaxAuthTries": common.NewOption(`Specifies the maximum number of authentication attempts permitted per connection. Once the number of failures reaches half this value, additional failures are logged. The default is 6.`,
common.PositiveNumberValue{}, docvalues.PositiveNumberValue{},
), ),
"MaxSessions": common.NewOption(`Specifies the maximum number of open shell, login or subsystem (e.g. sftp) sessions permitted per network connection. Multiple sessions may be established by clients that support connection multiplexing. Setting MaxSessions to 1 will effectively disable session multiplexing, whereas setting it to 0 will prevent all shell, login and subsystem sessions while still permitting forwarding. The default is 10.`, "MaxSessions": common.NewOption(`Specifies the maximum number of open shell, login or subsystem (e.g. sftp) sessions permitted per network connection. Multiple sessions may be established by clients that support connection multiplexing. Setting MaxSessions to 1 will effectively disable session multiplexing, whereas setting it to 0 will prevent all shell, login and subsystem sessions while still permitting forwarding. The default is 10.`,
common.PositiveNumberValue{}, docvalues.PositiveNumberValue{},
), ),
// "MaxStartups": `Specifies the maximum number of concurrent unauthenticated connections to the SSH daemon. Additional connections will be dropped until authentication succeeds or the LoginGraceTime expires for a connection. The default is 10:30:100. // "MaxStartups": `Specifies the maximum number of concurrent unauthenticated connections to the SSH daemon. Additional connections will be dropped until authentication succeeds or the LoginGraceTime expires for a connection. The default is 10:30:100.
// Alternatively, random early drop can be enabled by specifying the three colon separated values start:rate:full (e.g. "10:30:60"). sshd(8) will refuse connection attempts with a probability of rate/100 (30%) if there are currently start (10) unauthenticated connections. The probability increases linearly and all connection attempts are refused if the number of unauthenticated connections reaches full (60).`, // Alternatively, random early drop can be enabled by specifying the three colon separated values start:rate:full (e.g. "10:30:60"). sshd(8) will refuse connection attempts with a probability of rate/100 (30%) if there are currently start (10) unauthenticated connections. The probability increases linearly and all connection attempts are refused if the number of unauthenticated connections reaches full (60).`,
"ModuliFile": common.NewOption(`Specifies the moduli(5) file that contains the Diffie- Hellman groups used for the “diffie-hellman-group-exchange-sha1” and “diffie-hellman-group-exchange-sha256” key exchange methods. The default is /etc/moduli.`, "ModuliFile": common.NewOption(`Specifies the moduli(5) file that contains the Diffie- Hellman groups used for the “diffie-hellman-group-exchange-sha1” and “diffie-hellman-group-exchange-sha256” key exchange methods. The default is /etc/moduli.`,
common.PathValue{ docvalues.PathValue{
RequiredType: common.PathTypeFile, RequiredType: docvalues.PathTypeFile,
}, },
), ),
"PasswordAuthentication": common.NewOption(`Specifies whether password authentication is allowed. The default is yes.`, "PasswordAuthentication": common.NewOption(`Specifies whether password authentication is allowed. The default is yes.`,
@ -500,7 +501,7 @@ See PATTERNS in ssh_config(5) for more information on patterns. This keyword may
If this option is set to prohibit-password (or its deprecated alias, without-password), password and keyboard-interactive authentication are disabled for root. If this option is set to prohibit-password (or its deprecated alias, without-password), password and keyboard-interactive authentication are disabled for root.
If this option is set to forced-commands-only, root login with public key authentication will be allowed, but only if the command option has been specified (which may be useful for taking remote backups even if root login is normally not allowed). All other authentication methods are disabled for root. If this option is set to forced-commands-only, root login with public key authentication will be allowed, but only if the command option has been specified (which may be useful for taking remote backups even if root login is normally not allowed). All other authentication methods are disabled for root.
If this option is set to no, root is not allowed to log in.`, If this option is set to no, root is not allowed to log in.`,
common.EnumValue{ docvalues.EnumValue{
EnforceValues: true, EnforceValues: true,
Values: []string{ Values: []string{
"yes", "yes",
@ -515,7 +516,7 @@ See PATTERNS in ssh_config(5) for more information on patterns. This keyword may
), ),
"PermitTunnel": common.NewOption(`Specifies whether tun(4) device forwarding is allowed. The argument must be yes, point-to-point (layer 3), ethernet (layer 2), or no. Specifying yes permits both point-to-point and ethernet. The default is no. "PermitTunnel": common.NewOption(`Specifies whether tun(4) device forwarding is allowed. The argument must be yes, point-to-point (layer 3), ethernet (layer 2), or no. Specifying yes permits both point-to-point and ethernet. The default is no.
Independent of this setting, the permissions of the selected tun(4) device must allow access to the user.`, Independent of this setting, the permissions of the selected tun(4) device must allow access to the user.`,
common.EnumValue{ docvalues.EnumValue{
EnforceValues: true, EnforceValues: true,
Values: []string{ Values: []string{
"yes", "yes",
@ -526,15 +527,15 @@ See PATTERNS in ssh_config(5) for more information on patterns. This keyword may
}, },
), ),
"PermitUserEnvironment": common.NewOption(`Specifies whether ~/.ssh/environment and environment= options in ~/.ssh/authorized_keys are processed by sshd(8). Valid options are yes, no or a pattern-list specifying which environment variable names to accept (for example "LANG,LC_*"). The default is no. Enabling environment processing may enable users to bypass access restrictions in some configurations using mechanisms such as LD_PRELOAD.`, "PermitUserEnvironment": common.NewOption(`Specifies whether ~/.ssh/environment and environment= options in ~/.ssh/authorized_keys are processed by sshd(8). Valid options are yes, no or a pattern-list specifying which environment variable names to accept (for example "LANG,LC_*"). The default is no. Enabling environment processing may enable users to bypass access restrictions in some configurations using mechanisms such as LD_PRELOAD.`,
common.OrValue{ docvalues.OrValue{
Values: []common.Value{ Values: []docvalues.Value{
common.EnumValue{ docvalues.EnumValue{
Values: []string{"yes", "no"}, Values: []string{"yes", "no"},
}, },
common.ArrayValue{ docvalues.ArrayValue{
SubValue: common.StringValue{}, SubValue: docvalues.StringValue{},
Separator: ",", Separator: ",",
DuplicatesExtractor: &common.DuplicatesAllowedExtractor, DuplicatesExtractor: &docvalues.DuplicatesAllowedExtractor,
}, },
}, },
}, },
@ -543,23 +544,23 @@ See PATTERNS in ssh_config(5) for more information on patterns. This keyword may
BooleanEnumValue, BooleanEnumValue,
), ),
"PerSourceMaxStartups": common.NewOption(`Specifies the number of unauthenticated connections allowed from a given source address, or “none” if there is no limit. This limit is applied in addition to MaxStartups, whichever is lower. The default is none.`, "PerSourceMaxStartups": common.NewOption(`Specifies the number of unauthenticated connections allowed from a given source address, or “none” if there is no limit. This limit is applied in addition to MaxStartups, whichever is lower. The default is none.`,
common.OrValue{ docvalues.OrValue{
Values: []common.Value{ Values: []docvalues.Value{
common.EnumValue{ docvalues.EnumValue{
EnforceValues: true, EnforceValues: true,
Values: []string{"none"}, Values: []string{"none"},
}, },
common.PositiveNumberValue{}, docvalues.PositiveNumberValue{},
}, },
}, },
), ),
// "PerSourceNetBlockSize": `Specifies the number of bits of source address that are grouped together for the purposes of applying PerSourceMaxStartups limits. Values for IPv4 and optionally IPv6 may be specified, separated by a colon. The default is 32:128, which means each address is considered individually.`, // "PerSourceNetBlockSize": `Specifies the number of bits of source address that are grouped together for the purposes of applying PerSourceMaxStartups limits. Values for IPv4 and optionally IPv6 may be specified, separated by a colon. The default is 32:128, which means each address is considered individually.`,
"PidFile": common.NewOption(`Specifies the file that contains the process ID of the SSH daemon, or none to not write one. The default is /var/run/sshd.pid.`, "PidFile": common.NewOption(`Specifies the file that contains the process ID of the SSH daemon, or none to not write one. The default is /var/run/sshd.pid.`,
common.StringValue{}, docvalues.StringValue{},
), ),
"Port": common.NewOption(`Specifies the port number that sshd(8) listens on. The default is 22. Multiple options of this type are permitted. See also ListenAddress.`, "Port": common.NewOption(`Specifies the port number that sshd(8) listens on. The default is 22. Multiple options of this type are permitted. See also ListenAddress.`,
common.PositiveNumberValue{}, docvalues.PositiveNumberValue{},
), ),
"PrintLastLog": common.NewOption(`Specifies whether sshd(8) should print the date and time of the last user login when a user logs in interactively. The default is yes.`, "PrintLastLog": common.NewOption(`Specifies whether sshd(8) should print the date and time of the last user login when a user logs in interactively. The default is yes.`,
BooleanEnumValue, BooleanEnumValue,
@ -570,8 +571,8 @@ See PATTERNS in ssh_config(5) for more information on patterns. This keyword may
"PubkeyAcceptedAlgorithms": common.NewOption(`Specifies the signature algorithms that will be accepted for public key authentication as a list of comma- separated patterns. Alternately if the specified list begins with a ‘+’ character, then the specified algorithms will be appended to the default set instead of replacing them. If the specified list begins with a ‘-’ character, then the specified algorithms (including wildcards) will be removed from the default set instead of replacing them. If the specified list begins with a ‘^’ character, then the specified algorithms will be placed at the head of the default set. The default for this option is: "PubkeyAcceptedAlgorithms": common.NewOption(`Specifies the signature algorithms that will be accepted for public key authentication as a list of comma- separated patterns. Alternately if the specified list begins with a ‘+’ character, then the specified algorithms will be appended to the default set instead of replacing them. If the specified list begins with a ‘-’ character, then the specified algorithms (including wildcards) will be removed from the default set instead of replacing them. If the specified list begins with a ‘^’ character, then the specified algorithms will be placed at the head of the default set. The default for this option is:
ssh-ed25519-cert-v01@openssh.com, ecdsa-sha2-nistp256-cert-v01@openssh.com, ecdsa-sha2-nistp384-cert-v01@openssh.com, ecdsa-sha2-nistp521-cert-v01@openssh.com, sk-ssh-ed25519-cert-v01@openssh.com, sk-ecdsa-sha2-nistp256-cert-v01@openssh.com, rsa-sha2-512-cert-v01@openssh.com, rsa-sha2-256-cert-v01@openssh.com, ssh-ed25519, ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, sk-ssh-ed25519@openssh.com, sk-ecdsa-sha2-nistp256@openssh.com, rsa-sha2-512,rsa-sha2-256 ssh-ed25519-cert-v01@openssh.com, ecdsa-sha2-nistp256-cert-v01@openssh.com, ecdsa-sha2-nistp384-cert-v01@openssh.com, ecdsa-sha2-nistp521-cert-v01@openssh.com, sk-ssh-ed25519-cert-v01@openssh.com, sk-ecdsa-sha2-nistp256-cert-v01@openssh.com, rsa-sha2-512-cert-v01@openssh.com, rsa-sha2-256-cert-v01@openssh.com, ssh-ed25519, ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, sk-ssh-ed25519@openssh.com, sk-ecdsa-sha2-nistp256@openssh.com, rsa-sha2-512,rsa-sha2-256
The list of available signature algorithms may also be obtained using "ssh -Q PubkeyAcceptedAlgorithms".`, The list of available signature algorithms may also be obtained using "ssh -Q PubkeyAcceptedAlgorithms".`,
common.CustomValue{ docvalues.CustomValue{
FetchValue: func() common.Value { FetchValue: func() docvalues.Value {
options, _ := QueryOpenSSHOptions("PubkeyAcceptedAlgorithms") options, _ := QueryOpenSSHOptions("PubkeyAcceptedAlgorithms")
return PrefixPlusMinusCaret(options) return PrefixPlusMinusCaret(options)
@ -582,9 +583,9 @@ See PATTERNS in ssh_config(5) for more information on patterns. This keyword may
The touch-required option causes public key authentication using a FIDO authenticator algorithm (i.e. ecdsa-sk or ed25519-sk) to always require the signature to attest that a physically present user explicitly confirmed the authentication (usually by touching the authenticator). By default, sshd(8) requires user presence unless overridden with an authorized_keys option. The touch-required flag disables this override. The touch-required option causes public key authentication using a FIDO authenticator algorithm (i.e. ecdsa-sk or ed25519-sk) to always require the signature to attest that a physically present user explicitly confirmed the authentication (usually by touching the authenticator). By default, sshd(8) requires user presence unless overridden with an authorized_keys option. The touch-required flag disables this override.
The verify-required option requires a FIDO key signature attest that the user was verified, e.g. via a PIN. The verify-required option requires a FIDO key signature attest that the user was verified, e.g. via a PIN.
Neither the touch-required or verify-required options have any effect for other, non-FIDO, public key types.`, Neither the touch-required or verify-required options have any effect for other, non-FIDO, public key types.`,
common.ArrayValue{ docvalues.ArrayValue{
Separator: ",", Separator: ",",
SubValue: common.EnumValue{ SubValue: docvalues.EnumValue{
EnforceValues: true, EnforceValues: true,
Values: []string{"none", "touch-required", "verify-required"}, Values: []string{"none", "touch-required", "verify-required"},
}, },
@ -595,22 +596,22 @@ See PATTERNS in ssh_config(5) for more information on patterns. This keyword may
), ),
// "RekeyLimit": `Specifies the maximum amount of data that may be transmitted or received before the session key is renegotiated, optionally followed by a maximum amount of time that may pass before the session key is renegotiated. The first argument is specified in bytes and may have a suffix of ‘K’, ‘M’, or ‘G’ to indicate Kilobytes, Megabytes, or Gigabytes, respectively. The default is between ‘1G’ and ‘4G’, depending on the cipher. The optional second value is specified in seconds and may use any of the units documented in the “TIME FORMATS” section. The default value for RekeyLimit is default none, which means that rekeying is performed after the cipher's default amount of data has been sent or received and no time based rekeying is done.`, // "RekeyLimit": `Specifies the maximum amount of data that may be transmitted or received before the session key is renegotiated, optionally followed by a maximum amount of time that may pass before the session key is renegotiated. The first argument is specified in bytes and may have a suffix of ‘K’, ‘M’, or ‘G’ to indicate Kilobytes, Megabytes, or Gigabytes, respectively. The default is between ‘1G’ and ‘4G’, depending on the cipher. The optional second value is specified in seconds and may use any of the units documented in the “TIME FORMATS” section. The default value for RekeyLimit is default none, which means that rekeying is performed after the cipher's default amount of data has been sent or received and no time based rekeying is done.`,
"RequiredRSASize": common.NewOption(`Specifies the minimum RSA key size (in bits) that sshd(8) will accept. User and host-based authentication keys smaller than this limit will be refused. The default is 1024 bits. Note that this limit may only be raised from the default.`, "RequiredRSASize": common.NewOption(`Specifies the minimum RSA key size (in bits) that sshd(8) will accept. User and host-based authentication keys smaller than this limit will be refused. The default is 1024 bits. Note that this limit may only be raised from the default.`,
common.PositiveNumberValue{}, docvalues.PositiveNumberValue{},
), ),
"RevokedKeys": common.NewOption(`Specifies revoked public keys file, or none to not use one. Keys listed in this file will be refused for public key authentication. Note that if this file is not readable, then public key authentication will be refused for all users. Keys may be specified as a text file, listing one public key per line, or as an OpenSSH Key Revocation List (KRL) as generated by ssh-keygen(1). For more information on KRLs, see the KEY REVOCATION LISTS section in ssh-keygen(1).`, "RevokedKeys": common.NewOption(`Specifies revoked public keys file, or none to not use one. Keys listed in this file will be refused for public key authentication. Note that if this file is not readable, then public key authentication will be refused for all users. Keys may be specified as a text file, listing one public key per line, or as an OpenSSH Key Revocation List (KRL) as generated by ssh-keygen(1). For more information on KRLs, see the KEY REVOCATION LISTS section in ssh-keygen(1).`,
common.StringValue{}, docvalues.StringValue{},
), ),
// "RDomain": `Specifies an explicit routing domain that is applied after authentication has completed. The user session, as well as any forwarded or listening IP sockets, will be bound to this rdomain(4). If the routing domain is set to %D, then the domain in which the incoming connection was received will be applied.`, // "RDomain": `Specifies an explicit routing domain that is applied after authentication has completed. The user session, as well as any forwarded or listening IP sockets, will be bound to this rdomain(4). If the routing domain is set to %D, then the domain in which the incoming connection was received will be applied.`,
"SecurityKeyProvider": common.NewOption(`Specifies a path to a library that will be used when loading FIDO authenticator-hosted keys, overriding the default of using the built-in USB HID support.`, "SecurityKeyProvider": common.NewOption(`Specifies a path to a library that will be used when loading FIDO authenticator-hosted keys, overriding the default of using the built-in USB HID support.`,
common.PathValue{ docvalues.PathValue{
RequiredType: common.PathTypeFile, RequiredType: docvalues.PathTypeFile,
}, },
), ),
// "SetEnv": common.NewOption(`Specifies one or more environment variables to set in child sessions started by sshd(8) as “NAME=VALUE”. The environment value may be quoted (e.g. if it contains whitespace characters). Environment variables set by SetEnv override the default environment and any variables specified by the user via AcceptEnv or PermitUserEnvironment.`, // "SetEnv": common.NewOption(`Specifies one or more environment variables to set in child sessions started by sshd(8) as “NAME=VALUE”. The environment value may be quoted (e.g. if it contains whitespace characters). Environment variables set by SetEnv override the default environment and any variables specified by the user via AcceptEnv or PermitUserEnvironment.`,
"StreamLocalBindMask": common.NewOption(`Sets the octal file creation mode mask (umask) used when creating a Unix-domain socket file for local or remote port forwarding. This option is only used for port forwarding to a Unix-domain socket file. "StreamLocalBindMask": common.NewOption(`Sets the octal file creation mode mask (umask) used when creating a Unix-domain socket file for local or remote port forwarding. This option is only used for port forwarding to a Unix-domain socket file.
The default value is 0177, which creates a Unix-domain socket file that is readable and writable only by the owner. Note that not all operating systems honor the file mode on Unix-domain socket files.`, The default value is 0177, which creates a Unix-domain socket file that is readable and writable only by the owner. Note that not all operating systems honor the file mode on Unix-domain socket files.`,
common.PositiveNumberValue{}, docvalues.PositiveNumberValue{},
), ),
"StreamLocalBindUnlink": common.NewOption(`Specifies whether to remove an existing Unix-domain socket file for local or remote port forwarding before creating a new one. If the socket file already exists and StreamLocalBindUnlink is not enabled, sshd will be unable to forward the port to the Unix-domain socket file. This option is only used for port forwarding to a Unix-domain socket file. "StreamLocalBindUnlink": common.NewOption(`Specifies whether to remove an existing Unix-domain socket file for local or remote port forwarding before creating a new one. If the socket file already exists and StreamLocalBindUnlink is not enabled, sshd will be unable to forward the port to the Unix-domain socket file. This option is only used for port forwarding to a Unix-domain socket file.
The argument must be yes or no. The default is no.`, The argument must be yes or no. The default is no.`,
@ -624,7 +625,7 @@ See PATTERNS in ssh_config(5) for more information on patterns. This keyword may
// Alternately the name internal-sftp implements an in- process SFTP server. This may simplify configurations using ChrootDirectory to force a different filesystem root on clients. It accepts the same command line arguments as sftp-server and even though it is in- process, settings such as LogLevel or SyslogFacility do not apply to it and must be set explicitly via command line arguments. // Alternately the name internal-sftp implements an in- process SFTP server. This may simplify configurations using ChrootDirectory to force a different filesystem root on clients. It accepts the same command line arguments as sftp-server and even though it is in- process, settings such as LogLevel or SyslogFacility do not apply to it and must be set explicitly via command line arguments.
// By default no subsystems are defined.`, // By default no subsystems are defined.`,
"SyslogFacility": common.NewOption(`Gives the facility code that is used when logging messages from sshd(8). The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2, LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7. The default is AUTH.`, "SyslogFacility": common.NewOption(`Gives the facility code that is used when logging messages from sshd(8). The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2, LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7. The default is AUTH.`,
common.EnumValue{ docvalues.EnumValue{
EnforceValues: true, EnforceValues: true,
Values: []string{ Values: []string{
"DAEMON", "DAEMON",
@ -647,7 +648,7 @@ See PATTERNS in ssh_config(5) for more information on patterns. This keyword may
BooleanEnumValue, BooleanEnumValue,
), ),
"TrustedUserCAKeys": common.NewOption(`Specifies a file containing public keys of certificate authorities that are trusted to sign user certificates for authentication, or none to not use one. Keys are listed one per line; empty lines and comments starting with ‘#’ are allowed. If a certificate is presented for authentication and has its signing CA key listed in this file, then it may be used for authentication for any user listed in the certificate's principals list. Note that certificates that lack a list of principals will not be permitted for authentication using TrustedUserCAKeys. For more details on certificates, see the CERTIFICATES section in ssh-keygen(1).`, "TrustedUserCAKeys": common.NewOption(`Specifies a file containing public keys of certificate authorities that are trusted to sign user certificates for authentication, or none to not use one. Keys are listed one per line; empty lines and comments starting with ‘#’ are allowed. If a certificate is presented for authentication and has its signing CA key listed in this file, then it may be used for authentication for any user listed in the certificate's principals list. Note that certificates that lack a list of principals will not be permitted for authentication using TrustedUserCAKeys. For more details on certificates, see the CERTIFICATES section in ssh-keygen(1).`,
common.StringValue{}, docvalues.StringValue{},
), ),
// "UnusedConnectionTimeout": `Specifies whether and how quickly sshd(8) should close client connections with no open channels. Open channels include active shell, command execution or subsystem sessions, connected network, socket, agent or X11 forwardings. Forwarding listeners, such as those from the ssh(1) -R flag, are not considered as open channels and do not prevent the timeout. The timeout value is specified in seconds or may use any of the units documented in the “TIME FORMATS” section. // "UnusedConnectionTimeout": `Specifies whether and how quickly sshd(8) should close client connections with no open channels. Open channels include active shell, command execution or subsystem sessions, connected network, socket, agent or X11 forwardings. Forwarding listeners, such as those from the ssh(1) -R flag, are not considered as open channels and do not prevent the timeout. The timeout value is specified in seconds or may use any of the units documented in the “TIME FORMATS” section.
// Note that this timeout starts when the client connection completes user authentication but before the client has an opportunity to open any channels. Caution should be used when using short timeout values, as they may not provide sufficient time for the client to request and open its channels before terminating the connection. // Note that this timeout starts when the client connection completes user authentication but before the client has an opportunity to open any channels. Caution should be used when using short timeout values, as they may not provide sufficient time for the client to request and open its channels before terminating the connection.
@ -664,18 +665,18 @@ See PATTERNS in ssh_config(5) for more information on patterns. This keyword may
BooleanEnumValue, BooleanEnumValue,
), ),
"VersionAddendum": common.NewOption(`Optionally specifies additional text to append to the SSH protocol banner sent by the server upon connection. The default is none.`, "VersionAddendum": common.NewOption(`Optionally specifies additional text to append to the SSH protocol banner sent by the server upon connection. The default is none.`,
common.OrValue{ docvalues.OrValue{
Values: []common.Value{ Values: []docvalues.Value{
common.EnumValue{ docvalues.EnumValue{
EnforceValues: true, EnforceValues: true,
Values: []string{"none"}, Values: []string{"none"},
}, },
common.StringValue{}, docvalues.StringValue{},
}, },
}, },
), ),
"X11DisplayOffset": common.NewOption(`Specifies the first display number available for sshd(8)'s X11 forwarding. This prevents sshd from interfering with real X11 servers. The default is 10.`, "X11DisplayOffset": common.NewOption(`Specifies the first display number available for sshd(8)'s X11 forwarding. This prevents sshd from interfering with real X11 servers. The default is 10.`,
common.PositiveNumberValue{}, docvalues.PositiveNumberValue{},
), ),
"X11Forwarding": common.NewOption(`Specifies whether X11 forwarding is permitted. The argument must be yes or no. The default is no. "X11Forwarding": common.NewOption(`Specifies whether X11 forwarding is permitted. The argument must be yes or no. The default is no.
When X11 forwarding is enabled, there may be additional exposure to the server and to client displays if the sshd(8) proxy display is configured to listen on the wildcard address (see X11UseLocalhost), though this is not the default. Additionally, the authentication spoofing and authentication data verification and substitution occur on the client side. The security risk of using X11 forwarding is that the client's X11 display server may be exposed to attack when the SSH client requests forwarding (see the warnings for ForwardX11 in ssh_config(5)). A system administrator may have a stance in which they want to protect clients that may expose themselves to attack by unwittingly requesting X11 forwarding, which can warrant a no setting. When X11 forwarding is enabled, there may be additional exposure to the server and to client displays if the sshd(8) proxy display is configured to listen on the wildcard address (see X11UseLocalhost), though this is not the default. Additionally, the authentication spoofing and authentication data verification and substitution occur on the client side. The security risk of using X11 forwarding is that the client's X11 display server may be exposed to attack when the SSH client requests forwarding (see the warnings for ForwardX11 in ssh_config(5)). A system administrator may have a stance in which they want to protect clients that may expose themselves to attack by unwittingly requesting X11 forwarding, which can warrant a no setting.
@ -686,6 +687,6 @@ See PATTERNS in ssh_config(5) for more information on patterns. This keyword may
BooleanEnumValue, BooleanEnumValue,
), ),
"XAuthLocation": common.NewOption(`Specifies the full pathname of the xauth(1) program, or none to not use one. The default is /usr/X11R6/bin/xauth.`, "XAuthLocation": common.NewOption(`Specifies the full pathname of the xauth(1) program, or none to not use one. The default is /usr/X11R6/bin/xauth.`,
common.StringValue{}, docvalues.StringValue{},
), ),
} }

77
handlers/openssh/text-document-completion.go
View File

@ -2,6 +2,7 @@ package openssh
import ( import (
"config-lsp/common" "config-lsp/common"
docvalues "config-lsp/doc-values"
"errors" "errors"
"github.com/tliron/glsp" "github.com/tliron/glsp"
@ -18,11 +19,11 @@ func TextDocumentCompletion(context *glsp.Context, params *protocol.CompletionPa
if params.Position.Character < uint32(len(optionName)) { if params.Position.Character < uint32(len(optionName)) {
return getRootCompletions(), nil return getRootCompletions(), nil
} else { } else {
cursor := params.Position.Character - uint32(len(optionName + Parser.Options.Separator)) cursor := params.Position.Character - uint32(len(optionName+Parser.Options.Separator))
return getOptionCompletions(optionName, line.Value, cursor), nil return getOptionCompletions(optionName, line.Value, cursor), nil
} }
} else if errors.Is(err, common.LineNotFoundError{}) { } else if errors.Is(err, docvalues.LineNotFoundError{}) {
return getRootCompletions(), nil return getRootCompletions(), nil
} }
@ -41,7 +42,6 @@ func getRootCompletions() []protocol.CompletionItem {
format := protocol.InsertTextFormatSnippet format := protocol.InsertTextFormatSnippet
kind := protocol.CompletionItemKindField kind := protocol.CompletionItemKindField
completions[index] = protocol.CompletionItem{ completions[index] = protocol.CompletionItem{
Label: label, Label: label,
Documentation: common.GetDocumentation(&option), Documentation: common.GetDocumentation(&option),
@ -54,79 +54,10 @@ func getRootCompletions() []protocol.CompletionItem {
return completions return completions
} }
func getCompletionsFromValue(requiredValue common.Value, line string, cursor uint32) []protocol.CompletionItem {
switch requiredValue.(type) {
case common.EnumValue:
enumValue := requiredValue.(common.EnumValue)
completions := make([]protocol.CompletionItem, len(requiredValue.(common.EnumValue).Values))
for index, value := range enumValue.Values {
textFormat := protocol.InsertTextFormatPlainText
kind := protocol.CompletionItemKindEnum
completions[index] = protocol.CompletionItem{
Label: value,
InsertTextFormat: &textFormat,
Kind: &kind,
}
}
return completions
case common.CustomValue:
customValue := requiredValue.(common.CustomValue)
val := customValue.FetchValue()
return getCompletionsFromValue(val, line, cursor)
case common.ArrayValue:
arrayValue := requiredValue.(common.ArrayValue)
relativePosition, found := common.FindPreviousCharacter(line, arrayValue.Separator, int(cursor - 1))
if found {
line = line[uint32(relativePosition):]
cursor -= uint32(relativePosition)
}
return getCompletionsFromValue(arrayValue.SubValue, line, cursor)
case common.OrValue:
orValue := requiredValue.(common.OrValue)
completions := make([]protocol.CompletionItem, 0)
for _, subValue := range orValue.Values {
completions = append(completions, getCompletionsFromValue(subValue, line, cursor)...)
}
return completions
case common.PrefixWithMeaningValue:
prefixWithMeaningValue := requiredValue.(common.PrefixWithMeaningValue)
return getCompletionsFromValue(prefixWithMeaningValue.SubValue, line, cursor)
case common.KeyValueAssignmentValue:
keyValueAssignmentValue := requiredValue.(common.KeyValueAssignmentValue)
println("keyLine", line, "cursor", cursor)
relativePosition, found := common.FindPreviousCharacter(line, keyValueAssignmentValue.Separator, int(cursor - 1))
println("relativePosition", relativePosition)
if found {
line = line[uint32(relativePosition):]
cursor -= uint32(relativePosition)
return getCompletionsFromValue(keyValueAssignmentValue.Value, line, cursor)
} else {
println("giving key")
return getCompletionsFromValue(keyValueAssignmentValue.Key, line, cursor)
}
}
return []protocol.CompletionItem{}
}
func getOptionCompletions(optionName string, line string, cursor uint32) []protocol.CompletionItem { func getOptionCompletions(optionName string, line string, cursor uint32) []protocol.CompletionItem {
option := Options[optionName] option := Options[optionName]
completions := getCompletionsFromValue(option.Value, line, cursor) completions := option.Value.FetchCompletions(line, cursor)
return completions return completions
} }

24
handlers/openssh/text-document-did-change.go
View File

@ -12,29 +12,7 @@ func TextDocumentDidChange(context *glsp.Context, params *protocol.DidChangeText
content := params.ContentChanges[0].(protocol.TextDocumentContentChangeEventWhole).Text content := params.ContentChanges[0].(protocol.TextDocumentContentChangeEventWhole).Text
Parser.Clear() Parser.Clear()
diagnostics := make([]protocol.Diagnostic, 0) diagnostics := DiagnoseParser(context, params.TextDocument.URI, content)
diagnostics = append(
diagnostics,
common.Map(
Parser.ParseFromFile(content),
func (err common.OptionError) protocol.Diagnostic {
return err.GetPublishDiagnosticsParams()
},
)...,
)
diagnostics = append(
diagnostics,
common.Map(
common.AnalyzeValues(Parser, Options),
func (err common.ValueError) protocol.Diagnostic {
return err.GetPublishDiagnosticsParams()
},
)...,
)
diagnostics = DiagnoseSSHOptions(context, params)
if len(diagnostics) > 0 { if len(diagnostics) > 0 {
common.SendDiagnostics(context, params.TextDocument.URI, diagnostics) common.SendDiagnostics(context, params.TextDocument.URI, diagnostics)

22
handlers/openssh/text-document-did-open.go
View File

@ -15,27 +15,7 @@ func TextDocumentDidOpen(context *glsp.Context, params *protocol.DidOpenTextDocu
return err return err
} }
diagnostics := make([]protocol.Diagnostic, 0) diagnostics := DiagnoseParser(context, params.TextDocument.URI, string(readBytes))
diagnostics = append(
diagnostics,
common.Map(
Parser.ParseFromFile(string(readBytes)),
func (err common.OptionError) protocol.Diagnostic {
return err.GetPublishDiagnosticsParams()
},
)...,
)
diagnostics = append(
diagnostics,
common.Map(
common.AnalyzeValues(Parser, Options),
func (err common.ValueError) protocol.Diagnostic {
return err.GetPublishDiagnosticsParams()
},
)...,
)
if len(diagnostics) > 0 { if len(diagnostics) > 0 {
common.SendDiagnostics(context, params.TextDocument.URI, diagnostics) common.SendDiagnostics(context, params.TextDocument.URI, diagnostics)

2
common/utils.go → utils/common.go
View File

@ -1,4 +1,4 @@
package common package utils
import ( import (
"os" "os"