user.go 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206
  1. package ovpm
  2. import (
  3. "fmt"
  4. "time"
  5. "github.com/Sirupsen/logrus"
  6. "github.com/asaskevich/govalidator"
  7. "github.com/cad/ovpm/pki"
  8. "github.com/jinzhu/gorm"
  9. )
  10. // User represents the interface that is being used within the public api.
  11. type User interface {
  12. GetUsername() string
  13. GetServerSerialNumber() string
  14. GetCert() string
  15. }
  16. // DBUser is database model for VPN users.
  17. type DBUser struct {
  18. gorm.Model
  19. ServerID uint
  20. Server DBServer
  21. Username string `gorm:"unique_index"`
  22. Cert string
  23. ServerSerialNumber string
  24. Password string
  25. Key string
  26. }
  27. // DBRevoked is a database model for revoked VPN users.
  28. type DBRevoked struct {
  29. gorm.Model
  30. SerialNumber string
  31. }
  32. func (u *DBUser) setPassword(password string) error {
  33. // TODO(cad): Use a proper password hashing algorithm here.
  34. u.Password = password
  35. return nil
  36. }
  37. // CheckPassword returns wether the given password is correct for the user.
  38. func (u *DBUser) CheckPassword(password string) bool {
  39. return u.Password == password
  40. }
  41. // GetUser finds and returns the user with the given username from database.
  42. func GetUser(username string) (*DBUser, error) {
  43. user := DBUser{}
  44. db.Where(&DBUser{Username: username}).First(&user)
  45. if db.NewRecord(&user) {
  46. // user is not found
  47. return nil, fmt.Errorf("user not found: %s", username)
  48. }
  49. return &user, nil
  50. }
  51. // GetAllUsers returns all recorded users in the database.
  52. func GetAllUsers() ([]*DBUser, error) {
  53. var users []*DBUser
  54. db.Find(&users)
  55. return users, nil
  56. }
  57. // CreateNewUser creates a new user with the given username and password in the database.
  58. // It also generates the necessary client keys and signs certificates with the current
  59. // server's CA.
  60. func CreateNewUser(username, password string) (*DBUser, error) {
  61. if !IsInitialized() {
  62. return nil, fmt.Errorf("you first need to create server")
  63. }
  64. // Validate user input.
  65. if govalidator.IsNull(username) {
  66. return nil, fmt.Errorf("validation error: %s can not be null", username)
  67. }
  68. if !govalidator.IsAlphanumeric(username) {
  69. return nil, fmt.Errorf("validation error: `%s` can only contain letters and numbers", username)
  70. }
  71. ca, err := GetSystemCA()
  72. if err != nil {
  73. return nil, err
  74. }
  75. clientCert, err := pki.NewClientCertHolder(ca, username)
  76. if err != nil {
  77. return nil, fmt.Errorf("can not create client cert %s: %v", username, err)
  78. }
  79. server, err := GetServerInstance()
  80. if err != nil {
  81. return nil, fmt.Errorf("can not get server: %v", err)
  82. }
  83. user := DBUser{
  84. Username: username,
  85. Password: password,
  86. Cert: clientCert.Cert,
  87. Key: clientCert.Key,
  88. ServerSerialNumber: server.SerialNumber,
  89. }
  90. db.Create(&user)
  91. if db.NewRecord(&user) {
  92. // user is still not created
  93. return nil, fmt.Errorf("can not create user in database: %s", user.Username)
  94. }
  95. logrus.Infof("user created: %s", username)
  96. // Emit server config
  97. err = Emit()
  98. if err != nil {
  99. return nil, err
  100. }
  101. return &user, nil
  102. }
  103. // Delete deletes a user by the given username from the database.
  104. func (u *DBUser) Delete() error {
  105. if db.NewRecord(&u) {
  106. // user is not found
  107. return fmt.Errorf("user is not initialized: %s", u.Username)
  108. }
  109. crt, err := pki.ReadCertFromPEM(u.Cert)
  110. if err != nil {
  111. return fmt.Errorf("can not get user's certificate: %v", err)
  112. }
  113. db.Create(&DBRevoked{
  114. SerialNumber: crt.SerialNumber.Text(16),
  115. })
  116. db.Unscoped().Delete(&u)
  117. logrus.Infof("user deleted: %s", u.GetUsername())
  118. err = Emit()
  119. if err != nil {
  120. return err
  121. }
  122. u = nil // delete the existing user struct
  123. return nil
  124. }
  125. // ResetPassword resets the users password into the provided password.
  126. func (u *DBUser) ResetPassword(password string) error {
  127. err := u.setPassword(password)
  128. if err != nil {
  129. // user password can not be updated
  130. return fmt.Errorf("user password can not be updated %s: %v", u.Username, err)
  131. }
  132. db.Save(u)
  133. logrus.Infof("user password reset: %s", u.GetUsername())
  134. return nil
  135. }
  136. // Renew creates a key and a ceritificate signed by the current server's CA.
  137. //
  138. // This is often used to sign users when the current CA is changed while there are
  139. // still existing users in the database.
  140. func (u *DBUser) Renew() error {
  141. if !IsInitialized() {
  142. return fmt.Errorf("you first need to create server")
  143. }
  144. ca, err := GetSystemCA()
  145. if err != nil {
  146. return err
  147. }
  148. clientCert, err := pki.NewClientCertHolder(ca, u.Username)
  149. if err != nil {
  150. return fmt.Errorf("can not create client cert %s: %v", u.Username, err)
  151. }
  152. server, err := GetServerInstance()
  153. if err != nil {
  154. return err
  155. }
  156. u.Cert = clientCert.Cert
  157. u.Key = clientCert.Key
  158. u.ServerSerialNumber = server.SerialNumber
  159. db.Save(&u)
  160. logrus.Infof("user renewed cert: %s", u.GetUsername())
  161. return nil
  162. }
  163. // GetUsername returns user's username.
  164. func (u *DBUser) GetUsername() string {
  165. return u.Username
  166. }
  167. // GetCert returns user's public certificate.
  168. func (u *DBUser) GetCert() string {
  169. return u.Cert
  170. }
  171. // GetServerSerialNumber returns user's server serial number.
  172. func (u *DBUser) GetServerSerialNumber() string {
  173. return u.ServerSerialNumber
  174. }
  175. // GetCreatedAt returns user's creation time.
  176. func (u *DBUser) GetCreatedAt() string {
  177. return u.CreatedAt.Format(time.UnixDate)
  178. }