Defined Type: role::oauth::consumer

Defined in:
puppet/modules/role/manifests/oauth/consumer.pp

Overview

Define: role::oauth::consumer

Provision an OAuth consumer directly in the database.

Parameters:

consumer_key

OAuth consumer key.

secret_key

OAuth secret key.

callback_url

Application callback url.

is_prefix

Allow consumer to specify a callback in requests and use callback_url as a required prefix? Default true.

description

Application description. Default $title.

wiki

Project that grant is authorized for. Default '*'.

grants

Array of grants to allow authenticated clients. Default ['authonly'].

restrictions

Hash of usage restrictions. Default => ['0.0.0.0/0','::/0'].

user

Grant owner. Default 'Admin'.

owner_only

Consumer is for use by the owner only? Default false.

access_token

Accepted token for owner-only grant. Default undef.

access_secret

Accepted secret for owner-only grant. Default undef.

Parameters:

  • consumer_key (Any)
  • secret_key (Any)
  • callback_url (Any)
  • is_prefix (Any) (defaults to: true)
  • description (Any) (defaults to: $title)
  • wiki (Any) (defaults to: '*')
  • grants (Any) (defaults to: ['authonly'])
  • restrictions (Any) (defaults to: {'IPAddresses' => ['0.0.0.0/0','::/0']})
  • user (Any) (defaults to: 'Admin')
  • owner_only (Any) (defaults to: false)
  • access_token (Any) (defaults to: undef)
  • access_secret (Any) (defaults to: undef)
  • db_name (Any) (defaults to: $::mediawiki::db_name) 


30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'puppet/modules/role/manifests/oauth/consumer.pp', line 30

define role::oauth::consumer (
    $consumer_key,
    $secret_key,
    $callback_url,
    $is_prefix     = true,
    $description   = $title,
    $wiki          = '*',
    $grants        = ['authonly'],
    $restrictions  = {'IPAddresses' => ['0.0.0.0/0','::/0']},
    $user          = 'Admin',
    $owner_only    = false,
    $access_token  = undef,
    $access_secret = undef,
    $db_name       = $::mediawiki::db_name,
) {
    include ::role::oauth

    $grants_json = ordered_json($grants)
    $restrictions_json = ordered_json($restrictions)

    mysql::sql { "Register OAuth ${title}":
        sql     => template('role/oauth/register.sql.erb'),
        unless  => template('role/oauth/check.sql.erb'),
        require => [
            Mediawiki::Extension['OAuth'],
            Exec['update_all_databases'],
        ]
    }

    if $owner_only {
        mysql::sql { "Authorize OAuth ${title}":
            sql     => template('role/oauth/authorize.sql.erb'),
            unless  => template('role/oauth/check-auth.sql.erb'),
            require => Mysql::Sql["Register OAuth ${title}"],
        }
    }
}