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

The aws-sign4 Reference Manual

This is the aws-sign4 Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 14:39:44 2024 GMT+0.

Table of Contents

Next: Systems, Previous: The aws-sign4 Reference Manual, Up: The aws-sign4 Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The aws-sign4 Reference Manual [Contents][Index]

2 Systems

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

aws-sign4

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

2.1 `aws-sign4`

A library for Amazon Web Services signing version 4

Author

Thomas Bakketun <thomas.bakketun@copyleft.no>

License

GNU Lesser General Public Licence 3.0

Dependencies

local-time (system).
cl-ppcre (system).
ironclad (system).
split-sequence (system).
flexi-streams (system).
secret-values (system).

Source

aws-sign4.asd.

Child Components

package.lisp (file).
aws-sign4.lisp (file).

Next: Packages, Previous: Systems, Up: The aws-sign4 Reference Manual [Contents][Index]

3 Files

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

Lisp

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

3.1 Lisp

aws-sign4/aws-sign4.asd
aws-sign4/package.lisp
aws-sign4/aws-sign4.lisp

Next: aws-sign4/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `aws-sign4/aws-sign4.asd`

Source: aws-sign4.asd.
Parent Component: aws-sign4 (system).
ASDF Systems: aws-sign4.

Next: aws-sign4/aws-sign4.lisp, Previous: aws-sign4/aws-sign4.asd, Up: Lisp [Contents][Index]

3.1.2 `aws-sign4/package.lisp`

Source: aws-sign4.asd.
Parent Component: aws-sign4 (system).
Packages: aws-sign4.

Previous: aws-sign4/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `aws-sign4/aws-sign4.lisp`

Dependency

package.lisp (file).

Source

aws-sign4.asd.

Parent Component

aws-sign4 (system).

Public Interface

*aws-credentials* (special variable).
aws-sign4 (function).
calculate-signature (function).
create-canonical-headers (function).
create-canonical-path (function).
create-canonical-query-string (function).
create-canonical-request (function).
get-credentials (function).

Internals

create-signed-headers (function).
ensure-octets (function).
hash (function).
hex-encode (function).
hmac (function).
merge-duplicate-headers (function).
string-to-sign (function).
trimall (function).
url-encode (function).

Next: Definitions, Previous: Files, Up: The aws-sign4 Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

aws-sign4

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

4.1 `aws-sign4`

Source

package.lisp.

Use List

common-lisp.

Public Interface

*aws-credentials* (special variable).
aws-sign4 (function).
calculate-signature (function).
create-canonical-headers (function).
create-canonical-path (function).
create-canonical-query-string (function).
create-canonical-request (function).
get-credentials (function).

Internals

create-signed-headers (function).
ensure-octets (function).
hash (function).
hex-encode (function).
hmac (function).
merge-duplicate-headers (function).
string-to-sign (function).
trimall (function).
url-encode (function).

Next: Indexes, Previous: Packages, Up: The aws-sign4 Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Special variables
Ordinary functions

Next: Ordinary functions, Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Special variables

Special Variable: *aws-credentials* ¶

Package: aws-sign4.
Source: aws-sign4.lisp.

Previous: Special variables, Up: Public Interface [Contents][Index]

5.1.2 Ordinary functions

Function: aws-sign4 (&key region service method host path params headers payload date-header request-date expires scheme) ¶

Package: aws-sign4.
Source: aws-sign4.lisp.

Function: calculate-signature (k-secret string-to-sign date region service) ¶

Package: aws-sign4.
Source: aws-sign4.lisp.

Function: create-canonical-headers (headers) ¶

Package: aws-sign4.
Source: aws-sign4.lisp.

Function: create-canonical-path (path) ¶

Package: aws-sign4.
Source: aws-sign4.lisp.

Function: create-canonical-query-string (params) ¶

Package: aws-sign4.
Source: aws-sign4.lisp.

Function: create-canonical-request (method canonical-path canonical-query-string canonical-headers signed-headers payload) ¶

Package: aws-sign4.
Source: aws-sign4.lisp.

Function: get-credentials () ¶

Package: aws-sign4.
Source: aws-sign4.lisp.

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

5.2 Internals

Ordinary functions

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

5.2.1 Ordinary functions

Function: create-signed-headers (canonical-headers) ¶

Package: aws-sign4.
Source: aws-sign4.lisp.

Function: ensure-octets (data) ¶

Package: aws-sign4.
Source: aws-sign4.lisp.

Function: hash (data) ¶

Package: aws-sign4.
Source: aws-sign4.lisp.

Function: hex-encode (bytes) ¶

Package: aws-sign4.
Source: aws-sign4.lisp.

Function: hmac (key data) ¶

Package: aws-sign4.
Source: aws-sign4.lisp.

Function: merge-duplicate-headers (headers) ¶

Package: aws-sign4.
Source: aws-sign4.lisp.

Function: string-to-sign (request-date credential-scope canonical-request) ¶

Package: aws-sign4.
Source: aws-sign4.lisp.

Function: trimall (string) ¶

Package: aws-sign4.
Source: aws-sign4.lisp.

Function: url-encode (string &key escape%) ¶

URL-encodes a string using the external format UTF-8. If keyword parameter ESCAPE% is NIL, the % is not escaped.

Package: aws-sign4.
Source: aws-sign4.lisp.

Previous: Definitions, Up: The aws-sign4 Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	A C E F G H M S T U

	Index Entry		Section

A
	`aws-sign4`:		Public ordinary functions

C
	`calculate-signature`:		Public ordinary functions
	`create-canonical-headers`:		Public ordinary functions
	`create-canonical-path`:		Public ordinary functions
	`create-canonical-query-string`:		Public ordinary functions
	`create-canonical-request`:		Public ordinary functions
	`create-signed-headers`:		Private ordinary functions

E
	`ensure-octets`:		Private ordinary functions

F
	`Function, aws-sign4`:		Public ordinary functions
	`Function, calculate-signature`:		Public ordinary functions
	`Function, create-canonical-headers`:		Public ordinary functions
	`Function, create-canonical-path`:		Public ordinary functions
	`Function, create-canonical-query-string`:		Public ordinary functions
	`Function, create-canonical-request`:		Public ordinary functions
	`Function, create-signed-headers`:		Private ordinary functions
	`Function, ensure-octets`:		Private ordinary functions
	`Function, get-credentials`:		Public ordinary functions
	`Function, hash`:		Private ordinary functions
	`Function, hex-encode`:		Private ordinary functions
	`Function, hmac`:		Private ordinary functions
	`Function, merge-duplicate-headers`:		Private ordinary functions
	`Function, string-to-sign`:		Private ordinary functions
	`Function, trimall`:		Private ordinary functions
	`Function, url-encode`:		Private ordinary functions

G
	`get-credentials`:		Public ordinary functions

H
	`hash`:		Private ordinary functions
	`hex-encode`:		Private ordinary functions
	`hmac`:		Private ordinary functions

M
	`merge-duplicate-headers`:		Private ordinary functions

S
	`string-to-sign`:		Private ordinary functions

T
	`trimall`:		Private ordinary functions

U
	`url-encode`:		Private ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* S

	Index Entry		Section

*
	`aws-credentials`:		Public special variables

S
	`Special Variable, aws-credentials`:		Public special variables

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

A.4 Data types

Jump to:	A F P S

	Index Entry		Section

A
	`aws-sign4`:		The aws-sign4 system
	`aws-sign4`:		The aws-sign4 package
	`aws-sign4.asd`:		The aws-sign4/aws-sign4․asd file
	`aws-sign4.lisp`:		The aws-sign4/aws-sign4․lisp file

F
	`File, aws-sign4.asd`:		The aws-sign4/aws-sign4․asd file
	`File, aws-sign4.lisp`:		The aws-sign4/aws-sign4․lisp file
	`File, package.lisp`:		The aws-sign4/package․lisp file

P
	`Package, aws-sign4`:		The aws-sign4 package
	`package.lisp`:		The aws-sign4/package․lisp file

S
	`System, aws-sign4`:		The aws-sign4 system