5.1.6.1. Services for Totem

This chapter contains detailed information about how to write a new Service and a Service example.Totem’s Services are pretty simple to understand. Any programming language could be used to implement your service. They build upon JSON as a messaging format, use a RESTful API and are completely independent of Totem itself.

The Scala you need to add one is, in most cases, as simple as it can be: copy and paste.

This tutorial uses Python because it’s simple and the services for the popular analysis platform CRITs are written in it and Golang because in Go you can call C programs or functions and most of the binary analysis tool are written in C language.

Also, any kind of virtualization method can be used to restrict the environment of your Service. This tutorial shows how to use Docker.

• 5.1.6.1.1. Writing a Service
  • 5.1.6.1.1.1. Overview
  • 5.1.6.1.1.2. Details
    • 5.1.6.1.1.2.1. Files To Add
      • Service Files
        • Dockerfile
        • LICENSE
        • README.md
        • acl.conf
        • service.conf.example
        • watchdog.scala
        • YourServiceREST.scala
        • Service-logic file
          • Endpoint - ‘/’
          • Endpoint ‘/analyze?obj=’
            • Reading configuration file
            • HTTP Error Codes
    • 5.1.6.1.1.2.2. Files to Edit
      • Config Files
        • totem.conf.example
        • docker-compose.yml.example
        • compose_download_conf.sh
      • Scala Files
        • driver.scala
• 5.1.6.1.2. Example Service: Hello World
  • 5.1.6.1.2.1. In Golang
    • 5.1.6.1.2.1.1. Install Dependencies
    • 5.1.6.1.2.1.2. Dockerfile
    • 5.1.6.1.2.1.3. helloworld.go
  • 5.1.6.1.2.2. In Python
    • 5.1.6.1.2.2.1. Install Dependencies
    • 5.1.6.1.2.2.2. Dockerfile
    • 5.1.6.1.2.2.3. helloworld.py