Defined Type: st2::user

Defined in:
manifests/user.pp

Summary

Creates an system (OS level) user for use with StackStorm

Overview

Examples:

Custom SSH keys

st2::user { 'stanley':
  ssh_key_type => 'ssh-rsa',
  ssh_public_key => 'AAAAAWESOMEKEY==',
  ssh_private_key => '----- BEGIN RSA PRIVATE KEY -----\nDEADBEEF\n----- END RSA PRIVATE KEY -----',
}

Parameters:

  • client (Any) (defaults to: true)

    Allow incoming connections from the defined user

  • server (Any) (defaults to: false)

    Server where connection requests originate (usually st2 server)

  • create_sudo_entry (Any) (defaults to: false)

    Manage the sudoers entry (default: false)

  • ssh_public_key (Any) (defaults to: undef)

    SSH Public Key without leading key-type and end email.

  • ssh_key_type (Any) (defaults to: undef)

    Type of SSH Key (ssh-dsa/ssh-rsa)

  • ssh_private_key (Any) (defaults to: undef)

    SSH Private key. If not specified, then one will be generated.

  • groups (Any) (defaults to: undef)

    List of groups (OS level) that this user should be a member of

  • ssh_dir (Any) (defaults to: "/home/${name}/.ssh")

    Directory where SSH keys will be stored



27
28
29
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
# File 'manifests/user.pp', line 27

define st2::user(
  $client            = true,
  $server            = false,
  $create_sudo_entry = false,
  $ssh_key_type      = undef,
  $ssh_public_key    = undef,
  $ssh_private_key   = undef,
  $groups            = undef,
  $ssh_dir           = "/home/${name}/.ssh",
) {
  include st2::params

  $_packs_group_name = $st2::params::packs_group_name

  if $create_sudo_entry {
    if !defined(Class['sudo']) and !defined(Class['sudo']) {
      class { 'sudo':
        # do not purge files in /etc/sudoers.d/*
        purge               => false,
        # the 'enable' option (for some reason) purges all /etc/sudoers.d/* files
        enable              => false,
        # do not replace /etc/sudoers file
        config_file_replace => false,
      }
    }

    ensure_resource('sudo::conf', $name, {
      'priority' => '10',
      # note: passes in $name variable into template
      'content'  => template('st2/etc/sudoers.d/user.erb'),
    })
  }

  ensure_resource('group', $_packs_group_name, {
    'ensure' => present,
  })

  ensure_resource('group', $name, {
    'ensure' => present,
  })

  ensure_resource('user', $name, {
    'ensure'     => present,
    'shell'      => '/bin/bash',
    'gid'        => $name,
    'groups'     => $groups,
    'managehome' => true,
  })

  ### Setup SSH Keys ###
  ensure_resource('file', $ssh_dir, {
    'ensure' => directory,
    'owner'  => $name,
    'group'  => $name,
    'mode'   => '0700',
  })

  if $server {
    if !$ssh_private_key {
      $_ssh_keygen = true
      $_ssh_keygen_type = $ssh_key_type ? {
        undef => 'rsa',
        default => $ssh_key_type,
      }

      $_ssh_keygen_key_path = "${ssh_dir}/st2_${name}_key"
      exec { "generate ssh key ${_ssh_keygen_key_path}":
        command => "ssh-keygen -f ${_ssh_keygen_key_path} -t ${_ssh_keygen_type} -P ''",
        creates => $_ssh_keygen_key_path,
        path    => ['/usr/bin', '/sbin', '/bin'],
        require => File[$ssh_dir],
        before  => [File["${ssh_dir}/st2_${name}_key"],
                    File["${ssh_dir}/st2_${name}_key.pub"]],
      }

      # define these files so proper owner and permissions are set
      file { "${ssh_dir}/st2_${name}_key":
        ensure => file,
        owner  => $name,
        group  => $name,
        mode   => '0600',
      }

      file { "${ssh_dir}/st2_${name}_key.pub":
        ensure => file,
        owner  => $name,
        group  => $name,
        mode   => '0644',
      }
    }
    else {
      $_ssh_keygen = false
      file { "${ssh_dir}/st2_${name}_key":
        ensure  => file,
        owner   => $name,
        group   => $name,
        mode    => '0600',
        content => $ssh_private_key,
      }

      file { "${ssh_dir}/st2_${name}_key.pub":
        ensure  => file,
        owner   => $name,
        group   => $name,
        mode    => '0644',
        content => "${ssh_key_type} ${ssh_public_key}",
      }
    }
  }

  if $client {
    if $_ssh_keygen {
      # set proper owner + permissions on authorized keys
      ensure_resource('file', "${ssh_dir}/authorized_keys", {
        'ensure' => file,
        'owner'  => $name,
        'group'  => $name,
        'mode'   => '0600'
      })

      # add this user's key to authorized_keys
      exec { "add st2_${name}_key to ssh authorized keys":
        command   => "cat ${_ssh_keygen_key_path}.pub >> ${ssh_dir}/authorized_keys",
        onlyif    => "test `grep -f ${_ssh_keygen_key_path}.pub ${ssh_dir}/authorized_keys | wc -l` == 0",
        path      => ['/usr/bin', '/bin'],
        require   => File["${ssh_dir}/authorized_keys"],
        subscribe => Exec["generate ssh key ${_ssh_keygen_key_path}"],
      }
    }
    elsif $ssh_key_type and $ssh_public_key {
      ssh_authorized_key { "st2_${name}_key":
        type    => $ssh_key_type,
        user    => $name,
        key     => $ssh_public_key,
        require => File[$ssh_dir],
      }
    }
    else {
      notify { "St2::User[${name}]: ${st2::notices::user_missing_client_keys}": }
    }
  }
  ### END Setup SSH Keys ###
}