user.go 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201
  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. // GetUser finds and returns the user with the given username from database.
  38. func GetUser(username string) (*DBUser, error) {
  39. user := DBUser{}
  40. db.Where(&DBUser{Username: username}).First(&user)
  41. if db.NewRecord(&user) {
  42. // user is not found
  43. return nil, fmt.Errorf("user not found: %s", username)
  44. }
  45. return &user, nil
  46. }
  47. // GetAllUsers returns all recorded users in the database.
  48. func GetAllUsers() ([]*DBUser, error) {
  49. var users []*DBUser
  50. db.Find(&users)
  51. return users, nil
  52. }
  53. // CreateNewUser creates a new user with the given username and password in the database.
  54. // It also generates the necessary client keys and signs certificates with the current
  55. // server's CA.
  56. func CreateNewUser(username, password string) (*DBUser, error) {
  57. if !IsInitialized() {
  58. return nil, fmt.Errorf("you first need to create server")
  59. }
  60. // Validate user input.
  61. if govalidator.IsNull(username) {
  62. return nil, fmt.Errorf("validation error: %s can not be null", username)
  63. }
  64. if !govalidator.IsAlphanumeric(username) {
  65. return nil, fmt.Errorf("validation error: `%s` can only contain letters and numbers", username)
  66. }
  67. ca, err := GetSystemCA()
  68. if err != nil {
  69. return nil, err
  70. }
  71. clientCert, err := pki.NewClientCertHolder(username, ca)
  72. if err != nil {
  73. return nil, fmt.Errorf("can not create client cert %s: %v", username, err)
  74. }
  75. server, err := GetServerInstance()
  76. if err != nil {
  77. return nil, fmt.Errorf("can not get server: %v", err)
  78. }
  79. user := DBUser{
  80. Username: username,
  81. Password: password,
  82. Cert: clientCert.Cert,
  83. Key: clientCert.Key,
  84. ServerSerialNumber: server.SerialNumber,
  85. }
  86. db.Create(&user)
  87. if db.NewRecord(&user) {
  88. // user is still not created
  89. return nil, fmt.Errorf("can not create user in database: %s", user.Username)
  90. }
  91. logrus.Infof("user created: %s", username)
  92. // Emit server config
  93. err = Emit()
  94. if err != nil {
  95. return nil, err
  96. }
  97. return &user, nil
  98. }
  99. // Delete deletes a user by the given username from the database.
  100. func (u *DBUser) Delete() error {
  101. if db.NewRecord(&u) {
  102. // user is not found
  103. return fmt.Errorf("user is not initialized: %s", u.Username)
  104. }
  105. crt, err := pki.ReadCertFromPEM(u.Cert)
  106. if err != nil {
  107. return fmt.Errorf("can not get user's certificate: %v", err)
  108. }
  109. db.Create(&DBRevoked{
  110. SerialNumber: crt.SerialNumber.Text(16),
  111. })
  112. db.Unscoped().Delete(&u)
  113. logrus.Infof("user deleted: %s", u.GetUsername())
  114. err = Emit()
  115. if err != nil {
  116. return err
  117. }
  118. u = nil // delete the existing user struct
  119. return nil
  120. }
  121. // ResetPassword resets the users password into the provided password.
  122. func (u *DBUser) ResetPassword(password string) error {
  123. err := u.setPassword(password)
  124. if err != nil {
  125. // user password can not be updated
  126. return fmt.Errorf("user password can not be updated %s: %v", u.Username, err)
  127. }
  128. db.Save(u)
  129. logrus.Infof("user password reset: %s", u.GetUsername())
  130. return nil
  131. }
  132. // Sign creates a key and a ceritificate signed by the current server's CA.
  133. //
  134. // This is often used to sign users when the current CA is changed while there are
  135. // still existing users in the database.
  136. func (u *DBUser) Sign() error {
  137. if !IsInitialized() {
  138. return fmt.Errorf("you first need to create server")
  139. }
  140. ca, err := GetSystemCA()
  141. if err != nil {
  142. return err
  143. }
  144. clientCert, err := pki.NewClientCertHolder(u.Username, ca)
  145. if err != nil {
  146. return fmt.Errorf("can not create client cert %s: %v", u.Username, err)
  147. }
  148. server, err := GetServerInstance()
  149. if err != nil {
  150. return err
  151. }
  152. u.Cert = clientCert.Cert
  153. u.Key = clientCert.Key
  154. u.ServerSerialNumber = server.SerialNumber
  155. db.Save(&u)
  156. logrus.Infof("user renewed cert: %s", u.GetUsername())
  157. return nil
  158. }
  159. // GetUsername returns user's username.
  160. func (u *DBUser) GetUsername() string {
  161. return u.Username
  162. }
  163. // GetCert returns user's public certificate.
  164. func (u *DBUser) GetCert() string {
  165. return u.Cert
  166. }
  167. // GetServerSerialNumber returns user's server serial number.
  168. func (u *DBUser) GetServerSerialNumber() string {
  169. return u.ServerSerialNumber
  170. }
  171. // GetCreatedAt returns user's creation time.
  172. func (u *DBUser) GetCreatedAt() string {
  173. return u.CreatedAt.Format(time.UnixDate)
  174. }