Introduction

This Guide is intended for software developers who work on KasperskyOS-based software/hardware systems. The main part of this Guide provides the following information:

• How-to guides that describe the actions that a developer should take to get specific practical results.

  For these purposes, developers can use the following:

  • API functions and macros (in the C language)
  • Shell commands, GDB commands, and CMake commands
  • Specialized languages used to automatically generate source code

  A how-to guide may be presented as an example of code with explanations.

• Reference guides:
  • API information
  • Syntax of shell commands, GDB commands, and CMake commands
  • Syntax of specialized languages used to automatically generate source code
  • Program startup parameters
  • Environment variables of programs
  • POSIX support details
  • Information on the KasperskyOS kernel methods used for a security policy description
• KasperskyOS conceptual guides.

How-to guides and reference guides may be combined into one section.

Contents of Guide sections

Section name	Section contents
About KasperskyOS Community Edition	General information about the SDK, including the system requirements for SDK installation.
Overview of KasperskyOS	KasperskyOS conceptual guides: KasperskyOS architecture Kaspersky Security System technology Generating source code from code in specialized languages Managing interaction between different processes and between processes and the KasperskyOS kernel Resource Access Control KasperskyOS boot image contents
The KasperskyOS Developer's Quick Start Guide	Practical Guide to developing KasperskyOS solutions with concise explanations and links to other sections for a quick KasperskyOS development setup
Getting started	Practical guides required for getting started with the SDK: Using a Docker container to install the SDK Installing and uninstalling the SDK Configuring the development environment Using the KasperskyOS SDK Extension for Visual Studio Code Building and running examples
Development for KasperskyOS	How-to guides: Starting processes Using file systems and network stack Setting up interprocess communication Working with KPA packages Reference guides: Syntax of a specialized language used to configure program startup parameters and environment variables, and the topology for interprocess communication Startup settings and environment variables for the system program that implements the file systems and network stack
KasperskyOS API	How-to guides: Using macros designed for working with error codes in system software and applications Using APIs provided by the libkos library (basic library of KasperskyOS), including capability-based access control Using the API of the system program that provides dynamic configuration for the IPC topology Using the MessageBus program to implement the message bus Using the LogRR program for logging Using the ExecutionManager component for process management Using the PackageManager component for KPA packages management Reference guides: Information on return codes for system software and applications Information on APIs provided by the libkos library POSIX support details Information about the API of the system program that provides dynamic configuration for the IPC topology
Building a KasperskyOS-based solution	How-to guides: Build process overview Building with CMake Using dynamic libraries Reference guides: Syntax of macros applied during a build to generate constructs in a specialized language used to configure program startup parameters and environment variables, and the topology for interprocess communication Syntax of a macro applied during a build to generate constructs in a specialized language used for a security policy description Syntax of CMake commands from CMake libraries provided in the SDK Syntax of shell commands for running build scripts and tools
Debugging programs in a KasperskyOS-based solution	How-to guides: Debugging using the QEMU GDB server Debugging using the GDB server of the KasperskyOS kernel in QEMU and on the hardware platform Analyzing stack backtrace data when a process abnormally terminates Reference guides on the syntax of GDB commands for working with processes and threads
Developing security policies	How-to guides: Creating specifications for programs that run in KasperskyOS Describing a security policy Testing a security policy Logging a security policy Reference guides: Syntax of specialized languages used to create specifications for programs that run in KasperskyOS Syntax of a specialized language used to describe a security policy (including KasperskyOS security models) Syntax of a specialized language used to create security policy tests Information on the KasperskyOS kernel methods used for a security policy description
Security patterns for development under KasperskyOS	Conceptual guides on the types of risks and security threats during software development, and a description of architectural patterns that can be employed to enhance the security of a solution.
Appendices	List and description of examples provided in the SDK Reference guides on certain limits set in the system

Page top