# libsodium-prebuilt

[![build status](https://travis-ci.org/emilbayes/libsodium-prebuilt.svg?branch=master)](https://travis-ci.org/emilbayes/libsodium-prebuilt)
[![Build status](https://ci.appveyor.com/api/projects/status/g3xipfalgq6k9lrw/branch/master?svg=true)](https://ci.appveyor.com/project/emilbayes/libsodium-prebuilt/branch/master)

[`libsodium`](https://github.com/jedisct1/libsodium) prebuilt as a shared library and NAN module.

```
npm install libsodium-prebuilts
```

## Versions

This module will track libsodium versions, but may also increment versions if
there are changes to the build process the downstream modules depend on.

| `libsodium-prebuilt` | `libsodium`     |
|:---------------------|:----------------|
| 1.0.0                | 1.0.16 / 24.0.1 |

## Usage

```js
require('libsodium-prebuild') // will load symbols
// Load your native module which depends on libsodium-prebuilt

```

Get platform resolved base path to compiled dependencies:

```sh
node -p 'require("libsodium-prebuilt/paths").prefix'
```

Get path to `include` directory, eg. for including headers:

```sh
node -p 'require("libsodium-prebuilt/paths").include'
```

Get path to `lib` directory, eg. for linking to `.dylib` or `.so` files:

```sh
node -p 'require("libsodium-prebuilt/paths").lib'
```

Get path to the `.lib` file for linking on Windows:

```sh
node -p 'require("libsodium-prebuilt/paths").win32lib'
```

Get path to the versioned `.dll` file for linking on Windows:

```sh
node -p 'require("libsodium-prebuilt/paths").win32dll'
```

## Example GYP file

```python
{
    'variables': {
        'target_arch%': '<!(node -p "os.arch()")>'
    },
    'targets': [{
        'target_name': 'project_name',
        'include_dirs': [
          '<!(node -e "require(\'nan\')")',
          '<!(node -p "require(\'libsodium-prebuilt/paths\').include")'
        ],
        'sources': [
            # Source files (.c, .cc, .cpp, etc.)
        ],
        'xcode_settings': {
            'OTHER_CFLAGS': ['-g', '-O3']
        },
        'cflags': ['-g', '-O3'],
        'conditions': [
            ['OS == "win"', {
                'link_settings': {
                    'libraries': [
                        '<!(node -p "require(\'libsodium-prebuilt/paths\').win32lib")',
                    ]
                },
                'msvs_settings': {
                    'VCLinkerTool': {
                        'DelayLoadDLLs': ['<!(node -p "require(\'libsodium-prebuilt/paths\').win32dll")']
                    }
                },
            }],
            ['OS == "mac"', {
              'link_settings': {
                  'libraries': [
                      '-L<!(node -p "require(\'libsodium-prebuilt/paths\').lib")',
                      '-lazy-lsodium',
                  ]
              }
            }],
            ['OS == "linux"', {
                'link_settings': {
                    'libraries': [
                        '-L<!(node -p \'require("libsodium-prebuilt/paths").lib\')',
                        '-z lazy',
                        '-lsodium',
                    ]
                }
            }]
        ],
    }]
}
```

## Contributing

```sh
git clone --recursive git://github.com/emilbayes/libsodium-prebuilt.git
```

## License

ISC