The packet-crafting Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

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.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

Packet-Crafting

Usage

Installation


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

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)


Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

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


Previous: , Up: Modules   [Contents][Index]

3.1 packet-crafting/src

Parent

packet-crafting (system)

Location

src/

Components

Next: , Previous: , Up: Top   [Contents][Index]

4 Files

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


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 packet-crafting.asd

Location

packet-crafting.asd

Systems

packet-crafting (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 packet-crafting/src/bsl.lisp

Parent

src (module)

Location

src/bsl.lisp

Packages

bsl

Exported Definitions

deflayer (macro)

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.3 packet-crafting/src/layers.lisp

Parent

src (module)

Location

src/layers.lisp

Packages

layers

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.4 packet-crafting/src/packet.lisp

Parent

src (module)

Location

src/packet.lisp

Packages

packet

Exported Definitions
Internal Definitions

+default-packet-size+ (constant)


Previous: , Up: Lisp files   [Contents][Index]

4.1.5 packet-crafting/src/main.lisp

Parent

src (module)

Location

src/main.lisp

Packages

packet-crafting

Exported Definitions

main (function)


Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

5.1 bsl

Source

bsl.lisp (file)

Use List
Used By List

layers

Exported Definitions

deflayer (macro)

Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.2 layers

Source

layers.lisp (file)

Use List
Used By List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.3 packet

Source

packet.lisp (file)

Use List
Exported Definitions
Internal Definitions

+default-packet-size+ (constant)


Previous: , Up: Packages   [Contents][Index]

5.4 packet-crafting

Source

main.lisp (file)

Use List
Exported Definitions

main (function)


Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Previous: , Up: Exported definitions   [Contents][Index]

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)


Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Constants

Constant: +default-packet-size+
Package

packet

Source

packet.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Previous: , Up: Internal definitions   [Contents][Index]

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)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   M   P  
Index Entry  Section

F
File, Lisp, packet-crafting.asd: The packet-crafting․asd file
File, Lisp, packet-crafting/src/bsl.lisp: The packet-crafting/src/bsl․lisp file
File, Lisp, packet-crafting/src/layers.lisp: The packet-crafting/src/layers․lisp file
File, Lisp, packet-crafting/src/main.lisp: The packet-crafting/src/main․lisp file
File, Lisp, packet-crafting/src/packet.lisp: The packet-crafting/src/packet․lisp file

L
Lisp File, packet-crafting.asd: The packet-crafting․asd file
Lisp File, packet-crafting/src/bsl.lisp: The packet-crafting/src/bsl․lisp file
Lisp File, packet-crafting/src/layers.lisp: The packet-crafting/src/layers․lisp file
Lisp File, packet-crafting/src/main.lisp: The packet-crafting/src/main․lisp file
Lisp File, packet-crafting/src/packet.lisp: The packet-crafting/src/packet․lisp file

M
Module, packet-crafting/src: The packet-crafting/src module

P
packet-crafting.asd: The packet-crafting․asd file
packet-crafting/src: The packet-crafting/src module
packet-crafting/src/bsl.lisp: The packet-crafting/src/bsl․lisp file
packet-crafting/src/layers.lisp: The packet-crafting/src/layers․lisp file
packet-crafting/src/main.lisp: The packet-crafting/src/main․lisp file
packet-crafting/src/packet.lisp: The packet-crafting/src/packet․lisp file

Jump to:   F   L   M   P  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
A   C   D   E   F   G   I   M   N   R   S   V  
Index Entry  Section

(
(setf ethernet-ii-destination): Internal functions
(setf ethernet-ii-source): Internal functions
(setf ethernet-ii-type): Internal functions
(setf ipv4-destination-address): Internal functions
(setf ipv4-flags): Internal functions
(setf ipv4-fragment-offset): Internal functions
(setf ipv4-header-checksum): Internal functions
(setf ipv4-header-length): Internal functions
(setf ipv4-identification): Internal functions
(setf ipv4-protocol): Internal functions
(setf ipv4-source-address): Internal functions
(setf ipv4-time-to-live): Internal functions
(setf ipv4-total-length): Internal functions
(setf ipv4-type-of-service): Internal functions
(setf ipv4-version): Internal functions

A
add-layer: Exported functions

C
copy-ethernet-ii: Internal functions
copy-ipv4: Internal functions

D
deflayer: Exported macros

E
ethernet-ii-destination: Internal functions
ethernet-ii-p: Internal functions
ethernet-ii-source: Internal functions
ethernet-ii-type: Internal functions

F
field: Internal functions
Function, (setf ethernet-ii-destination): Internal functions
Function, (setf ethernet-ii-source): Internal functions
Function, (setf ethernet-ii-type): Internal functions
Function, (setf ipv4-destination-address): Internal functions
Function, (setf ipv4-flags): Internal functions
Function, (setf ipv4-fragment-offset): Internal functions
Function, (setf ipv4-header-checksum): Internal functions
Function, (setf ipv4-header-length): Internal functions
Function, (setf ipv4-identification): Internal functions
Function, (setf ipv4-protocol): Internal functions
Function, (setf ipv4-source-address): Internal functions
Function, (setf ipv4-time-to-live): Internal functions
Function, (setf ipv4-total-length): Internal functions
Function, (setf ipv4-type-of-service): Internal functions
Function, (setf ipv4-version): Internal functions
Function, add-layer: Exported functions
Function, copy-ethernet-ii: Internal functions
Function, copy-ipv4: Internal functions
Function, ethernet-ii-destination: Internal functions
Function, ethernet-ii-p: Internal functions
Function, ethernet-ii-source: Internal functions
Function, ethernet-ii-type: Internal functions
Function, field: Internal functions
Function, get-layer: Exported functions
Function, ipv4-destination-address: Internal functions
Function, ipv4-flags: Internal functions
Function, ipv4-fragment-offset: Internal functions
Function, ipv4-header-checksum: Internal functions
Function, ipv4-header-length: Internal functions
Function, ipv4-identification: Internal functions
Function, ipv4-p: Internal functions
Function, ipv4-protocol: Internal functions
Function, ipv4-source-address: Internal functions
Function, ipv4-time-to-live: Internal functions
Function, ipv4-total-length: Internal functions
Function, ipv4-type-of-service: Internal functions
Function, ipv4-version: Internal functions
Function, main: Exported functions
Function, make-ethernet-ii: Exported functions
Function, make-ipv4: Exported functions
Function, make-packet: Exported functions
Function, name: Internal functions
Function, remove-layer: Exported functions
Function, show: Exported functions
Function, size: Internal functions
Function, value: Internal functions

G
get-layer: Exported functions

I
ipv4-destination-address: Internal functions
ipv4-flags: Internal functions
ipv4-fragment-offset: Internal functions
ipv4-header-checksum: Internal functions
ipv4-header-length: Internal functions
ipv4-identification: Internal functions
ipv4-p: Internal functions
ipv4-protocol: Internal functions
ipv4-source-address: Internal functions
ipv4-time-to-live: Internal functions
ipv4-total-length: Internal functions
ipv4-type-of-service: Internal functions
ipv4-version: Internal functions

M
Macro, deflayer: Exported macros
main: Exported functions
make-ethernet-ii: Exported functions
make-ipv4: Exported functions
make-packet: Exported functions

N
name: Internal functions

R
remove-layer: Exported functions

S
show: Exported functions
size: Internal functions

V
value: Internal functions

Jump to:   (  
A   C   D   E   F   G   I   M   N   R   S   V  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   +  
C   D   F   H   I   P   S   T   V  
Index Entry  Section

+
+default-packet-size+: Internal constants

C
Constant, +default-packet-size+: Internal constants

D
destination: Internal structures
destination-address: Internal structures

F
flags: Internal structures
fragment-offset: Internal structures

H
header-checksum: Internal structures
header-length: Internal structures

I
identification: Internal structures

P
protocol: Internal structures

S
Slot, destination: Internal structures
Slot, destination-address: Internal structures
Slot, flags: Internal structures
Slot, fragment-offset: Internal structures
Slot, header-checksum: Internal structures
Slot, header-length: Internal structures
Slot, identification: Internal structures
Slot, protocol: Internal structures
Slot, source: Internal structures
Slot, source-address: Internal structures
Slot, time-to-live: Internal structures
Slot, total-length: Internal structures
Slot, type: Internal structures
Slot, type-of-service: Internal structures
Slot, version: Internal structures
source: Internal structures
source-address: Internal structures

T
time-to-live: Internal structures
total-length: Internal structures
type: Internal structures
type-of-service: Internal structures

V
version: Internal structures

Jump to:   +  
C   D   F   H   I   P   S   T   V  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   B   E   I   L   P   S  
Index Entry  Section

B
bsl: The bsl package

E
ethernet-ii: Internal structures

I
ipv4: Internal structures

L
layers: The layers package

P
Package, bsl: The bsl package
Package, layers: The layers package
Package, packet: The packet package
Package, packet-crafting: The packet-crafting package
packet: The packet package
packet-crafting: The packet-crafting system
packet-crafting: The packet-crafting package

S
Structure, ethernet-ii: Internal structures
Structure, ipv4: Internal structures
System, packet-crafting: The packet-crafting system

Jump to:   B   E   I   L   P   S