The packet-crafting Reference Manual

Table of Contents

The packet-crafting Reference Manual

This is the packet-crafting Reference Manual, version 0.1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 11:54:10 2020 GMT+0.

1 Introduction

Packet-Crafting

Usage

Installation

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 packet-crafting

Author

mets634 <mets634@gmail.com>

License

MIT

Description

A library to craft network packets.

Version

0.1.0

Dependency

lisp-binary

Source

packet-crafting.asd (file)

Component

src (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 packet-crafting/src

Parent

packet-crafting (system)

Location

src/

Components

• bsl.lisp (file)
• layers.lisp (file)
• packet.lisp (file)
• main.lisp (file)

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

4.1 Lisp

4.1.1 packet-crafting.asd

Location

packet-crafting.asd

Systems

packet-crafting (system)

4.1.2 packet-crafting/src/bsl.lisp

Parent

src (module)

Location

src/bsl.lisp

Packages

bsl

Exported Definitions

deflayer (macro)

Internal Definitions

• field (function)
• name (function)
• size (function)
• value (function)

4.1.3 packet-crafting/src/layers.lisp

Parent

src (module)

Location

src/layers.lisp

Packages

layers

Exported Definitions

• make-ethernet-ii (function)
• make-ipv4 (function)

Internal Definitions

• copy-ethernet-ii (function)
• copy-ipv4 (function)
• ethernet-ii (structure)
• ethernet-ii-destination (function)
• (setf ethernet-ii-destination) (function)
• ethernet-ii-p (function)
• ethernet-ii-source (function)
• (setf ethernet-ii-source) (function)
• ethernet-ii-type (function)
• (setf ethernet-ii-type) (function)
• ipv4 (structure)
• ipv4-destination-address (function)
• (setf ipv4-destination-address) (function)
• ipv4-flags (function)
• (setf ipv4-flags) (function)
• ipv4-fragment-offset (function)
• (setf ipv4-fragment-offset) (function)
• ipv4-header-checksum (function)
• (setf ipv4-header-checksum) (function)
• ipv4-header-length (function)
• (setf ipv4-header-length) (function)
• ipv4-identification (function)
• (setf ipv4-identification) (function)
• ipv4-p (function)
• ipv4-protocol (function)
• (setf ipv4-protocol) (function)
• ipv4-source-address (function)
• (setf ipv4-source-address) (function)
• ipv4-time-to-live (function)
• (setf ipv4-time-to-live) (function)
• ipv4-total-length (function)
• (setf ipv4-total-length) (function)
• ipv4-type-of-service (function)
• (setf ipv4-type-of-service) (function)
• ipv4-version (function)
• (setf ipv4-version) (function)

4.1.4 packet-crafting/src/packet.lisp

Parent

src (module)

Location

src/packet.lisp

Packages

packet

Exported Definitions

• add-layer (function)
• get-layer (function)
• make-packet (function)
• remove-layer (function)
• show (function)

Internal Definitions

+default-packet-size+ (constant)

4.1.5 packet-crafting/src/main.lisp

Parent

src (module)

Location

src/main.lisp

Packages

packet-crafting

Exported Definitions

main (function)

5 Packages

Packages are listed by definition order.

5.1 bsl

Source

bsl.lisp (file)

Use List

• lisp-binary
• common-lisp

Used By List

layers

Exported Definitions

deflayer (macro)

Internal Definitions

• field (function)
• name (function)
• size (function)
• value (function)

5.2 layers

Source

layers.lisp (file)

Use List

• bsl
• common-lisp

Used By List

• packet-crafting
• packet

Exported Definitions

• make-ethernet-ii (function)
• make-ipv4 (function)

Internal Definitions

• copy-ethernet-ii (function)
• copy-ipv4 (function)
• ethernet-ii (structure)
• ethernet-ii-destination (function)
• (setf ethernet-ii-destination) (function)
• ethernet-ii-p (function)
• ethernet-ii-source (function)
• (setf ethernet-ii-source) (function)
• ethernet-ii-type (function)
• (setf ethernet-ii-type) (function)
• ipv4 (structure)
• ipv4-destination-address (function)
• (setf ipv4-destination-address) (function)
• ipv4-flags (function)
• (setf ipv4-flags) (function)
• ipv4-fragment-offset (function)
• (setf ipv4-fragment-offset) (function)
• ipv4-header-checksum (function)
• (setf ipv4-header-checksum) (function)
• ipv4-header-length (function)
• (setf ipv4-header-length) (function)
• ipv4-identification (function)
• (setf ipv4-identification) (function)
• ipv4-p (function)
• ipv4-protocol (function)
• (setf ipv4-protocol) (function)
• ipv4-source-address (function)
• (setf ipv4-source-address) (function)
• ipv4-time-to-live (function)
• (setf ipv4-time-to-live) (function)
• ipv4-total-length (function)
• (setf ipv4-total-length) (function)
• ipv4-type-of-service (function)
• (setf ipv4-type-of-service) (function)
• ipv4-version (function)
• (setf ipv4-version) (function)

5.3 packet

Source

packet.lisp (file)

Use List

• layers
• common-lisp

Exported Definitions

• add-layer (function)
• get-layer (function)
• make-packet (function)
• remove-layer (function)
• show (function)

Internal Definitions

+default-packet-size+ (constant)

5.4 packet-crafting

Source

main.lisp (file)

Use List

• layers
• common-lisp

Exported Definitions

main (function)

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

6.1 Exported definitions

6.1.1 Macros

Macro: deflayer NAME &rest FIELDS

Creates a binary-structure (lisp-binary:defbinary) representing a network-layer with the specified fields.

Package

bsl

Source

bsl.lisp (file)

6.1.2 Functions

Function: add-layer PACKET &rest NEW-LAYERS

Adds new layers to a given packet, and extends the vector if needed.

Package

packet

Source

packet.lisp (file)

Function: get-layer PACKET INDEX

Returns a setf-able layer from a given packet.

Package

packet

Source

packet.lisp (file)

Function: main ARGV

Package

packet-crafting

Source

main.lisp (file)

Function: make-ethernet-ii &key (DESTINATION DESTINATION) (SOURCE SOURCE) (TYPE TYPE)

Package

layers

Source

layers.lisp (file)

Function: make-ipv4 &key (VERSION VERSION) (HEADER-LENGTH HEADER-LENGTH) (TYPE-OF-SERVICE TYPE-OF-SERVICE) (TOTAL-LENGTH TOTAL-LENGTH) (IDENTIFICATION IDENTIFICATION) (FLAGS FLAGS) (FRAGMENT-OFFSET FRAGMENT-OFFSET) (TIME-TO-LIVE TIME-TO-LIVE) (PROTOCOL PROTOCOL) (HEADER-CHECKSUM HEADER-CHECKSUM) (SOURCE-ADDRESS SOURCE-ADDRESS) (DESTINATION-ADDRESS DESTINATION-ADDRESS)

Package

layers

Source

layers.lisp (file)

Function: make-packet &optional SIZE

Package

packet

Source

packet.lisp (file)

Function: remove-layer PACKET INDEX

Removes the layer of a given packet at a given index.

Package

packet

Source

packet.lisp (file)

Function: show PACKET &optional STREAM

Prints a packet’s layers in order of appearance.

Package

packet

Source

packet.lisp (file)

6.2 Internal definitions

6.2.1 Constants

Constant: +default-packet-size+

Package

packet

Source

packet.lisp (file)

6.2.2 Functions

Function: copy-ethernet-ii INSTANCE

Package

layers

Source

layers.lisp (file)

Function: copy-ipv4 INSTANCE

Package

layers

Source

layers.lisp (file)

Function: ethernet-ii-destination INSTANCE

Function: (setf ethernet-ii-destination) VALUE INSTANCE

Package

layers

Source

layers.lisp (file)

Function: ethernet-ii-p OBJECT

Package

layers

Source

layers.lisp (file)

Function: ethernet-ii-source INSTANCE

Function: (setf ethernet-ii-source) VALUE INSTANCE

Package

layers

Source

layers.lisp (file)

Function: ethernet-ii-type INSTANCE

Function: (setf ethernet-ii-type) VALUE INSTANCE

Package

layers

Source

layers.lisp (file)

Function: field BSL FIELD-NAME

Package

bsl

Source

bsl.lisp (file)

Function: ipv4-destination-address INSTANCE

Function: (setf ipv4-destination-address) VALUE INSTANCE

Package

layers

Source

layers.lisp (file)

Function: ipv4-flags INSTANCE

Function: (setf ipv4-flags) VALUE INSTANCE

Package

layers

Source

layers.lisp (file)

Function: ipv4-fragment-offset INSTANCE

Function: (setf ipv4-fragment-offset) VALUE INSTANCE

Package

layers

Source

layers.lisp (file)

Function: ipv4-header-checksum INSTANCE

Function: (setf ipv4-header-checksum) VALUE INSTANCE

Package

layers

Source

layers.lisp (file)

Function: ipv4-header-length INSTANCE

Function: (setf ipv4-header-length) VALUE INSTANCE

Package

layers

Source

layers.lisp (file)

Function: ipv4-identification INSTANCE

Function: (setf ipv4-identification) VALUE INSTANCE

Package

layers

Source

layers.lisp (file)

Function: ipv4-p OBJECT

Package

layers

Source

layers.lisp (file)

Function: ipv4-protocol INSTANCE

Function: (setf ipv4-protocol) VALUE INSTANCE

Package

layers

Source

layers.lisp (file)

Function: ipv4-source-address INSTANCE

Function: (setf ipv4-source-address) VALUE INSTANCE

Package

layers

Source

layers.lisp (file)

Function: ipv4-time-to-live INSTANCE

Function: (setf ipv4-time-to-live) VALUE INSTANCE

Package

layers

Source

layers.lisp (file)

Function: ipv4-total-length INSTANCE

Function: (setf ipv4-total-length) VALUE INSTANCE

Package

layers

Source

layers.lisp (file)

Function: ipv4-type-of-service INSTANCE

Function: (setf ipv4-type-of-service) VALUE INSTANCE

Package

layers

Source

layers.lisp (file)

Function: ipv4-version INSTANCE

Function: (setf ipv4-version) VALUE INSTANCE

Package

layers

Source

layers.lisp (file)

Function: name FIELD

Package

bsl

Source

bsl.lisp (file)

Function: size FIELD

Package

bsl

Source

bsl.lisp (file)

Function: value FIELD

Package

bsl

Source

bsl.lisp (file)

6.2.3 Structures

Structure: ethernet-ii ()

Package

layers

Source

layers.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

write-binary (method)

Direct slots

Slot: destination

Type

(unsigned-byte 48)

Readers

ethernet-ii-destination (function)

Writers

(setf ethernet-ii-destination) (function)

Slot: source

Type

(unsigned-byte 48)

Readers

ethernet-ii-source (function)

Writers

(setf ethernet-ii-source) (function)

Slot: type

Type

(unsigned-byte 16)

Readers

ethernet-ii-type (function)

Writers

(setf ethernet-ii-type) (function)

Structure: ipv4 ()

Package

layers

Source

layers.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

write-binary (method)

Direct slots

Slot: version

Type

(unsigned-byte 4)

Readers

ipv4-version (function)

Writers

(setf ipv4-version) (function)

Slot: header-length

Type

(unsigned-byte 4)

Readers

ipv4-header-length (function)

Writers

(setf ipv4-header-length) (function)

Slot: type-of-service

Type

(unsigned-byte 8)

Readers

ipv4-type-of-service (function)

Writers

(setf ipv4-type-of-service) (function)

Slot: total-length

Type

(unsigned-byte 16)

Readers

ipv4-total-length (function)

Writers

(setf ipv4-total-length) (function)

Slot: identification

Type

(unsigned-byte 16)

Readers

ipv4-identification (function)

Writers

(setf ipv4-identification) (function)

Slot: flags

Type

(unsigned-byte 3)

Readers

ipv4-flags (function)

Writers

(setf ipv4-flags) (function)

Slot: fragment-offset

Type

(unsigned-byte 13)

Readers

ipv4-fragment-offset (function)

Writers

(setf ipv4-fragment-offset) (function)

Slot: time-to-live

Type

(unsigned-byte 8)

Readers

ipv4-time-to-live (function)

Writers

(setf ipv4-time-to-live) (function)

Slot: protocol

Type

(unsigned-byte 8)

Readers

ipv4-protocol (function)

Writers

(setf ipv4-protocol) (function)

Slot: header-checksum

Type

(unsigned-byte 16)

Readers

ipv4-header-checksum (function)

Writers

(setf ipv4-header-checksum) (function)

Slot: source-address

Type

(unsigned-byte 32)

Readers

ipv4-source-address (function)

Writers

(setf ipv4-source-address) (function)

Slot: destination-address

Type

(unsigned-byte 32)

Readers

ipv4-destination-address (function)

Writers

(setf ipv4-destination-address) (function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types