2016-07-18 23:47:59 +00:00
// Package generate implements functions generating container config files.
package generate
import (
"encoding/json"
"fmt"
"io"
"os"
"runtime"
"strconv"
"strings"
rspec "github.com/opencontainers/runtime-spec/specs-go"
"github.com/syndtr/gocapability/capability"
)
var (
// Namespaces include the names of supported namespaces.
Namespaces = [ ] string { "network" , "pid" , "mount" , "ipc" , "uts" , "user" , "cgroup" }
)
// Generator represents a generator for a container spec.
type Generator struct {
2016-07-27 19:13:03 +00:00
spec * rspec . Spec
HostSpecific bool
2016-07-18 23:47:59 +00:00
}
// New creates a spec Generator with the default spec.
func New ( ) Generator {
spec := rspec . Spec {
Version : rspec . Version ,
Platform : rspec . Platform {
OS : runtime . GOOS ,
Arch : runtime . GOARCH ,
} ,
Root : rspec . Root {
Path : "" ,
Readonly : false ,
} ,
Process : rspec . Process {
Terminal : false ,
User : rspec . User { } ,
Args : [ ] string {
"sh" ,
} ,
Env : [ ] string {
"PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin" ,
"TERM=xterm" ,
} ,
Cwd : "/" ,
Capabilities : [ ] string {
"CAP_CHOWN" ,
"CAP_DAC_OVERRIDE" ,
"CAP_FSETID" ,
"CAP_FOWNER" ,
"CAP_MKNOD" ,
"CAP_NET_RAW" ,
"CAP_SETGID" ,
"CAP_SETUID" ,
"CAP_SETFCAP" ,
"CAP_SETPCAP" ,
"CAP_NET_BIND_SERVICE" ,
"CAP_SYS_CHROOT" ,
"CAP_KILL" ,
"CAP_AUDIT_WRITE" ,
} ,
Rlimits : [ ] rspec . Rlimit {
{
Type : "RLIMIT_NOFILE" ,
Hard : uint64 ( 1024 ) ,
Soft : uint64 ( 1024 ) ,
} ,
} ,
} ,
Hostname : "mrsdalloway" ,
Mounts : [ ] rspec . Mount {
{
Destination : "/proc" ,
Type : "proc" ,
Source : "proc" ,
Options : nil ,
} ,
{
Destination : "/dev" ,
Type : "tmpfs" ,
Source : "tmpfs" ,
Options : [ ] string { "nosuid" , "strictatime" , "mode=755" , "size=65536k" } ,
} ,
{
Destination : "/dev/pts" ,
Type : "devpts" ,
Source : "devpts" ,
Options : [ ] string { "nosuid" , "noexec" , "newinstance" , "ptmxmode=0666" , "mode=0620" , "gid=5" } ,
} ,
{
Destination : "/dev/shm" ,
Type : "tmpfs" ,
Source : "shm" ,
Options : [ ] string { "nosuid" , "noexec" , "nodev" , "mode=1777" , "size=65536k" } ,
} ,
{
Destination : "/dev/mqueue" ,
Type : "mqueue" ,
Source : "mqueue" ,
Options : [ ] string { "nosuid" , "noexec" , "nodev" } ,
} ,
{
Destination : "/sys" ,
Type : "sysfs" ,
Source : "sysfs" ,
Options : [ ] string { "nosuid" , "noexec" , "nodev" , "ro" } ,
} ,
} ,
Linux : & rspec . Linux {
Resources : & rspec . Resources {
Devices : [ ] rspec . DeviceCgroup {
{
Allow : false ,
Access : strPtr ( "rwm" ) ,
} ,
} ,
} ,
Namespaces : [ ] rspec . Namespace {
{
Type : "pid" ,
} ,
{
Type : "network" ,
} ,
{
Type : "ipc" ,
} ,
{
Type : "uts" ,
} ,
{
Type : "mount" ,
} ,
} ,
Devices : [ ] rspec . Device { } ,
} ,
}
2016-07-27 19:13:03 +00:00
return Generator {
spec : & spec ,
}
2016-07-18 23:47:59 +00:00
}
// NewFromSpec creates a spec Generator from a given spec.
func NewFromSpec ( spec * rspec . Spec ) Generator {
2016-07-27 19:13:03 +00:00
return Generator {
spec : spec ,
}
2016-07-18 23:47:59 +00:00
}
// NewFromFile loads the template specifed in a file into a spec Generator.
func NewFromFile ( path string ) ( Generator , error ) {
cf , err := os . Open ( path )
if err != nil {
if os . IsNotExist ( err ) {
return Generator { } , fmt . Errorf ( "template configuration at %s not found" , path )
}
}
defer cf . Close ( )
return NewFromTemplate ( cf )
}
// NewFromTemplate loads the template from io.Reader into a spec Generator.
func NewFromTemplate ( r io . Reader ) ( Generator , error ) {
var spec rspec . Spec
if err := json . NewDecoder ( r ) . Decode ( & spec ) ; err != nil {
return Generator { } , err
}
2016-07-27 19:13:03 +00:00
return Generator {
spec : & spec ,
} , nil
2016-07-18 23:47:59 +00:00
}
// SetSpec sets the spec in the Generator g.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetSpec ( spec * rspec . Spec ) {
2016-07-18 23:47:59 +00:00
g . spec = spec
}
2016-07-27 19:13:03 +00:00
// Spec gets the spec in the Generator g.
func ( g * Generator ) Spec ( ) * rspec . Spec {
2016-07-18 23:47:59 +00:00
return g . spec
}
// Save writes the spec into w.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) Save ( w io . Writer ) error {
2016-07-18 23:47:59 +00:00
data , err := json . MarshalIndent ( g . spec , "" , "\t" )
if err != nil {
return err
}
_ , err = w . Write ( data )
if err != nil {
return err
}
return nil
}
// SaveToFile writes the spec into a file.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SaveToFile ( path string ) error {
2016-07-18 23:47:59 +00:00
f , err := os . Create ( path )
if err != nil {
return err
}
defer f . Close ( )
return g . Save ( f )
}
// SetVersion sets g.spec.Version.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetVersion ( version string ) {
g . initSpec ( )
2016-07-18 23:47:59 +00:00
g . spec . Version = version
}
// SetRootPath sets g.spec.Root.Path.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetRootPath ( path string ) {
g . initSpec ( )
2016-07-18 23:47:59 +00:00
g . spec . Root . Path = path
}
// SetRootReadonly sets g.spec.Root.Readonly.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetRootReadonly ( b bool ) {
g . initSpec ( )
2016-07-18 23:47:59 +00:00
g . spec . Root . Readonly = b
}
// SetHostname sets g.spec.Hostname.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetHostname ( s string ) {
g . initSpec ( )
2016-07-18 23:47:59 +00:00
g . spec . Hostname = s
}
// ClearAnnotations clears g.spec.Annotations.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) ClearAnnotations ( ) {
2016-08-01 22:35:33 +00:00
if g . spec == nil {
return
}
2016-07-18 23:47:59 +00:00
g . spec . Annotations = make ( map [ string ] string )
}
// AddAnnotation adds an annotation into g.spec.Annotations.
2016-08-01 22:35:33 +00:00
func ( g * Generator ) AddAnnotation ( key , value string ) {
2016-07-27 19:13:03 +00:00
g . initSpecAnnotations ( )
2016-08-01 22:35:33 +00:00
g . spec . Annotations [ key ] = value
2016-07-18 23:47:59 +00:00
}
// RemoveAnnotation remove an annotation from g.spec.Annotations.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) RemoveAnnotation ( key string ) {
if g . spec == nil || g . spec . Annotations == nil {
2016-07-18 23:47:59 +00:00
return
}
delete ( g . spec . Annotations , key )
}
// SetPlatformOS sets g.spec.Process.OS.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetPlatformOS ( os string ) {
g . initSpec ( )
2016-07-18 23:47:59 +00:00
g . spec . Platform . OS = os
}
// SetPlatformArch sets g.spec.Platform.Arch.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetPlatformArch ( arch string ) {
g . initSpec ( )
2016-07-18 23:47:59 +00:00
g . spec . Platform . Arch = arch
}
// SetProcessUID sets g.spec.Process.User.UID.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetProcessUID ( uid uint32 ) {
g . initSpec ( )
2016-07-18 23:47:59 +00:00
g . spec . Process . User . UID = uid
}
// SetProcessGID sets g.spec.Process.User.GID.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetProcessGID ( gid uint32 ) {
g . initSpec ( )
2016-07-18 23:47:59 +00:00
g . spec . Process . User . GID = gid
}
// SetProcessCwd sets g.spec.Process.Cwd.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetProcessCwd ( cwd string ) {
g . initSpec ( )
2016-07-18 23:47:59 +00:00
g . spec . Process . Cwd = cwd
}
// SetProcessNoNewPrivileges sets g.spec.Process.NoNewPrivileges.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetProcessNoNewPrivileges ( b bool ) {
g . initSpec ( )
2016-07-18 23:47:59 +00:00
g . spec . Process . NoNewPrivileges = b
}
// SetProcessTerminal sets g.spec.Process.Terminal.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetProcessTerminal ( b bool ) {
g . initSpec ( )
2016-07-18 23:47:59 +00:00
g . spec . Process . Terminal = b
}
// SetProcessApparmorProfile sets g.spec.Process.ApparmorProfile.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetProcessApparmorProfile ( prof string ) {
g . initSpec ( )
2016-07-18 23:47:59 +00:00
g . spec . Process . ApparmorProfile = prof
}
// SetProcessArgs sets g.spec.Process.Args.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetProcessArgs ( args [ ] string ) {
g . initSpec ( )
2016-07-18 23:47:59 +00:00
g . spec . Process . Args = args
}
// ClearProcessEnv clears g.spec.Process.Env.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) ClearProcessEnv ( ) {
2016-08-01 22:35:33 +00:00
if g . spec == nil {
return
}
2016-07-18 23:47:59 +00:00
g . spec . Process . Env = [ ] string { }
}
// AddProcessEnv adds env into g.spec.Process.Env.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) AddProcessEnv ( env string ) {
g . initSpec ( )
2016-07-18 23:47:59 +00:00
g . spec . Process . Env = append ( g . spec . Process . Env , env )
}
// ClearProcessAdditionalGids clear g.spec.Process.AdditionalGids.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) ClearProcessAdditionalGids ( ) {
2016-08-01 22:35:33 +00:00
if g . spec == nil {
return
}
2016-07-18 23:47:59 +00:00
g . spec . Process . User . AdditionalGids = [ ] uint32 { }
}
// AddProcessAdditionalGid adds an additional gid into g.spec.Process.AdditionalGids.
2016-08-01 22:35:33 +00:00
func ( g * Generator ) AddProcessAdditionalGid ( gid uint32 ) {
2016-07-27 19:13:03 +00:00
g . initSpec ( )
2016-07-18 23:47:59 +00:00
for _ , group := range g . spec . Process . User . AdditionalGids {
2016-08-01 22:35:33 +00:00
if group == gid {
return
2016-07-18 23:47:59 +00:00
}
}
2016-08-01 22:35:33 +00:00
g . spec . Process . User . AdditionalGids = append ( g . spec . Process . User . AdditionalGids , gid )
2016-07-18 23:47:59 +00:00
}
// SetProcessSelinuxLabel sets g.spec.Process.SelinuxLabel.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetProcessSelinuxLabel ( label string ) {
g . initSpec ( )
2016-07-18 23:47:59 +00:00
g . spec . Process . SelinuxLabel = label
}
// SetLinuxCgroupsPath sets g.spec.Linux.CgroupsPath.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetLinuxCgroupsPath ( path string ) {
g . initSpecLinux ( )
2016-07-18 23:47:59 +00:00
g . spec . Linux . CgroupsPath = strPtr ( path )
}
// SetLinuxMountLabel sets g.spec.Linux.MountLabel.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetLinuxMountLabel ( label string ) {
g . initSpecLinux ( )
2016-07-18 23:47:59 +00:00
g . spec . Linux . MountLabel = label
}
2016-08-08 13:55:11 +00:00
// SetLinuxResourcesOOMScoreAdj sets g.spec.Linux.Resources.OOMScoreAdj.
func ( g * Generator ) SetLinuxResourcesOOMScoreAdj ( adj int ) {
g . initSpecLinuxResources ( )
g . spec . Linux . Resources . OOMScoreAdj = & adj
}
2016-07-20 01:30:05 +00:00
// SetLinuxResourcesCPUShares sets g.spec.Linux.Resources.CPU.Shares.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetLinuxResourcesCPUShares ( shares uint64 ) {
g . initSpecLinuxResourcesCPU ( )
2016-07-20 01:30:05 +00:00
g . spec . Linux . Resources . CPU . Shares = & shares
}
// SetLinuxResourcesCPUQuota sets g.spec.Linux.Resources.CPU.Quota.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetLinuxResourcesCPUQuota ( quota uint64 ) {
g . initSpecLinuxResourcesCPU ( )
2016-07-20 01:30:05 +00:00
g . spec . Linux . Resources . CPU . Quota = & quota
}
// SetLinuxResourcesCPUPeriod sets g.spec.Linux.Resources.CPU.Period.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetLinuxResourcesCPUPeriod ( period uint64 ) {
g . initSpecLinuxResourcesCPU ( )
2016-07-20 01:30:05 +00:00
g . spec . Linux . Resources . CPU . Period = & period
}
// SetLinuxResourcesCPURealtimeRuntime sets g.spec.Linux.Resources.CPU.RealtimeRuntime.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetLinuxResourcesCPURealtimeRuntime ( time uint64 ) {
g . initSpecLinuxResourcesCPU ( )
2016-07-20 01:30:05 +00:00
g . spec . Linux . Resources . CPU . RealtimeRuntime = & time
}
// SetLinuxResourcesCPURealtimePeriod sets g.spec.Linux.Resources.CPU.RealtimePeriod.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetLinuxResourcesCPURealtimePeriod ( period uint64 ) {
g . initSpecLinuxResourcesCPU ( )
2016-07-20 01:30:05 +00:00
g . spec . Linux . Resources . CPU . RealtimePeriod = & period
}
// SetLinuxResourcesCPUCpus sets g.spec.Linux.Resources.CPU.Cpus.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetLinuxResourcesCPUCpus ( cpus string ) {
g . initSpecLinuxResourcesCPU ( )
2016-07-20 01:30:05 +00:00
g . spec . Linux . Resources . CPU . Cpus = & cpus
}
// SetLinuxResourcesCPUMems sets g.spec.Linux.Resources.CPU.Mems.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetLinuxResourcesCPUMems ( mems string ) {
g . initSpecLinuxResourcesCPU ( )
2016-07-20 01:30:05 +00:00
g . spec . Linux . Resources . CPU . Mems = & mems
}
// SetLinuxResourcesMemoryLimit sets g.spec.Linux.Resources.Memory.Limit.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetLinuxResourcesMemoryLimit ( limit uint64 ) {
g . initSpecLinuxResourcesMemory ( )
2016-07-20 01:30:05 +00:00
g . spec . Linux . Resources . Memory . Limit = & limit
}
// SetLinuxResourcesMemoryReservation sets g.spec.Linux.Resources.Memory.Reservation.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetLinuxResourcesMemoryReservation ( reservation uint64 ) {
g . initSpecLinuxResourcesMemory ( )
2016-07-20 01:30:05 +00:00
g . spec . Linux . Resources . Memory . Reservation = & reservation
}
// SetLinuxResourcesMemorySwap sets g.spec.Linux.Resources.Memory.Swap.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetLinuxResourcesMemorySwap ( swap uint64 ) {
g . initSpecLinuxResourcesMemory ( )
2016-07-20 01:30:05 +00:00
g . spec . Linux . Resources . Memory . Swap = & swap
}
// SetLinuxResourcesMemoryKernel sets g.spec.Linux.Resources.Memory.Kernel.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetLinuxResourcesMemoryKernel ( kernel uint64 ) {
g . initSpecLinuxResourcesMemory ( )
2016-07-20 01:30:05 +00:00
g . spec . Linux . Resources . Memory . Kernel = & kernel
}
// SetLinuxResourcesMemoryKernelTCP sets g.spec.Linux.Resources.Memory.KernelTCP.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetLinuxResourcesMemoryKernelTCP ( kernelTCP uint64 ) {
g . initSpecLinuxResourcesMemory ( )
2016-07-20 01:30:05 +00:00
g . spec . Linux . Resources . Memory . KernelTCP = & kernelTCP
}
// SetLinuxResourcesMemorySwappiness sets g.spec.Linux.Resources.Memory.Swappiness.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetLinuxResourcesMemorySwappiness ( swappiness uint64 ) {
g . initSpecLinuxResourcesMemory ( )
2016-07-20 01:30:05 +00:00
g . spec . Linux . Resources . Memory . Swappiness = & swappiness
}
2016-07-18 23:47:59 +00:00
// ClearLinuxSysctl clears g.spec.Linux.Sysctl.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) ClearLinuxSysctl ( ) {
if g . spec == nil || g . spec . Linux == nil {
return
}
2016-07-18 23:47:59 +00:00
g . spec . Linux . Sysctl = make ( map [ string ] string )
}
// AddLinuxSysctl adds a new sysctl config into g.spec.Linux.Sysctl.
2016-08-01 22:35:33 +00:00
func ( g * Generator ) AddLinuxSysctl ( key , value string ) {
2016-07-27 19:13:03 +00:00
g . initSpecLinuxSysctl ( )
2016-08-01 22:35:33 +00:00
g . spec . Linux . Sysctl [ key ] = value
2016-07-18 23:47:59 +00:00
}
// RemoveLinuxSysctl removes a sysctl config from g.spec.Linux.Sysctl.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) RemoveLinuxSysctl ( key string ) {
if g . spec == nil || g . spec . Linux == nil || g . spec . Linux . Sysctl == nil {
2016-07-18 23:47:59 +00:00
return
}
delete ( g . spec . Linux . Sysctl , key )
}
// SetLinuxSeccompDefault sets g.spec.Linux.Seccomp.DefaultAction.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetLinuxSeccompDefault ( sdefault string ) error {
2016-07-18 23:47:59 +00:00
switch sdefault {
case "" :
case "SCMP_ACT_KILL" :
case "SCMP_ACT_TRAP" :
case "SCMP_ACT_ERRNO" :
case "SCMP_ACT_TRACE" :
case "SCMP_ACT_ALLOW" :
default :
return fmt . Errorf ( "seccomp-default must be empty or one of " +
"SCMP_ACT_KILL|SCMP_ACT_TRAP|SCMP_ACT_ERRNO|SCMP_ACT_TRACE|" +
"SCMP_ACT_ALLOW" )
}
2016-07-27 19:13:03 +00:00
g . initSpecLinuxSeccomp ( )
2016-07-18 23:47:59 +00:00
g . spec . Linux . Seccomp . DefaultAction = rspec . Action ( sdefault )
return nil
}
func checkSeccompArch ( arch string ) error {
switch arch {
case "" :
case "SCMP_ARCH_X86" :
case "SCMP_ARCH_X86_64" :
case "SCMP_ARCH_X32" :
case "SCMP_ARCH_ARM" :
case "SCMP_ARCH_AARCH64" :
case "SCMP_ARCH_MIPS" :
case "SCMP_ARCH_MIPS64" :
case "SCMP_ARCH_MIPS64N32" :
case "SCMP_ARCH_MIPSEL" :
case "SCMP_ARCH_MIPSEL64" :
case "SCMP_ARCH_MIPSEL64N32" :
default :
return fmt . Errorf ( "seccomp-arch must be empty or one of " +
"SCMP_ARCH_X86|SCMP_ARCH_X86_64|SCMP_ARCH_X32|SCMP_ARCH_ARM|" +
"SCMP_ARCH_AARCH64SCMP_ARCH_MIPS|SCMP_ARCH_MIPS64|" +
"SCMP_ARCH_MIPS64N32|SCMP_ARCH_MIPSEL|SCMP_ARCH_MIPSEL64|" +
"SCMP_ARCH_MIPSEL64N32" )
}
return nil
}
// ClearLinuxSeccompArch clears g.spec.Linux.Seccomp.Architectures.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) ClearLinuxSeccompArch ( ) {
if g . spec == nil || g . spec . Linux == nil || g . spec . Linux . Seccomp == nil {
2016-07-18 23:47:59 +00:00
return
}
g . spec . Linux . Seccomp . Architectures = [ ] rspec . Arch { }
}
// AddLinuxSeccompArch adds sArch into g.spec.Linux.Seccomp.Architectures.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) AddLinuxSeccompArch ( sArch string ) error {
2016-07-18 23:47:59 +00:00
if err := checkSeccompArch ( sArch ) ; err != nil {
return err
}
2016-07-27 19:13:03 +00:00
g . initSpecLinuxSeccomp ( )
2016-07-18 23:47:59 +00:00
g . spec . Linux . Seccomp . Architectures = append ( g . spec . Linux . Seccomp . Architectures , rspec . Arch ( sArch ) )
return nil
}
// RemoveSeccompArch removes sArch from g.spec.Linux.Seccomp.Architectures.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) RemoveSeccompArch ( sArch string ) error {
2016-07-18 23:47:59 +00:00
if err := checkSeccompArch ( sArch ) ; err != nil {
return err
}
2016-07-27 19:13:03 +00:00
if g . spec == nil || g . spec . Linux == nil || g . spec . Linux . Seccomp == nil {
2016-07-18 23:47:59 +00:00
return nil
}
for i , arch := range g . spec . Linux . Seccomp . Architectures {
if string ( arch ) == sArch {
g . spec . Linux . Seccomp . Architectures = append ( g . spec . Linux . Seccomp . Architectures [ : i ] , g . spec . Linux . Seccomp . Architectures [ i + 1 : ] ... )
return nil
}
}
return nil
}
func checkSeccompSyscallAction ( syscall string ) error {
switch syscall {
case "" :
case "SCMP_ACT_KILL" :
case "SCMP_ACT_TRAP" :
case "SCMP_ACT_ERRNO" :
case "SCMP_ACT_TRACE" :
case "SCMP_ACT_ALLOW" :
default :
return fmt . Errorf ( "seccomp-syscall action must be empty or " +
"one of SCMP_ACT_KILL|SCMP_ACT_TRAP|SCMP_ACT_ERRNO|" +
"SCMP_ACT_TRACE|SCMP_ACT_ALLOW" )
}
return nil
}
func checkSeccompSyscallArg ( arg string ) error {
switch arg {
case "" :
case "SCMP_CMP_NE" :
case "SCMP_CMP_LT" :
case "SCMP_CMP_LE" :
case "SCMP_CMP_EQ" :
case "SCMP_CMP_GE" :
case "SCMP_CMP_GT" :
case "SCMP_CMP_MASKED_EQ" :
default :
return fmt . Errorf ( "seccomp-syscall args must be " +
"empty or one of SCMP_CMP_NE|SCMP_CMP_LT|" +
"SCMP_CMP_LE|SCMP_CMP_EQ|SCMP_CMP_GE|" +
"SCMP_CMP_GT|SCMP_CMP_MASKED_EQ" )
}
return nil
}
func parseSeccompSyscall ( s string ) ( rspec . Syscall , error ) {
syscall := strings . Split ( s , ":" )
if len ( syscall ) != 3 {
return rspec . Syscall { } , fmt . Errorf ( "seccomp sysctl must consist of 3 parameters" )
}
name := syscall [ 0 ]
if err := checkSeccompSyscallAction ( syscall [ 1 ] ) ; err != nil {
return rspec . Syscall { } , err
}
action := rspec . Action ( syscall [ 1 ] )
var Args [ ] rspec . Arg
if strings . EqualFold ( syscall [ 2 ] , "" ) {
Args = nil
} else {
argsslice := strings . Split ( syscall [ 2 ] , "," )
for _ , argsstru := range argsslice {
args := strings . Split ( argsstru , "/" )
if len ( args ) == 4 {
index , err := strconv . Atoi ( args [ 0 ] )
value , err := strconv . Atoi ( args [ 1 ] )
value2 , err := strconv . Atoi ( args [ 2 ] )
if err != nil {
return rspec . Syscall { } , err
}
if err := checkSeccompSyscallArg ( args [ 3 ] ) ; err != nil {
return rspec . Syscall { } , err
}
op := rspec . Operator ( args [ 3 ] )
Arg := rspec . Arg {
Index : uint ( index ) ,
Value : uint64 ( value ) ,
ValueTwo : uint64 ( value2 ) ,
Op : op ,
}
Args = append ( Args , Arg )
} else {
return rspec . Syscall { } , fmt . Errorf ( "seccomp-sysctl args error: %s" , argsstru )
}
}
}
return rspec . Syscall {
Name : name ,
Action : action ,
Args : Args ,
} , nil
}
// ClearLinuxSeccompSyscall clears g.spec.Linux.Seccomp.Syscalls.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) ClearLinuxSeccompSyscall ( ) {
if g . spec == nil || g . spec . Linux == nil || g . spec . Linux . Seccomp == nil {
2016-07-18 23:47:59 +00:00
return
}
g . spec . Linux . Seccomp . Syscalls = [ ] rspec . Syscall { }
}
// AddLinuxSeccompSyscall adds sSyscall into g.spec.Linux.Seccomp.Syscalls.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) AddLinuxSeccompSyscall ( sSyscall string ) error {
2016-07-18 23:47:59 +00:00
f , err := parseSeccompSyscall ( sSyscall )
if err != nil {
return err
}
2016-07-27 19:13:03 +00:00
g . initSpecLinuxSeccomp ( )
2016-07-18 23:47:59 +00:00
g . spec . Linux . Seccomp . Syscalls = append ( g . spec . Linux . Seccomp . Syscalls , f )
return nil
}
// AddLinuxSeccompSyscallAllow adds seccompAllow into g.spec.Linux.Seccomp.Syscalls.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) AddLinuxSeccompSyscallAllow ( seccompAllow string ) {
2016-07-18 23:47:59 +00:00
syscall := rspec . Syscall {
Name : seccompAllow ,
Action : "SCMP_ACT_ALLOW" ,
}
2016-07-27 19:13:03 +00:00
g . initSpecLinuxSeccomp ( )
2016-07-18 23:47:59 +00:00
g . spec . Linux . Seccomp . Syscalls = append ( g . spec . Linux . Seccomp . Syscalls , syscall )
}
// AddLinuxSeccompSyscallErrno adds seccompErrno into g.spec.Linux.Seccomp.Syscalls.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) AddLinuxSeccompSyscallErrno ( seccompErrno string ) {
2016-07-18 23:47:59 +00:00
syscall := rspec . Syscall {
Name : seccompErrno ,
Action : "SCMP_ACT_ERRNO" ,
}
2016-07-27 19:13:03 +00:00
g . initSpecLinuxSeccomp ( )
2016-07-18 23:47:59 +00:00
g . spec . Linux . Seccomp . Syscalls = append ( g . spec . Linux . Seccomp . Syscalls , syscall )
}
// RemoveSeccompSyscallByName removes all the seccomp syscalls with the given
// name from g.spec.Linux.Seccomp.Syscalls.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) RemoveSeccompSyscallByName ( name string ) error {
if g . spec == nil || g . spec . Linux == nil || g . spec . Linux . Seccomp == nil {
2016-07-18 23:47:59 +00:00
return nil
}
var r [ ] rspec . Syscall
for _ , syscall := range g . spec . Linux . Seccomp . Syscalls {
if strings . Compare ( name , syscall . Name ) != 0 {
r = append ( r , syscall )
}
}
g . spec . Linux . Seccomp . Syscalls = r
return nil
}
// RemoveSeccompSyscallByAction removes all the seccomp syscalls with the given
// action from g.spec.Linux.Seccomp.Syscalls.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) RemoveSeccompSyscallByAction ( action string ) error {
if g . spec == nil || g . spec . Linux == nil || g . spec . Linux . Seccomp == nil {
2016-07-18 23:47:59 +00:00
return nil
}
if err := checkSeccompSyscallAction ( action ) ; err != nil {
return err
}
var r [ ] rspec . Syscall
for _ , syscall := range g . spec . Linux . Seccomp . Syscalls {
if strings . Compare ( action , string ( syscall . Action ) ) != 0 {
r = append ( r , syscall )
}
}
g . spec . Linux . Seccomp . Syscalls = r
return nil
}
// RemoveSeccompSyscall removes all the seccomp syscalls with the given
// name and action from g.spec.Linux.Seccomp.Syscalls.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) RemoveSeccompSyscall ( name string , action string ) error {
if g . spec == nil || g . spec . Linux == nil || g . spec . Linux . Seccomp == nil {
2016-07-18 23:47:59 +00:00
return nil
}
if err := checkSeccompSyscallAction ( action ) ; err != nil {
return err
}
var r [ ] rspec . Syscall
for _ , syscall := range g . spec . Linux . Seccomp . Syscalls {
if ! ( strings . Compare ( name , syscall . Name ) == 0 &&
strings . Compare ( action , string ( syscall . Action ) ) == 0 ) {
r = append ( r , syscall )
}
}
g . spec . Linux . Seccomp . Syscalls = r
return nil
}
// ClearLinuxUIDMappings clear g.spec.Linux.UIDMappings.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) ClearLinuxUIDMappings ( ) {
if g . spec == nil || g . spec . Linux == nil {
return
}
2016-07-18 23:47:59 +00:00
g . spec . Linux . UIDMappings = [ ] rspec . IDMapping { }
}
// AddLinuxUIDMapping adds uidMap into g.spec.Linux.UIDMappings.
2016-08-01 22:35:33 +00:00
func ( g * Generator ) AddLinuxUIDMapping ( hid , cid , size uint32 ) {
idMapping := rspec . IDMapping {
HostID : hid ,
ContainerID : cid ,
Size : size ,
2016-07-18 23:47:59 +00:00
}
2016-07-27 19:13:03 +00:00
g . initSpecLinux ( )
2016-08-01 22:35:33 +00:00
g . spec . Linux . UIDMappings = append ( g . spec . Linux . UIDMappings , idMapping )
2016-07-18 23:47:59 +00:00
}
// ClearLinuxGIDMappings clear g.spec.Linux.GIDMappings.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) ClearLinuxGIDMappings ( ) {
if g . spec == nil || g . spec . Linux == nil {
return
}
2016-07-18 23:47:59 +00:00
g . spec . Linux . GIDMappings = [ ] rspec . IDMapping { }
}
// AddLinuxGIDMapping adds gidMap into g.spec.Linux.GIDMappings.
2016-08-01 22:35:33 +00:00
func ( g * Generator ) AddLinuxGIDMapping ( hid , cid , size uint32 ) {
idMapping := rspec . IDMapping {
HostID : hid ,
ContainerID : cid ,
Size : size ,
2016-07-18 23:47:59 +00:00
}
2016-07-27 19:13:03 +00:00
g . initSpecLinux ( )
2016-08-01 22:35:33 +00:00
g . spec . Linux . GIDMappings = append ( g . spec . Linux . GIDMappings , idMapping )
2016-07-18 23:47:59 +00:00
}
// SetLinuxRootPropagation sets g.spec.Linux.RootfsPropagation.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetLinuxRootPropagation ( rp string ) error {
2016-07-18 23:47:59 +00:00
switch rp {
case "" :
case "private" :
case "rprivate" :
case "slave" :
case "rslave" :
case "shared" :
case "rshared" :
default :
return fmt . Errorf ( "rootfs-propagation must be empty or one of private|rprivate|slave|rslave|shared|rshared" )
}
2016-07-27 19:13:03 +00:00
g . initSpecLinux ( )
2016-07-18 23:47:59 +00:00
g . spec . Linux . RootfsPropagation = rp
return nil
}
// ClearPreStartHooks clear g.spec.Hooks.Prestart.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) ClearPreStartHooks ( ) {
if g . spec == nil {
return
}
2016-07-18 23:47:59 +00:00
g . spec . Hooks . Prestart = [ ] rspec . Hook { }
}
// AddPreStartHook add a prestart hook into g.spec.Hooks.Prestart.
2016-08-01 22:35:33 +00:00
func ( g * Generator ) AddPreStartHook ( path string , args [ ] string ) {
2016-07-27 19:13:03 +00:00
g . initSpec ( )
2016-08-01 22:35:33 +00:00
hook := rspec . Hook { Path : path , Args : args }
2016-07-18 23:47:59 +00:00
g . spec . Hooks . Prestart = append ( g . spec . Hooks . Prestart , hook )
}
// ClearPostStopHooks clear g.spec.Hooks.Poststop.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) ClearPostStopHooks ( ) {
if g . spec == nil {
return
}
2016-07-18 23:47:59 +00:00
g . spec . Hooks . Poststop = [ ] rspec . Hook { }
}
// AddPostStopHook adds a poststop hook into g.spec.Hooks.Poststop.
2016-08-01 22:35:33 +00:00
func ( g * Generator ) AddPostStopHook ( path string , args [ ] string ) {
2016-07-27 19:13:03 +00:00
g . initSpec ( )
2016-08-01 22:35:33 +00:00
hook := rspec . Hook { Path : path , Args : args }
2016-07-18 23:47:59 +00:00
g . spec . Hooks . Poststop = append ( g . spec . Hooks . Poststop , hook )
}
// ClearPostStartHooks clear g.spec.Hooks.Poststart.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) ClearPostStartHooks ( ) {
if g . spec == nil {
return
}
2016-07-18 23:47:59 +00:00
g . spec . Hooks . Poststart = [ ] rspec . Hook { }
}
// AddPostStartHook adds a poststart hook into g.spec.Hooks.Poststart.
2016-08-01 22:35:33 +00:00
func ( g * Generator ) AddPostStartHook ( path string , args [ ] string ) {
2016-07-27 19:13:03 +00:00
g . initSpec ( )
2016-08-01 22:35:33 +00:00
hook := rspec . Hook { Path : path , Args : args }
2016-07-18 23:47:59 +00:00
g . spec . Hooks . Poststart = append ( g . spec . Hooks . Poststart , hook )
}
// AddTmpfsMount adds a tmpfs mount into g.spec.Mounts.
2016-08-01 22:35:33 +00:00
func ( g * Generator ) AddTmpfsMount ( dest string , options [ ] string ) {
2016-07-18 23:47:59 +00:00
mnt := rspec . Mount {
Destination : dest ,
Type : "tmpfs" ,
Source : "tmpfs" ,
2016-08-01 22:35:33 +00:00
Options : options ,
2016-07-18 23:47:59 +00:00
}
2016-07-27 19:13:03 +00:00
g . initSpec ( )
2016-07-18 23:47:59 +00:00
g . spec . Mounts = append ( g . spec . Mounts , mnt )
}
// AddCgroupsMount adds a cgroup mount into g.spec.Mounts.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) AddCgroupsMount ( mountCgroupOption string ) error {
2016-07-18 23:47:59 +00:00
switch mountCgroupOption {
case "ro" :
case "rw" :
2016-08-08 13:55:11 +00:00
break
2016-07-18 23:47:59 +00:00
case "no" :
return nil
default :
return fmt . Errorf ( "--mount-cgroups should be one of (ro,rw,no)" )
}
mnt := rspec . Mount {
Destination : "/sys/fs/cgroup" ,
Type : "cgroup" ,
Source : "cgroup" ,
Options : [ ] string { "nosuid" , "noexec" , "nodev" , "relatime" , mountCgroupOption } ,
}
2016-07-27 19:13:03 +00:00
g . initSpec ( )
2016-07-18 23:47:59 +00:00
g . spec . Mounts = append ( g . spec . Mounts , mnt )
return nil
}
// AddBindMount adds a bind mount into g.spec.Mounts.
2016-08-01 22:35:33 +00:00
func ( g * Generator ) AddBindMount ( source , dest , options string ) {
if options == "" {
options = "ro"
2016-07-18 23:47:59 +00:00
}
defaultOptions := [ ] string { "bind" }
2016-08-01 22:35:33 +00:00
2016-07-18 23:47:59 +00:00
mnt := rspec . Mount {
Destination : dest ,
Type : "bind" ,
Source : source ,
Options : append ( defaultOptions , options ) ,
}
2016-07-27 19:13:03 +00:00
g . initSpec ( )
2016-07-18 23:47:59 +00:00
g . spec . Mounts = append ( g . spec . Mounts , mnt )
}
// SetupPrivileged sets up the priviledge-related fields inside g.spec.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) SetupPrivileged ( privileged bool ) {
2016-07-18 23:47:59 +00:00
if privileged {
// Add all capabilities in privileged mode.
var finalCapList [ ] string
for _ , cap := range capability . List ( ) {
2016-08-01 22:35:33 +00:00
if g . HostSpecific && cap > lastCap ( ) {
2016-07-27 19:13:03 +00:00
continue
}
2016-07-18 23:47:59 +00:00
finalCapList = append ( finalCapList , fmt . Sprintf ( "CAP_%s" , strings . ToUpper ( cap . String ( ) ) ) )
}
2016-07-27 19:13:03 +00:00
g . initSpecLinux ( )
2016-07-18 23:47:59 +00:00
g . spec . Process . Capabilities = finalCapList
g . spec . Process . SelinuxLabel = ""
g . spec . Process . ApparmorProfile = ""
g . spec . Linux . Seccomp = nil
}
}
2016-08-01 22:35:33 +00:00
func lastCap ( ) capability . Cap {
last := capability . CAP_LAST_CAP
// hack for RHEL6 which has no /proc/sys/kernel/cap_last_cap
if last == capability . Cap ( 63 ) {
last = capability . CAP_BLOCK_SUSPEND
}
return last
}
2016-07-27 19:13:03 +00:00
func checkCap ( c string , hostSpecific bool ) error {
2016-07-18 23:47:59 +00:00
isValid := false
cp := strings . ToUpper ( c )
for _ , cap := range capability . List ( ) {
if cp == strings . ToUpper ( cap . String ( ) ) {
2016-08-01 22:35:33 +00:00
if hostSpecific && cap > lastCap ( ) {
2016-07-27 19:13:03 +00:00
return fmt . Errorf ( "CAP_%s is not supported on the current host" , cp )
}
2016-07-18 23:47:59 +00:00
isValid = true
break
}
}
if ! isValid {
return fmt . Errorf ( "Invalid value passed for adding capability" )
}
return nil
}
// ClearProcessCapabilities clear g.spec.Process.Capabilities.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) ClearProcessCapabilities ( ) {
if g . spec == nil {
return
}
2016-07-18 23:47:59 +00:00
g . spec . Process . Capabilities = [ ] string { }
}
// AddProcessCapability adds a process capability into g.spec.Process.Capabilities.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) AddProcessCapability ( c string ) error {
if err := checkCap ( c , g . HostSpecific ) ; err != nil {
2016-07-18 23:47:59 +00:00
return err
}
cp := fmt . Sprintf ( "CAP_%s" , strings . ToUpper ( c ) )
2016-07-27 19:13:03 +00:00
g . initSpec ( )
2016-07-18 23:47:59 +00:00
for _ , cap := range g . spec . Process . Capabilities {
if strings . ToUpper ( cap ) == cp {
return nil
}
}
g . spec . Process . Capabilities = append ( g . spec . Process . Capabilities , cp )
return nil
}
// DropProcessCapability drops a process capability from g.spec.Process.Capabilities.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) DropProcessCapability ( c string ) error {
if err := checkCap ( c , g . HostSpecific ) ; err != nil {
2016-07-18 23:47:59 +00:00
return err
}
cp := fmt . Sprintf ( "CAP_%s" , strings . ToUpper ( c ) )
2016-07-27 19:13:03 +00:00
g . initSpec ( )
2016-07-18 23:47:59 +00:00
for i , cap := range g . spec . Process . Capabilities {
if strings . ToUpper ( cap ) == cp {
g . spec . Process . Capabilities = append ( g . spec . Process . Capabilities [ : i ] , g . spec . Process . Capabilities [ i + 1 : ] ... )
return nil
}
}
return nil
}
func mapStrToNamespace ( ns string , path string ) ( rspec . Namespace , error ) {
switch ns {
case "network" :
return rspec . Namespace { Type : rspec . NetworkNamespace , Path : path } , nil
case "pid" :
return rspec . Namespace { Type : rspec . PIDNamespace , Path : path } , nil
case "mount" :
return rspec . Namespace { Type : rspec . MountNamespace , Path : path } , nil
case "ipc" :
return rspec . Namespace { Type : rspec . IPCNamespace , Path : path } , nil
case "uts" :
return rspec . Namespace { Type : rspec . UTSNamespace , Path : path } , nil
case "user" :
return rspec . Namespace { Type : rspec . UserNamespace , Path : path } , nil
case "cgroup" :
return rspec . Namespace { Type : rspec . CgroupNamespace , Path : path } , nil
default :
return rspec . Namespace { } , fmt . Errorf ( "Should not reach here!" )
}
}
// ClearLinuxNamespaces clear g.spec.Linux.Namespaces.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) ClearLinuxNamespaces ( ) {
if g . spec == nil || g . spec . Linux == nil {
return
}
2016-07-18 23:47:59 +00:00
g . spec . Linux . Namespaces = [ ] rspec . Namespace { }
}
// AddOrReplaceLinuxNamespace adds or replaces a namespace inside
// g.spec.Linux.Namespaces.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) AddOrReplaceLinuxNamespace ( ns string , path string ) error {
2016-07-18 23:47:59 +00:00
namespace , err := mapStrToNamespace ( ns , path )
if err != nil {
return err
}
2016-07-27 19:13:03 +00:00
g . initSpecLinux ( )
2016-07-18 23:47:59 +00:00
for i , ns := range g . spec . Linux . Namespaces {
if ns . Type == namespace . Type {
g . spec . Linux . Namespaces [ i ] = namespace
return nil
}
}
g . spec . Linux . Namespaces = append ( g . spec . Linux . Namespaces , namespace )
return nil
}
// RemoveLinuxNamespace removes a namespace from g.spec.Linux.Namespaces.
2016-07-27 19:13:03 +00:00
func ( g * Generator ) RemoveLinuxNamespace ( ns string ) error {
2016-07-18 23:47:59 +00:00
namespace , err := mapStrToNamespace ( ns , "" )
if err != nil {
return err
}
2016-07-27 19:13:03 +00:00
if g . spec == nil || g . spec . Linux == nil {
return nil
}
2016-07-18 23:47:59 +00:00
for i , ns := range g . spec . Linux . Namespaces {
if ns . Type == namespace . Type {
g . spec . Linux . Namespaces = append ( g . spec . Linux . Namespaces [ : i ] , g . spec . Linux . Namespaces [ i + 1 : ] ... )
return nil
}
}
return nil
}
// strPtr returns the pointer pointing to the string s.
func strPtr ( s string ) * string { return & s }
// FIXME: this function is not used.
func parseArgs ( args2parse string ) ( [ ] * rspec . Arg , error ) {
var Args [ ] * rspec . Arg
argstrslice := strings . Split ( args2parse , "," )
for _ , argstr := range argstrslice {
args := strings . Split ( argstr , "/" )
if len ( args ) == 4 {
index , err := strconv . Atoi ( args [ 0 ] )
value , err := strconv . Atoi ( args [ 1 ] )
value2 , err := strconv . Atoi ( args [ 2 ] )
if err != nil {
return nil , err
}
switch args [ 3 ] {
case "" :
case "SCMP_CMP_NE" :
case "SCMP_CMP_LT" :
case "SCMP_CMP_LE" :
case "SCMP_CMP_EQ" :
case "SCMP_CMP_GE" :
case "SCMP_CMP_GT" :
case "SCMP_CMP_MASKED_EQ" :
default :
return nil , fmt . Errorf ( "seccomp-sysctl args must be empty or one of SCMP_CMP_NE|SCMP_CMP_LT|SCMP_CMP_LE|SCMP_CMP_EQ|SCMP_CMP_GE|SCMP_CMP_GT|SCMP_CMP_MASKED_EQ" )
}
op := rspec . Operator ( args [ 3 ] )
Arg := rspec . Arg {
Index : uint ( index ) ,
Value : uint64 ( value ) ,
ValueTwo : uint64 ( value2 ) ,
Op : op ,
}
Args = append ( Args , & Arg )
} else {
return nil , fmt . Errorf ( "seccomp-sysctl args error: %s" , argstr )
}
}
return Args , nil
}