Skip to content

Commit

Permalink
Merge pull request #23 from KaneRoot/master
Browse files Browse the repository at this point in the history
README, spelling corrections
  • Loading branch information
jimsch committed Jan 15, 2016
2 parents d8592f1 + e41c4f5 commit 0e548b8
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
@@ -1,22 +1,22 @@

# COSE-C Implementation [![Build Status](https://travis-ci.org/cose-wg/COSE-C.svg?branch=master)](https://travis-ci.org/cose-wg/COSE-C) [![Coverage Status](https://coveralls.io/repos/cose-wg/COSE-C/badge.svg?branch=master&service=github)](https://coveralls.io/github/cose-wg/COSE-C?branch=master)

This project is a C implementation of the IETF CBOR Encoded Mesage Syntax (COSE).
This project is a C implementation of the IETF CBOR Encoded Message Syntax (COSE).
There are currently two versions of the COSE document that can be read.
The most current work in progress draft can be found on github in the [cose-wg/cose-spec](https://cose-wg.github.io/cose-spec/) project.
The IETF also keeps a copy of the spec in the [COSE WG](https://tools.ietf.org/html/draft-ietf-cose-msg).

The project is using the [CN-CBOR](https://github.com/cabo/cn-cbor) project to provide an implemenetation of the Concise Binary Object Representation or [CBOR](https://datatracker.ietf.org/doc/rfc7049/).
The project is using the [CN-CBOR](https://github.com/cabo/cn-cbor) project to provide an implementation of the Concise Binary Object Representation or [CBOR](https://datatracker.ietf.org/doc/rfc7049/).

The project is using OpenSSL for the cryptographic primatives.
The project is using OpenSSL for the cryptographic primitives.

## Contributing

Go ahead, file issues, make pull requests.

## Building

The project is setup to build using *CMake.* The way that the CMake files are setup, itrequires that version 3.0 or higher is used.
The project is setup to build using *CMake.* The way that the CMake files are setup, it requires that version 3.0 or higher is used.

The project requires the use of cn-cbor(https://github.com/cabo/cn-cbor) in order to build. The CMake configuration files will automatically pull down the correct version when run.

Expand All @@ -27,7 +27,7 @@ The memory model used in this library is a mess. This is in large part because
There are three different memory models that can be used with cn-cbor and cose-c, at this time only one of them is going to produce good results for long running systems.

The cn-cbor project was built with a specific memory model, but did not limit itself to that memory model when writing the code.
It was originally designed for working on small devices that use a block allocater with suballocations done from that allocated block.
It was originally designed for working on small devices that use a block allocator with sub-allocations done from that allocated block.
This allows for all of the items allocated in that large block to be freed in a single operation when everything is done.

* Build without USE_CONTEXT: This model uses standard calloc/free and suffers from the cn-cbor memory model problems.
Expand Down

0 comments on commit 0e548b8

Please sign in to comment.