drm v0.2.1

Drm (drm v0.2.1) View Source

A Digital Rights Management System for Elixir Applications/Modules.

Drm loads valid license files into genservers and then dispatches incoming requests to them for validation.

In this model we give each different otp application a fingerprint/hash, and associate it with a license key.

Here we are creating a new license for an otp app which we reference as "umbrella-app-hash-id", (this creates the license file, and loads it into the licensing server), then we check to see if the license is still valid

## Examples

 iex> license =  %{hash: "license-key12", meta: %{email: "demo@example.com", name: "licensee name"}, policy: %{name: "policy name", type: "free", expiration: nil, validation_type: "strict", checkin: false, checkin_interval: nil, max_fingerprints: nil, fingerprint: "umbrella-app-hash-id"}}
 iex> License.create(license)
 iex> License.fingerprint_valid?(license.policy.fingerprint)
 true

Link to this section Summary

Functions

clear()

Remove all licenses

create(map)

Create a new license

decode(license)

Decode a license

delete(file)

Delete a license by filename

encode(license)

Encode a license

export(id, type \\ "list")

Export the license file

export_keys()

Export license keys

fingerprint_valid?(f)

check if the appid "fingerprint" exists

generate_key(hash, number \\ 1, delimeter \\ "-")

Generate a license key based on a hash

is_base64?(data)
is_valid?(license)

Validate that a license struct is valid

is_valid?(license, fingerprint_in_question)

Validate that a license struct is valid and matches the fingerprint

valid?(license_string)

Validate an encrypted license string

valid?(license_string, fingerprint_in_question)

Validate that an encrypted license is valid and matches the fingerprint

Link to this section Functions

Link to this function

clear()

View Source

Specs

clear() :: String.t()

Remove all licenses

Examples 

 iex> License.clear()
 :ok
Link to this function

create(map)

View Source

Specs

create(Map.t()) :: String.t()

Create a new license

Parameters

  • hash: the license key string
  • meta: a map of meta data to enclude in the license
  • policy: a map of the main policy for the license ### Parameters
    • name : the name of the policy
    • type: the type of policy "free | commercial"
    • expiration: the license experation date this is a Datetime.t -> int ie. DateTime.utc_now() |> to_unix
    • validation_type: the validation type "strict | floating | concurrent"
    • checkin: when to checkin "true | false"
    • checkin_interval: when to checkin "nil | daily | weekly | monthly"
    • max_fingerprints: the number of max fingerprints for this license
    • fingerprint: the fingerprint for this license

      Validation Types

    • strict: a license that implements the policy will be considered invalid if its machine limit is surpassed
    • floating: a license that implements the policy will be valid across multiple machines
    • concurrent: a licensing model, where you allow a set number of machines to be activated at one time, and exceeding that limit may invalidate all current sessions.

      Types

    • free: a free license
    • commercial: a free license

Examples 

iex> license =  %{hash: "license-key12", meta: %{email: "demo@example.com", name: "licensee name"}, policy: %{name: "policy name", type: "free", expiration: nil, validation_type: "strict", checkin: false, checkin_interval: nil, max_fingerprints: nil, fingerprint: "main-app-name-umbrella-app-hash-id"}}
iex>  License.create(license)
true
Link to this function

decode(license)

View Source

Specs

decode(String.t()) :: Map.t()

Decode a license

Examples 

license_string = "1ASHD7P87VKlA1iC8Q3tdPFCthdeHxSOWS6BQfUv8gsC8yzNg6OeccIErfuKGvRWzzsRyZ7n/0RwE7ZuQCBL4eHPL5zhGCW5JunAKlsorpKdbMWACiv64q/JO3TOCBJSasd0grljX8z2OzKDeEyk7f0xfIleeL0jXfe+rF9/JC4o7vRHTwJS5va6r19fcWWB5u4AxQUw5tsJmcWBVX5TDwTH8WSJr8HK9xto8V6M1DNzNUKf3dLHBr32dVUjM+uNW2W2uy5Cl3LKIPxv+rmwZmTBZ/1kX8VrqE1BXCM7HttiwzmBEmbQJrvcnY5CAiO562HJTAM6C7RFsHGOtrwWINRzCkMxOffAeuHYy6G9S+ngasJBR/0a39HcA2Ic4mz5"
License.decode(license_string)
Link to this function

delete(file)

View Source

Specs

delete(String.t()) :: any()

Delete a license by filename

Examples 

  iex> License.delete("3454453444")
  {:error, :enoent}
Link to this function

encode(license)

View Source

Specs

encode(Map.t()) :: String.t()

Encode a license

Parameters

  • hash: the license key string
  • meta: a map of meta data to enclude in the license
  • policy: a map of the main policy for the license ### Parameters
    • name : the name of the policy
    • type: the type of policy "free | commercial"
    • expiration: the license experation date this is a Datetime.t -> int ie. DateTime.utc_now() |> to_unix
    • validation_type: the validation type "strict | floating | concurrent"
    • checkin: when to checkin "true | false"
    • checkin_interval: when to checkin "nil | daily | weekly | monthly"
    • max_fingerprints: the number of max fingerprints for this license
    • fingerprint: the fingerprint for this license

      Validation Types

    • strict: a license that implements the policy will be considered invalid if its machine limit is surpassed
    • floating: a license that implements the policy will be valid across multiple machines
    • concurrent: a licensing model, where you allow a set number of machines to be activated at one time, and exceeding that limit may invalidate all current sessions.

      Types

    • free: a free license
    • commercial: a free license

Examples 

license =  %{hash: "license-key", meta: %{email: "demo@example.com", name: "licensee name"}, policy: %{name: "policy name", type: "free", expiration: 55, validation_type: "strict", checkin: false, checkin_interval: nil, max_fingerprints: nil, fingerprint: "main-app-name-umbrella-app-hash-id"}}
License.encode(license)
Link to this function

export(id, type \\ "list")

View Source

Export the license file

Examples 

 iex> fingerprint = "umbrella-app-id"
 iex> License.export(fingerprint)
 {:error, "fingerprint not found"}
Link to this function

export_keys()

View Source

Specs

export_keys() :: Map.t()

Export license keys

Examples 

License.export_keys()
Link to this function

fingerprint_valid?(f)

View Source

check if the appid "fingerprint" exists

Examples

 iex> fingerprint = "umbrella-app-id"
 iex> License.fingerprint_valid?(fingerprint)
 false
Link to this function

generate_key(hash, number \\ 1, delimeter \\ "-")

View Source

Specs

generate_key(String.t(), Integer.t(), String.t()) :: any()

Generate a license key based on a hash

Examples 

hash = "4424552325453453"
License.generate_key(hash, 2)
Link to this function

is_base64?(data)

View Source

Specs

is_base64?(String.t()) :: any()
Link to this function

is_valid?(license)

View Source

Validate that a license struct is valid

Examples 

license =  %{hash: "license-key", meta: %{email: "demo@example.com", name: "licensee name"}, policy: %{name: "policy name", type: "free", expiration: 55, validation_type: "strict", checkin: false, checkin_interval: nil, max_fingerprints: nil, fingerprint: "main-app-name-umbrella-app-hash-id"}}
License.is_valid?(license)
Link to this function

is_valid?(license, fingerprint_in_question)

View Source

Validate that a license struct is valid and matches the fingerprint

Examples 

license =  %{hash: "license-key", meta: %{email: "demo@example.com", name: "licensee name"}, policy: %{name: "policy name", type: "free", expiration: 55, validation_type: "strict", checkin: false, checkin_interval: nil, max_fingerprints: nil, fingerprint: "main-app-name-umbrella-app-hash-id"}}
fingerprint = "main-app-name-umbrella-app-hash-id"
License.is_valid?(license, fingerprint)
Link to this function

valid?(license_string)

View Source

Specs

valid?(String.t()) :: any()

Validate an encrypted license string

Examples 

 iex> license_string = "3454453444"
 iex> License.valid?(license_string)
 false
Link to this function

valid?(license_string, fingerprint_in_question)

View Source

Specs

valid?(String.t(), String.t()) :: any()

Validate that an encrypted license is valid and matches the fingerprint

Examples 

iex> license_string = "3454453444"
iex> fingerprint = "umbrella-app-id"
iex> License.valid?(license_string, fingerprint)
false