security-identifier

Convert Windows security identifiers between binary and string representations.

Table Of Contents:

• Installation
• Use Cases
• API
• Command Line

Installation

$ npm install security-identifier

Use Cases

• Formatting the binary representation of an objectSid in Apple Directory Utility as a SID string on the command line

  $ sid '01020000 00000005 20000000 20020000'
  S-1-5-32-544

• Formatting the SID string from a Windows Audit Event as a Buffer for use in an LDAP filter (with ldapjs)

  const ldap = require('ldapjs');
  const { sidStringToBuffer } = require('security-identifier');
  const filter = new ldap.EqualityFilter({
    attribute: 'objectSID',
    value: sidStringToBuffer('S-1-5-32-544'),
  });

API

sidBufferToString(buf: Buffer): string

Converts from sid binary format Buffer to sid string.

Example:

const { sidBufferToString } = require('security-identifier');
sidBufferToString(Buffer.from('01020000000000052000000020020000', 'hex')); // ⇨ 'S-1-5-32-544'

sidStringToBuffer(sid: string): Buffer

Converts from sid string format syntax to sid binary format.

Example:

const { sidStringToBuffer } = require('security-identifier');
sidStringToBuffer('S-1-5-32-544'); // ⇨ <Buffer 01 02 00 00 00 00 00 05 20 00 00 00 20 02 00 00>

Command Line

security-identifier includes an executable sid, which can be used from the command line to convert between string and binary (hex encoded) formats

$ sid S-1-5-32-544
01020000000000052000000020020000
 
$ sid 01020000000000052000000020020000
S-1-5-32-544