Skip to content

Commit

Permalink
clean up
Browse files Browse the repository at this point in the history
  • Loading branch information
@dhurley
dhurley committed Sep 6, 2023
1 parent a35aecc commit e3df68a
Show file tree
Hide file tree
Showing 4 changed files with 344 additions and 253 deletions.
197 changes: 114 additions & 83 deletions src/core/nginx.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -394,11 +394,6 @@ func (n *NginxBinaryType) WriteConfig(config *proto.NginxConfig) (*sdk.ConfigApp
return nil, fmt.Errorf("config directory %s not allowed", filepath.Dir(details.ConfPath))
}

confFiles, auxFiles, err := sdk.GetNginxConfigFiles(config)
if err != nil {
return nil, err
}

unpackMutex.Lock()
defer unpackMutex.Unlock()

Expand All @@ -407,109 +402,142 @@ func (n *NginxBinaryType) WriteConfig(config *proto.NginxConfig) (*sdk.ConfigApp

filesToUpdate, filesToDelete, allFilesHaveAnAction := generateActionMaps(config.DirectoryMap, n.config.AllowedDirectoriesMap)

// If the file action is unset for all files then all files are written to disk and a diff is performed to determine what files need to be deleted
if !allFilesHaveAnAction {
if allFilesHaveAnAction {
configApply, err = n.writeConfigWithWithFileActions(config, details, filesToUpdate, filesToDelete)
} else {
log.Debug("all files in directory map have no action set")
// If the file action is unset for any file then all files are written to disk and a diff is performed to determine what files need to be deleted
configApply, err = n.writeConfigWithNoFileActions(details, config, systemNginxConfig)
}

configApply, err = sdk.NewConfigApplyWithIgnoreDirectives(details.ConfPath, n.config.AllowedDirectoriesMap, n.config.IgnoreDirectives)
if err != nil {
log.Warnf("config_apply error: %s", err)
return nil, err
}
if err != nil {
return configApply, err
}

// Ensure this config request does not remove the process config
if !hasConfPath(confFiles, details.ConfPath) {
return nil, fmt.Errorf("should not delete %s", details.ConfPath)
}
return configApply, nil
}

// Ensure all config files are within the allowed list directories.
confDir := filepath.Dir(details.ConfPath)
if err := ensureFilesAllowed(confFiles, n.config.AllowedDirectoriesMap, confDir); err != nil {
return nil, err
}
func (n *NginxBinaryType) writeConfigWithNoFileActions(details *proto.NginxDetails, config *proto.NginxConfig, systemNginxConfig *proto.NginxConfig) (*sdk.ConfigApply, error) {
confFiles, auxFiles, err := sdk.GetNginxConfigFiles(config)
if err != nil {
return nil, err
}

// Ensure all aux files are within the allowed list directories.
if err := ensureFilesAllowed(auxFiles, n.config.AllowedDirectoriesMap, config.GetZaux().GetRootDirectory()); err != nil {
return nil, err
}
configApply, err := sdk.NewConfigApplyWithIgnoreDirectives(details.ConfPath, n.config.AllowedDirectoriesMap, n.config.IgnoreDirectives)
if err != nil {
log.Warnf("config_apply error: %s", err)
return configApply, err
}

// Ensure this config request does not remove the process config
if !hasConfPath(confFiles, details.ConfPath) {
return configApply, fmt.Errorf("should not delete %s", details.ConfPath)
}

// TODO: return to Control Plane that there was a rollback
err = n.env.WriteFiles(configApply, confFiles, filepath.Dir(details.ConfPath), n.config.AllowedDirectoriesMap)
// Ensure all config files are within the allowed list directories.
confDir := filepath.Dir(details.ConfPath)
if err := ensureFilesAllowed(confFiles, n.config.AllowedDirectoriesMap, confDir); err != nil {
return configApply, err
}

// Ensure all aux files are within the allowed list directories.
if err := ensureFilesAllowed(auxFiles, n.config.AllowedDirectoriesMap, config.GetZaux().GetRootDirectory()); err != nil {
return configApply, err
}

err = n.env.WriteFiles(configApply, confFiles, filepath.Dir(details.ConfPath), n.config.AllowedDirectoriesMap)
if err != nil {
log.Warnf("configuration write failed: %s", err)
n.writeBackup(config, confFiles, auxFiles)
return configApply, err
}

if len(auxFiles) > 0 {
auxPath := config.GetZaux().GetRootDirectory()
err = n.env.WriteFiles(configApply, auxFiles, auxPath, n.config.AllowedDirectoriesMap)
if err != nil {
log.Warnf("configuration write failed: %s", err)
n.writeBackup(config, confFiles, auxFiles)
log.Warnf("Auxiliary files write failed: %s", err)
return configApply, err
}
}

if len(auxFiles) > 0 {
auxPath := config.GetZaux().GetRootDirectory()
err = n.env.WriteFiles(configApply, auxFiles, auxPath, n.config.AllowedDirectoriesMap)
if err != nil {
log.Warnf("Auxiliary files write failed: %s", err)
return configApply, err
}
filesToDelete, ok := generateDeleteFromDirectoryMap(config.DirectoryMap, n.config.AllowedDirectoriesMap)
if ok {
log.Debugf("use explicit set action for delete files %s", filesToDelete)
} else {
// Delete files that are not in the directory map
filesToDelete = getDirectoryMapDiff(systemNginxConfig.DirectoryMap.Directories, config.DirectoryMap.Directories)
}

fileDeleted := make(map[string]struct{})
for _, file := range filesToDelete {
log.Infof("Deleting file: %s", file)
if _, ok = fileDeleted[file]; ok {
continue
}

filesToDelete, ok := generateDeleteFromDirectoryMap(config.DirectoryMap, n.config.AllowedDirectoriesMap)
if ok {
log.Debugf("use explicit set action for delete files %s", filesToDelete)
} else {
// Delete files that are not in the directory map
filesToDelete = getDirectoryMapDiff(systemNginxConfig.DirectoryMap.Directories, config.DirectoryMap.Directories)
if err := n.env.DeleteFile(configApply, file); err != nil {
return configApply, err
}

fileDeleted := make(map[string]struct{})
for _, file := range filesToDelete {
log.Infof("Deleting file: %s", file)
if _, ok = fileDeleted[file]; ok {
continue
}
fileDeleted[file] = struct{}{}
}

if err := n.env.DeleteFile(configApply, file); err != nil {
return configApply, err
}
return configApply, nil
}

fileDeleted[file] = struct{}{}
}
} else {
configApply, err = sdk.NewConfigApplyWithIgnoreDirectives("", n.config.AllowedDirectoriesMap, n.config.IgnoreDirectives)
if err != nil {
log.Warnf("config_apply error: %s", err)
return nil, err
}
func (n *NginxBinaryType) writeConfigWithWithFileActions(config *proto.NginxConfig, details *proto.NginxDetails, filesToUpdate map[string]proto.File_Action, filesToDelete map[string]proto.File_Action) (*sdk.ConfigApply, error) {
confFiles, auxFiles, err := sdk.GetNginxConfigFiles(config)
if err != nil {
return nil, err
}

for _, file := range confFiles {
rootDirectoryPath := filepath.Dir(details.ConfPath)
if _, found := filesToUpdate[file.Name]; !found {
continue
}
configApply, err := sdk.NewConfigApplyWithIgnoreDirectives("", n.config.AllowedDirectoriesMap, n.config.IgnoreDirectives)
if err != nil {
log.Warnf("config_apply error: %s", err)
return nil, err
}

if err := n.env.WriteFile(configApply, file, rootDirectoryPath); err != nil {
log.Warnf("configuration write failed: %s", err)
return configApply, err
}
for _, file := range confFiles {
rootDirectoryPath := filepath.Dir(details.ConfPath)
if _, found := filesToUpdate[file.Name]; !found {
log.Debugf("No action found for config file %s.", file.Name)
continue
}

for _, file := range auxFiles {
rootDirectoryPath := config.GetZaux().GetRootDirectory()
if _, found := filesToUpdate[file.Name]; !found {
continue
}
delete(filesToUpdate, file.Name)

if err := n.env.WriteFile(configApply, file, rootDirectoryPath); err != nil {
log.Warnf("configuration write failed: %s", err)
return configApply, err
}
if err := n.env.WriteFile(configApply, file, rootDirectoryPath); err != nil {
log.Warnf("configuration write failed: %s", err)
return configApply, err
}
}

for file := range filesToDelete {
log.Infof("Deleting file: %s", file)
if err := n.env.DeleteFile(configApply, file); err != nil {
return configApply, err
}
for _, file := range auxFiles {
rootDirectoryPath := config.GetZaux().GetRootDirectory()
if _, found := filesToUpdate[file.Name]; !found {
log.Debugf("No action found for aux file %s.", file.Name)
continue
}

delete(filesToUpdate, file.Name)

if err := n.env.WriteFile(configApply, file, rootDirectoryPath); err != nil {
log.Warnf("configuration write failed: %s", err)
return configApply, err
}
}

for file, action := range filesToUpdate {
log.Warnf("File %s missing from NginxConfig message. Unable to perform action %s.", file, action.String())
}

for file := range filesToDelete {
log.Infof("Deleting file: %s", file)
if err := n.env.DeleteFile(configApply, file); err != nil {
return configApply, err
}
}
return configApply, nil
}

Expand Down Expand Up @@ -564,7 +592,7 @@ func generateActionMaps(
for _, f := range dir.Files {
path := filepath.Join(dir.Name, f.Name)

log.Tracef("file %s has action %v", path, f.Action)
log.Debugf("file %s has action %v", path, f.Action)

// Can't support relative paths
if !filepath.IsAbs(path) {
Expand All @@ -577,14 +605,17 @@ func generateActionMaps(

if f.Action == proto.File_unset {
allFilesHaveAnAction = false
return
}

if f.Action == proto.File_add || f.Action == proto.File_update {
filesToUpdate[path] = f.Action
continue
}

if f.Action == proto.File_delete {
filesToDelete[path] = f.Action
continue
}

}
Expand Down
6 changes: 2 additions & 4 deletions src/core/nginx_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1466,10 +1466,8 @@ func TestGenerateActionMaps(t *testing.T) {
},
},
expectedFilesToUpdate: map[string]proto.File_Action{},
expectedFilesToDelete: map[string]proto.File_Action{
"/testDir/test-delete.conf": proto.File_delete,
},
allFilesHaveAnAction: false,
expectedFilesToDelete: map[string]proto.File_Action{},
allFilesHaveAnAction: false,
},
{
name: "NoSupportForRelativePaths",
Expand Down
Loading

0 comments on commit e3df68a

Please sign in to comment.