wip: status command

docker-compose.dpu.yml

@@ -43,14 +43,20 @@ services:
  - dhcp-leases-folder:/var/lib/dhclient/
  - /etc/os-release:/etc/os-release
  - /etc/ssh:/etc/ssh
+ - /var/lib/sztp:/var/lib/sztp
+ - /run/sztp:/run/sztp
+ privileged: true
  networks:
  - opi
  command: ['/opi-sztp-agent', 'daemon',
  '--dhcp-lease-file', '/var/lib/dhclient/dhclient.leases',
  '--bootstrap-trust-anchor-cert', '/certs/opi.pem',
  '--device-end-entity-cert', '/certs/third_my_cert.pem',
  '--device-private-key', '/certs/third_private_key.pem',
- '--serial-number', 'third-serial-number']
+ '--serial-number', 'third-serial-number',
+ '--status-file-path', '/var/lib/sztp/status.json',
+ '--result-file-path', '/var/lib/sztp/result.json',
+ '--sym-link-dir', '/run/sztp']
 
  agent2:
  <<: *agent
@@ -59,7 +65,10 @@ services:
  '--bootstrap-trust-anchor-cert', '/certs/opi.pem',
  '--device-end-entity-cert', '/certs/second_my_cert.pem',
  '--device-private-key', '/certs/second_private_key.pem',
- '--serial-number', 'second-serial-number']
+ '--serial-number', 'second-serial-number',
+ '--status-file-path', '/var/lib/sztp/status.json',
+ '--result-file-path', '/var/lib/sztp/result.json',
+ '--sym-link-dir', '/run/sztp']
 
  agent1:
  <<: *agent
@@ -68,7 +77,10 @@ services:
  '--bootstrap-trust-anchor-cert', '/certs/opi.pem',
  '--device-end-entity-cert', '/certs/first_my_cert.pem',
  '--device-private-key', '/certs/first_private_key.pem',
- '--serial-number', 'first-serial-number']
+ '--serial-number', 'first-serial-number',
+ '--status-file-path', '/var/lib/sztp/status.json',
+ '--result-file-path', '/var/lib/sztp/result.json',
+ '--sym-link-dir', '/run/sztp']
 
  agent4:
  <<: *agent
@@ -77,7 +89,10 @@ services:
  '--bootstrap-trust-anchor-cert', '/certs/opi.pem',
  '--device-end-entity-cert', '/certs/first_my_cert.pem',
  '--device-private-key', '/certs/first_private_key.pem',
- '--serial-number', 'first-serial-number']
+ '--serial-number', 'first-serial-number',
+ '--status-file-path', '/var/lib/sztp/status.json',
+ '--result-file-path', '/var/lib/sztp/result.json',
+ '--sym-link-dir', '/run/sztp']
 
  agent5:
  <<: *agent
@@ -86,7 +101,10 @@ services:
  '--bootstrap-trust-anchor-cert', '/certs/opi.pem',
  '--device-end-entity-cert', '/certs/first_my_cert.pem',
  '--device-private-key', '/certs/first_private_key.pem',
- '--serial-number', 'first-serial-number']
+ '--serial-number', 'first-serial-number',
+ '--status-file-path', '/var/lib/sztp/status.json',
+ '--result-file-path', '/var/lib/sztp/result.json',
+ '--sym-link-dir', '/run/sztp']
 
 volumes:
  client-certs:

scripts/run_agent.sh

@@ -21,6 +21,9 @@ docker run --rm -it --network=host \
  --mount type=bind,source=/etc/ssh,target=/etc/ssh,readonly \
  --mount type=bind,source=/etc/os-release,target=/etc/os-release,readonly \
  --mount type=bind,source=/var/lib/NetworkManager,target=/var/lib/NetworkManager,readonly \
+ --mount type=bind,source=/var/lib/sztp,target=/var/lib/sztp \
+ --mount type=bind,source=/run/sztp,target=/run/sztp \
+ --privileged \
  ${DOCKER_SZTP_IMAGE} \
  /opi-sztp-agent daemon \
  --dhcp-lease-file /var/lib/NetworkManager/dhclient-eth0.lease \

sztp-agent/cmd/daemon.go

@@ -32,13 +32,16 @@ func Daemon() *cobra.Command {
  devicePrivateKey string
  deviceEndEntityCert string
  bootstrapTrustAnchorCert string
+ statusFilePath string
+ resultFilePath string
+ symLinkDir string
  )
 
  cmd := &cobra.Command{
  Use: "daemon",
  Short: "Run the daemon command",
  RunE: func(_ *cobra.Command, _ []string) error {
- arrayChecker := []string{devicePrivateKey, deviceEndEntityCert, bootstrapTrustAnchorCert}
+ arrayChecker := []string{devicePrivateKey, deviceEndEntityCert, bootstrapTrustAnchorCert, statusFilePath}
  if bootstrapURL != "" && dhcpLeaseFile != "" {
  return fmt.Errorf("'--bootstrap-url' and '--dhcp-lease-file' are mutualy exclusive")
  }
@@ -52,14 +55,23 @@ func Daemon() *cobra.Command {
  _, err := url.ParseRequestURI(bootstrapURL)
  cobra.CheckErr(err)
  }
+ if statusFilePath == "" {
+ return fmt.Errorf("'--status-file-path' is required")
+ }
+ if resultFilePath == "" {
+ return fmt.Errorf("'--result-file-path' is required")
+ }
+ if symLinkDir == "" {
+ return fmt.Errorf("'--symlink-dir' is required")
+ }
  for _, filePath := range arrayChecker {
  info, err := os.Stat(filePath)
  cobra.CheckErr(err)
  if info.IsDir() {
  return fmt.Errorf("must not be folder: %q", filePath)
  }
  }
- a := secureagent.NewAgent(bootstrapURL, serialNumber, dhcpLeaseFile, devicePassword, devicePrivateKey, deviceEndEntityCert, bootstrapTrustAnchorCert)
+ a := secureagent.NewAgent(bootstrapURL, serialNumber, dhcpLeaseFile, devicePassword, devicePrivateKey, deviceEndEntityCert, bootstrapTrustAnchorCert, statusFilePath, resultFilePath, symLinkDir)
  return a.RunCommandDaemon()
  },
  }
@@ -74,6 +86,9 @@ func Daemon() *cobra.Command {
  flags.StringVar(&devicePrivateKey, "device-private-key", "/certs/private_key.pem", "Device's private key")
  flags.StringVar(&deviceEndEntityCert, "device-end-entity-cert", "/certs/my_cert.pem", "Device's End Entity cert")
  flags.StringVar(&bootstrapTrustAnchorCert, "bootstrap-trust-anchor-cert", "/certs/opi.pem", "Bootstrap server trust anchor Cert")
+ flags.StringVar(&statusFilePath, "status-file-path", "/var/lib/sztp/status.json", "Path to the status file")
+ flags.StringVar(&resultFilePath, "result-file-path", "/var/lib/sztp/result.json", "Path to the result file")
+ flags.StringVar(&symLinkDir, "sym-link-dir", "/run/sztp", "Path to the symlink directory")
 
  return cmd
 }

sztp-agent/cmd/disable.go

@@ -28,13 +28,16 @@ func Disable() *cobra.Command {
  devicePrivateKey string
  deviceEndEntityCert string
  bootstrapTrustAnchorCert string
+ statusFilePath string
+ resultFilePath string
+ symLinkDir string
  )
 
  cmd := &cobra.Command{
  Use: "disable",
  Short: "Run the disable command",
  RunE: func(_ *cobra.Command, _ []string) error {
- a := secureagent.NewAgent(bootstrapURL, serialNumber, dhcpLeaseFile, devicePassword, devicePrivateKey, deviceEndEntityCert, bootstrapTrustAnchorCert)
+ a := secureagent.NewAgent(bootstrapURL, serialNumber, dhcpLeaseFile, devicePassword, devicePrivateKey, deviceEndEntityCert, bootstrapTrustAnchorCert, statusFilePath, resultFilePath, symLinkDir)
  return a.RunCommandDisable()
  },
  }
@@ -49,5 +52,9 @@ func Disable() *cobra.Command {
  flags.StringVar(&devicePrivateKey, "device-private-key", "", "Device's private key")
  flags.StringVar(&deviceEndEntityCert, "device-end-entity-cert", "", "Device's End Entity cert")
  flags.StringVar(&bootstrapTrustAnchorCert, "bootstrap-trust-anchor-cert", "", "Bootstrap server trust anchor Cert")
+ flags.StringVar(&statusFilePath, "status-file-path", "", "Status file path")
+ flags.StringVar(&resultFilePath, "result-file-path", "", "Result file path")
+ flags.StringVar(&symLinkDir, "sym-link-dir", "", "Sym Link Directory")
+
  return cmd
 }

sztp-agent/cmd/enable.go

@@ -28,13 +28,16 @@ func Enable() *cobra.Command {
  devicePrivateKey string
  deviceEndEntityCert string
  bootstrapTrustAnchorCert string
+ statusFilePath string
+ resultFilePath string
+ symLinkDir string
  )
 
  cmd := &cobra.Command{
  Use: "enable",
  Short: "Run the enable command",
  RunE: func(_ *cobra.Command, _ []string) error {
- a := secureagent.NewAgent(bootstrapURL, serialNumber, dhcpLeaseFile, devicePassword, devicePrivateKey, deviceEndEntityCert, bootstrapTrustAnchorCert)
+ a := secureagent.NewAgent(bootstrapURL, serialNumber, dhcpLeaseFile, devicePassword, devicePrivateKey, deviceEndEntityCert, bootstrapTrustAnchorCert, statusFilePath, resultFilePath, symLinkDir)
  return a.RunCommandEnable()
  },
  }
@@ -49,6 +52,9 @@ func Enable() *cobra.Command {
  flags.StringVar(&devicePrivateKey, "device-private-key", "", "Device's private key")
  flags.StringVar(&deviceEndEntityCert, "device-end-entity-cert", "", "Device's End Entity cert")
  flags.StringVar(&bootstrapTrustAnchorCert, "bootstrap-trust-anchor-cert", "", "Bootstrap server trust anchor Cert")
+ flags.StringVar(&statusFilePath, "status-file-path", "", "Status file path")
+ flags.StringVar(&resultFilePath, "result-file-path", "", "Result file path")
+ flags.StringVar(&symLinkDir, "sym-link-dir", "", "Sym Link Directory")
 
  return cmd
 }

sztp-agent/cmd/run.go

@@ -32,13 +32,16 @@ func Run() *cobra.Command {
  devicePrivateKey string
  deviceEndEntityCert string
  bootstrapTrustAnchorCert string
+ statusFilePath string
+ resultFilePath string
+ symLinkDir string
  )
 
  cmd := &cobra.Command{
  Use: "run",
  Short: "Exec the run command",
  RunE: func(_ *cobra.Command, _ []string) error {
- arrayChecker := []string{devicePrivateKey, deviceEndEntityCert, bootstrapTrustAnchorCert}
+ arrayChecker := []string{devicePrivateKey, deviceEndEntityCert, bootstrapTrustAnchorCert, statusFilePath, resultFilePath}
  if bootstrapURL != "" && dhcpLeaseFile != "" {
  return fmt.Errorf("'--bootstrap-url' and '--dhcp-lease-file' are mutualy exclusive")
  }
@@ -52,14 +55,23 @@ func Run() *cobra.Command {
  _, err := url.ParseRequestURI(bootstrapURL)
  cobra.CheckErr(err)
  }
+ if statusFilePath == "" {
+ return fmt.Errorf("'--status-file-path' is required")
+ }
+ if resultFilePath == "" {
+ return fmt.Errorf("'--result-file-path' is required")
+ }
+ if symLinkDir == "" {
+ return fmt.Errorf("'--symlink-dir' is required")
+ }
  for _, filePath := range arrayChecker {
  info, err := os.Stat(filePath)
  cobra.CheckErr(err)
  if info.IsDir() {
  return fmt.Errorf("must not be folder: %q", filePath)
  }
  }
- a := secureagent.NewAgent(bootstrapURL, serialNumber, dhcpLeaseFile, devicePassword, devicePrivateKey, deviceEndEntityCert, bootstrapTrustAnchorCert)
+ a := secureagent.NewAgent(bootstrapURL, serialNumber, dhcpLeaseFile, devicePassword, devicePrivateKey, deviceEndEntityCert, bootstrapTrustAnchorCert, statusFilePath, resultFilePath, symLinkDir)
  return a.RunCommand()
  },
  }
@@ -74,6 +86,9 @@ func Run() *cobra.Command {
  flags.StringVar(&devicePrivateKey, "device-private-key", "/certs/private_key.pem", "Device's private key")
  flags.StringVar(&deviceEndEntityCert, "device-end-entity-cert", "/certs/my_cert.pem", "Device's End Entity cert")
  flags.StringVar(&bootstrapTrustAnchorCert, "bootstrap-trust-anchor-cert", "/certs/opi.pem", "Bootstrap server trust anchor Cert")
+ flags.StringVar(&statusFilePath, "status-file-path", "/var/lib/sztp/status.json", "Status file path")
+ flags.StringVar(&resultFilePath, "result-file-path", "/var/lib/sztp/result.json", "Result file path")
+ flags.StringVar(&symLinkDir, "sym-link-dir", "", "Sym Link Directory")
 
  return cmd
 }

sztp-agent/cmd/status.go

@@ -28,13 +28,16 @@ func Status() *cobra.Command {
  devicePrivateKey string
  deviceEndEntityCert string
  bootstrapTrustAnchorCert string
+ statusFilePath string
+ resultFilePath string
+ symLinkDir string
  )
 
  cmd := &cobra.Command{
  Use: "status",
  Short: "Run the status command",
  RunE: func(_ *cobra.Command, _ []string) error {
- a := secureagent.NewAgent(bootstrapURL, serialNumber, dhcpLeaseFile, devicePassword, devicePrivateKey, deviceEndEntityCert, bootstrapTrustAnchorCert)
+ a := secureagent.NewAgent(bootstrapURL, serialNumber, dhcpLeaseFile, devicePassword, devicePrivateKey, deviceEndEntityCert, bootstrapTrustAnchorCert, statusFilePath, resultFilePath, symLinkDir)
  return a.RunCommandStatus()
  },
  }
@@ -45,10 +48,13 @@ func Status() *cobra.Command {
  flags.StringVar(&bootstrapURL, "bootstrap-url", "", "Bootstrap server URL")
  flags.StringVar(&serialNumber, "serial-number", "", "Device's serial number")
  flags.StringVar(&dhcpLeaseFile, "dhcp-lease-file", "/var/lib/dhclient/dhclient.leases", "Device's dhclient leases file")
- flags.StringVar(&devicePassword, "device-password", "", "Device's password")
+ flags.StringVar(&devicePassword, "device-password", "", "Dehomevice's password")
  flags.StringVar(&devicePrivateKey, "device-private-key", "", "Device's private key")
  flags.StringVar(&deviceEndEntityCert, "device-end-entity-cert", "", "Device's End Entity cert")
  flags.StringVar(&bootstrapTrustAnchorCert, "bootstrap-trust-anchor-cert", "", "Bootstrap server trust anchor Cert")
+ flags.StringVar(&statusFilePath, "status-file-path", "", "Status file path")
+ flags.StringVar(&resultFilePath, "result-file-path", "", "Result file path")
+ flags.StringVar(&symLinkDir, "sym-link-dir", "", "Sym Link Directory")
 
  return cmd
 }

sztp-agent/pkg/secureagent/agent.go

@@ -83,10 +83,12 @@ type Agent struct {
  ProgressJSON ProgressJSON // ProgressJson structure
  BootstrapServerOnboardingInfo BootstrapServerOnboardingInfo // BootstrapServerOnboardingInfo structure
  BootstrapServerRedirectInfo BootstrapServerRedirectInfo // BootstrapServerRedirectInfo structure
-
+ StatusFilePath string // Path to the status file
+ ResultFilePath string // Path to the result file
+ SymLinkDir string // Path to the symlink directory for the status file
 }
 
-func NewAgent(bootstrapURL, serialNumber, dhcpLeaseFile, devicePassword, devicePrivateKey, deviceEndEntityCert, bootstrapTrustAnchorCert string) *Agent {
+func NewAgent(bootstrapURL, serialNumber, dhcpLeaseFile, devicePassword, devicePrivateKey, deviceEndEntityCert, bootstrapTrustAnchorCert, statusFilePath, resultFilePath, symLinkDir string) *Agent {
  return &Agent{
  InputBootstrapURL: bootstrapURL,
  BootstrapURL: "",
@@ -101,6 +103,9 @@ func NewAgent(bootstrapURL, serialNumber, dhcpLeaseFile, devicePassword, deviceP
  ProgressJSON: ProgressJSON{},
  BootstrapServerRedirectInfo: BootstrapServerRedirectInfo{},
  BootstrapServerOnboardingInfo: BootstrapServerOnboardingInfo{},
+ StatusFilePath: statusFilePath,
+ ResultFilePath: resultFilePath,
+ SymLinkDir: symLinkDir,
  }
 }
 
@@ -140,6 +145,18 @@ func (a *Agent) GetProgressJSON() ProgressJSON {
  return a.ProgressJSON
 }
 
+func (a *Agent) GetStatusFilePath() string {
+ return a.StatusFilePath
+}
+
+func (a *Agent) GetResultFilePath() string {
+ return a.ResultFilePath
+}
+
+func (a *Agent) GetSymLinkDir() string {
+ return a.SymLinkDir
+}
+
 func (a *Agent) SetBootstrapURL(url string) {
  a.BootstrapURL = url
 }
@@ -171,3 +188,15 @@ func (a *Agent) SetContentTypeReq(ct string) {
 func (a *Agent) SetProgressJSON(p ProgressJSON) {
  a.ProgressJSON = p
 }
+
+func (a *Agent) SetStatusFilePath(path string) {
+ a.StatusFilePath = path
+}
+
+func (a *Agent) SetResultFilePath(path string) {
+ a.ResultFilePath = path
+}
+
+func (a *Agent) SetSymLinkDir(path string) {
+ a.SymLinkDir = path
+}

sztp-agent/pkg/secureagent/agent_test.go

@@ -828,6 +828,9 @@ func TestNewAgent(t *testing.T) {
  devicePrivateKey string
  deviceEndEntityCert string
  bootstrapTrustAnchorCert string
+ statusFilePath string
+ resultFilePath string
+ symLinkDir string
  }
  tests := []struct {
  name string
@@ -844,6 +847,9 @@ func TestNewAgent(t *testing.T) {
  devicePrivateKey: "TestDevicePrivateKey",
  deviceEndEntityCert: "TestDeviceEndEntityCert",
  bootstrapTrustAnchorCert: "TestBootstrapTrustCert",
+ statusFilePath: "TestStatusFilePath",
+ resultFilePath: "TestResultFilePath",
+ symLinkDir: "TestSymLinkDir",
  },
  want: &Agent{
  InputBootstrapURL: "TestBootstrap",
@@ -856,12 +862,15 @@ func TestNewAgent(t *testing.T) {
  ContentTypeReq: "application/yang-data+json",
  InputJSONContent: generateInputJSONContent(),
  DhcpLeaseFile: "TestDhcpLeaseFile",
+ StatusFilePath: "TestStatusFilePath",
+ ResultFilePath: "TestResultFilePath",
+ SymLinkDir: "TestSymLinkDir",
  },
  },
  }
  for _, tt := range tests {
  t.Run(tt.name, func(t *testing.T) {
- if got := NewAgent(tt.args.bootstrapURL, tt.args.serialNumber, tt.args.dhcpLeaseFile, tt.args.devicePassword, tt.args.devicePrivateKey, tt.args.deviceEndEntityCert, tt.args.bootstrapTrustAnchorCert); !reflect.DeepEqual(got, tt.want) {
+ if got := NewAgent(tt.args.bootstrapURL, tt.args.serialNumber, tt.args.dhcpLeaseFile, tt.args.devicePassword, tt.args.devicePrivateKey, tt.args.deviceEndEntityCert, tt.args.bootstrapTrustAnchorCert, tt.args.statusFilePath, tt.args.resultFilePath, tt.args.symLinkDir); !reflect.DeepEqual(got, tt.want) {
  t.Errorf("NewAgent() = %v, want %v", got, tt.want)
  }
  })