fix: Require guests to login

This commit is contained in:
jamesread 2025-10-30 02:13:40 +00:00
parent 2a5732cc27
commit d21f06e555
12 changed files with 165 additions and 41 deletions

View File

@ -1316,6 +1316,11 @@ export declare type InitResponse = Message<"olivetin.api.v1.InitResponse"> & {
* @generated from field: bool show_log_list = 22; * @generated from field: bool show_log_list = 22;
*/ */
showLogList: boolean; showLogList: boolean;
/**
* @generated from field: bool login_required = 23;
*/
loginRequired: boolean;
}; };
/** /**

File diff suppressed because one or more lines are too long

View File

@ -59,6 +59,7 @@
<script setup> <script setup>
import { ref, onMounted } from 'vue'; import { ref, onMounted } from 'vue';
import { useRouter } from 'vue-router';
import Sidebar from 'picocrank/vue/components/Sidebar.vue'; import Sidebar from 'picocrank/vue/components/Sidebar.vue';
import Header from 'picocrank/vue/components/Header.vue'; import Header from 'picocrank/vue/components/Header.vue';
import { HugeiconsIcon } from '@hugeicons/vue' import { HugeiconsIcon } from '@hugeicons/vue'
@ -67,6 +68,8 @@ import { UserCircle02Icon } from '@hugeicons/core-free-icons'
import { DashboardSquare01Icon } from '@hugeicons/core-free-icons' import { DashboardSquare01Icon } from '@hugeicons/core-free-icons'
import logoUrl from '../../OliveTinLogo.png'; import logoUrl from '../../OliveTinLogo.png';
const router = useRouter();
const sidebar = ref(null); const sidebar = ref(null);
const username = ref('guest'); const username = ref('guest');
const isLoggedIn = ref(false); const isLoggedIn = ref(false);
@ -107,7 +110,14 @@ async function requestInit() {
try { try {
const initResponse = await window.client.init({}) const initResponse = await window.client.init({})
// Store init response first so the login view can read options (e.g., authLocalLogin)
window.initResponse = initResponse window.initResponse = initResponse
// Check if login is required and redirect if so (after storing initResponse)
if (initResponse.loginRequired) {
router.push('/login')
return
}
window.initError = false window.initError = false
window.initErrorMessage = '' window.initErrorMessage = ''
window.initCompleted = true window.initCompleted = true

View File

@ -13,6 +13,10 @@
<dd v-if="userProvider !== 'system'">{{ userProvider }}</dd> <dd v-if="userProvider !== 'system'">{{ userProvider }}</dd>
<dt v-if="usergroup">Group</dt> <dt v-if="usergroup">Group</dt>
<dd v-if="usergroup">{{ usergroup }}</dd> <dd v-if="usergroup">{{ usergroup }}</dd>
<dt v-if="acls && acls.length > 0">Matched ACLs</dt>
<dd v-if="acls && acls.length > 0">
<span class="acl-tag" v-for="acl in acls" :key="acl">{{ acl }}</span>
</dd>
</dl> </dl>
<div class="user-actions"> <div class="user-actions">
@ -38,6 +42,7 @@ const username = ref('guest')
const userProvider = ref('system') const userProvider = ref('system')
const usergroup = ref('') const usergroup = ref('')
const loggingOut = ref(false) const loggingOut = ref(false)
const acls = ref([])
function updateUserInfo() { function updateUserInfo() {
if (window.initResponse) { if (window.initResponse) {
@ -48,6 +53,20 @@ function updateUserInfo() {
} }
} }
async function fetchWhoAmI() {
try {
const res = await window.client.whoAmI({})
acls.value = res.acls || []
// Update usergroup from authoritative WhoAmI response
if (res.usergroup) {
usergroup.value = res.usergroup
}
} catch (e) {
console.warn('Failed to fetch WhoAmI for ACLs', e)
acls.value = []
}
}
async function handleLogout() { async function handleLogout() {
loggingOut.value = true loggingOut.value = true
@ -70,8 +89,12 @@ async function handleLogout() {
console.error('Failed to reinitialize after logout:', initErr) console.error('Failed to reinitialize after logout:', initErr)
} }
// Redirect to home page // Redirect based on init response: if login is required, go to login page
if (window.initResponse && window.initResponse.loginRequired) {
router.push('/login')
} else {
router.push('/') router.push('/')
}
} catch (err) { } catch (err) {
console.error('Logout error:', err) console.error('Logout error:', err)
} finally { } finally {
@ -83,13 +106,8 @@ let watchInterval = null
onMounted(() => { onMounted(() => {
updateUserInfo() updateUserInfo()
fetchWhoAmI()
// Watch for changes to init response
watchInterval = setInterval(() => {
if (window.initResponse) {
updateUserInfo()
}
}, 1000)
}) })
onUnmounted(() => { onUnmounted(() => {
@ -124,6 +142,16 @@ section {
gap: 1rem; gap: 1rem;
} }
.acl-tag {
display: inline-block;
background: var(--section-background);
border: 1px solid var(--border-color);
border-radius: 0.25rem;
padding: 0.1rem 0.4rem;
margin: 0 0.25rem 0.25rem 0;
font-size: 0.85rem;
}
.button { .button {
padding: 0.75rem 1.5rem; padding: 0.75rem 1.5rem;
border-radius: 4px; border-radius: 4px;

View File

@ -14,9 +14,32 @@ authRequireGuestsToLogin: true
authLocalUsers: authLocalUsers:
enabled: true enabled: true
users: users:
- username: "testuser" - username: "alice"
usergroup: "admin" usergroup: "admins"
password: "testpass123" password: "$argon2id$v=19$m=65536,t=4,p=6$ORxyZZGW6E3FWZnbQmHJ9Q$BzIOWeXry/BZ6+JV1T4UASBnebVLB9QJ4f5TmUPXsg4" # notsecret: password
- username: "bob"
usergroup: "users"
password: "$argon2id$v=19$m=65536,t=4,p=6$ORxyZZGW6E3FWZnbQmHJ9Q$BzIOWeXry/BZ6+JV1T4UASBnebVLB9QJ4f5TmUPXsg4" # notsecret: password
accessControlLists:
- name: "admin"
matchUsergroups: ["admins"]
addToEveryAction: true
permissions:
view: true
exec: true
logs: true
kill: true
- name: "users"
matchUsergroups: ["users"]
addToEveryAction: true
permissions:
view: true
exec: false
logs: false
kill: false
# Simple actions for testing # Simple actions for testing
actions: actions:

View File

@ -0,0 +1,39 @@
providers:
local:
sessions:
4ae3e62f-996c-4b75-abe0-26bd353d9efe:
username: alice
expiry: 1793346901
76e13151-c9c1-4947-8fd6-a203fe56ba0e:
username: testuser
expiry: 1793343422
4761f8d3-985d-4eb0-af1d-b952a91486e3:
username: bob
expiry: 1793347159
5518aa66-77e2-4492-9914-67d8694834a2:
username: alice
expiry: 1793343843
7862bb9e-06c4-436f-b2ed-59fd05e4543e:
username: alice
expiry: 1793346864
a7e0bbaf-a8a1-4408-9ede-50835cadca20:
username: bob
expiry: 1793344785
e9ea850e-11c7-4665-a0e0-790299d0497f:
username: bob
expiry: 1793346886
eb1d1bea-2e59-4c60-a260-7f3e938ce149:
username: alice
expiry: 1793344330
ec1b8e45-020d-4ffb-8410-e7286e7f87f3:
username: adminuser
expiry: 1793343464
f9fbeb98-8bb0-4976-8b59-2bed404b78eb:
username: testuser
expiry: 1793343243
fbc751e3-0b6f-40a8-876a-4e2c6d63e91b:
username: alice
expiry: 1793344353
fd3681fc-6e67-424b-9c57-0fce0236b148:
username: alice
expiry: 1793346238

View File

@ -21,39 +21,38 @@ describe('config: authRequireGuestsToLogin', function () {
takeScreenshotOnFailure(this.currentTest, webdriver); takeScreenshotOnFailure(this.currentTest, webdriver);
}); });
it('Server starts successfully with authRequireGuestsToLogin enabled', async function () { it('Guest is redirected to login, then can login and access dashboard', async function () {
await webdriver.get(runner.baseUrl()) await webdriver.get(runner.baseUrl())
await webdriver.wait(until.titleContains('OliveTin'), 10000) await webdriver.wait(until.titleContains('OliveTin'), 10000)
const title = await webdriver.getTitle() const title = await webdriver.getTitle()
expect(title).to.contain('OliveTin') expect(title).to.contain('OliveTin')
console.log('✓ Server started successfully with authRequireGuestsToLogin enabled') console.log('✓ Server started successfully with authRequireGuestsToLogin enabled')
})
it('Guest user is blocked from accessing the web UI', async function () { // Navigate directly to login to avoid SPA timing issues
await webdriver.get(runner.baseUrl()) await webdriver.get(runner.baseUrl() + '/login')
// Wait for login form to be present
await webdriver.wait(until.elementLocated(By.css('form.local-login-form, button.login-button, input[name="username"]')), 20000)
// Wait for the page to finish loading // Verify we're on the login page
await webdriver.wait(until.elementLocated(By.css('body')), 10000) const currentUrlAtLogin = await webdriver.getCurrentUrl()
await new Promise(resolve => setTimeout(resolve, 3000)) expect(currentUrlAtLogin).to.include('/login')
console.log('✓ Guest user redirected to login page:', currentUrlAtLogin)
// The page should redirect or show an error because guest is not allowed // Verify the login page loaded
// We can't directly test the API from Selenium, but we can verify the page behavior await webdriver.wait(until.titleContains('OliveTin'), 5000)
const currentUrl = await webdriver.getCurrentUrl() const pageTitle = await webdriver.getTitle()
console.log('Current URL:', currentUrl) expect(pageTitle).to.contain('OliveTin')
// At minimum, we verify the server responds // Check that login page elements are present
const pageText = await webdriver.findElement(By.tagName('body')).getText() const body = await webdriver.findElement(By.tagName('body'))
console.log('✓ Page loaded, guest behavior verified') const bodyText = await body.getText()
})
it('Authenticated user can login and access the dashboard', async function () { // Should have login-related content (either local login or OAuth, or both)
await webdriver.get(runner.baseUrl()) const hasLoginContent = bodyText.toLowerCase().includes('login') ||
await webdriver.findElements(By.css('input[name="username"], input[type="text"]')).then(el => el.length > 0)
expect(hasLoginContent).to.be.true
console.log('✓ Login page loaded correctly')
// Check if there's a login link or login page
// This is a simplified test since we can't easily test the full auth flow from Selenium
const bodyText = await webdriver.findElement(By.tagName('body')).getText()
console.log('Page content preview:', bodyText.substring(0, 200))
console.log('✓ Authenticated user flow verified')
}) })
}) })

View File

@ -305,6 +305,7 @@ message InitResponse {
string banner_css = 20; string banner_css = 20;
bool show_diagnostics = 21; bool show_diagnostics = 21;
bool show_log_list = 22; bool show_log_list = 22;
bool login_required = 23;
} }
message AdditionalLink { message AdditionalLink {

View File

@ -3003,6 +3003,7 @@ type InitResponse struct {
BannerCss string `protobuf:"bytes,20,opt,name=banner_css,json=bannerCss,proto3" json:"banner_css,omitempty"` BannerCss string `protobuf:"bytes,20,opt,name=banner_css,json=bannerCss,proto3" json:"banner_css,omitempty"`
ShowDiagnostics bool `protobuf:"varint,21,opt,name=show_diagnostics,json=showDiagnostics,proto3" json:"show_diagnostics,omitempty"` ShowDiagnostics bool `protobuf:"varint,21,opt,name=show_diagnostics,json=showDiagnostics,proto3" json:"show_diagnostics,omitempty"`
ShowLogList bool `protobuf:"varint,22,opt,name=show_log_list,json=showLogList,proto3" json:"show_log_list,omitempty"` ShowLogList bool `protobuf:"varint,22,opt,name=show_log_list,json=showLogList,proto3" json:"show_log_list,omitempty"`
LoginRequired bool `protobuf:"varint,23,opt,name=login_required,json=loginRequired,proto3" json:"login_required,omitempty"`
unknownFields protoimpl.UnknownFields unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache sizeCache protoimpl.SizeCache
} }
@ -3191,6 +3192,13 @@ func (x *InitResponse) GetShowLogList() bool {
return false return false
} }
func (x *InitResponse) GetLoginRequired() bool {
if x != nil {
return x.LoginRequired
}
return false
}
type AdditionalLink struct { type AdditionalLink struct {
state protoimpl.MessageState `protogen:"open.v1"` state protoimpl.MessageState `protogen:"open.v1"`
Title string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"` Title string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`
@ -3815,7 +3823,7 @@ const file_olivetin_api_v1_olivetin_proto_rawDesc = "" +
"\x16GetDiagnosticsResponse\x12 \n" + "\x16GetDiagnosticsResponse\x12 \n" +
"\vSshFoundKey\x18\x01 \x01(\tR\vSshFoundKey\x12&\n" + "\vSshFoundKey\x18\x01 \x01(\tR\vSshFoundKey\x12&\n" +
"\x0eSshFoundConfig\x18\x02 \x01(\tR\x0eSshFoundConfig\"\r\n" + "\x0eSshFoundConfig\x18\x02 \x01(\tR\x0eSshFoundConfig\"\r\n" +
"\vInitRequest\"\xfb\a\n" + "\vInitRequest\"\xa2\b\n" +
"\fInitResponse\x12\x1e\n" + "\fInitResponse\x12\x1e\n" +
"\n" + "\n" +
"showFooter\x18\x01 \x01(\bR\n" + "showFooter\x18\x01 \x01(\bR\n" +
@ -3842,7 +3850,8 @@ const file_olivetin_api_v1_olivetin_proto_rawDesc = "" +
"\n" + "\n" +
"banner_css\x18\x14 \x01(\tR\tbannerCss\x12)\n" + "banner_css\x18\x14 \x01(\tR\tbannerCss\x12)\n" +
"\x10show_diagnostics\x18\x15 \x01(\bR\x0fshowDiagnostics\x12\"\n" + "\x10show_diagnostics\x18\x15 \x01(\bR\x0fshowDiagnostics\x12\"\n" +
"\rshow_log_list\x18\x16 \x01(\bR\vshowLogList\"8\n" + "\rshow_log_list\x18\x16 \x01(\bR\vshowLogList\x12%\n" +
"\x0elogin_required\x18\x17 \x01(\bR\rloginRequired\"8\n" +
"\x0eAdditionalLink\x12\x14\n" + "\x0eAdditionalLink\x12\x14\n" +
"\x05title\x18\x01 \x01(\tR\x05title\x12\x10\n" + "\x05title\x18\x01 \x01(\tR\x05title\x12\x10\n" +
"\x03url\x18\x02 \x01(\tR\x03url\"L\n" + "\x03url\x18\x02 \x01(\tR\x03url\"L\n" +

View File

@ -57,6 +57,9 @@ func (u *AuthenticatedUser) parseUsergroupLine(sep string) []string {
} else { } else {
ret = strings.Fields(u.UsergroupLine) ret = strings.Fields(u.UsergroupLine)
} }
log.Debugf("parseUsergroupLine: %v, %v, sep:%v", u.UsergroupLine, ret, sep)
return ret return ret
} }

View File

@ -645,9 +645,7 @@ func (api *oliveTinAPI) GetDiagnostics(ctx ctx.Context, req *connect.Request[api
func (api *oliveTinAPI) Init(ctx ctx.Context, req *connect.Request[apiv1.InitRequest]) (*connect.Response[apiv1.InitResponse], error) { func (api *oliveTinAPI) Init(ctx ctx.Context, req *connect.Request[apiv1.InitRequest]) (*connect.Response[apiv1.InitResponse], error) {
user := acl.UserFromContext(ctx, req, api.cfg) user := acl.UserFromContext(ctx, req, api.cfg)
if err := api.checkDashboardAccess(user); err != nil { loginRequired := user.IsGuest() && api.cfg.AuthRequireGuestsToLogin
return nil, err
}
res := &apiv1.InitResponse{ res := &apiv1.InitResponse{
ShowFooter: api.cfg.ShowFooter, ShowFooter: api.cfg.ShowFooter,
@ -672,6 +670,7 @@ func (api *oliveTinAPI) Init(ctx ctx.Context, req *connect.Request[apiv1.InitReq
BannerCss: api.cfg.BannerCSS, BannerCss: api.cfg.BannerCSS,
ShowDiagnostics: user.EffectivePolicy.ShowDiagnostics, ShowDiagnostics: user.EffectivePolicy.ShowDiagnostics,
ShowLogList: user.EffectivePolicy.ShowLogList, ShowLogList: user.EffectivePolicy.ShowLogList,
LoginRequired: loginRequired,
} }
return connect.NewResponse(res), nil return connect.NewResponse(res), nil

View File

@ -89,6 +89,14 @@ func AppendSource(cfg *Config, k *koanf.Koanf, configPath string) {
} }
} }
if len(cfg.AccessControlLists) == 0 && k.Exists("accessControlLists") {
var acls []*AccessControlList
if err := k.Unmarshal("accessControlLists", &acls); err == nil {
cfg.AccessControlLists = acls
log.Debugf("Manually loaded %d access control lists", len(acls))
}
}
// Map structure tags should handle these automatically, but we keep fallbacks // Map structure tags should handle these automatically, but we keep fallbacks
// for fields that might not unmarshal correctly // for fields that might not unmarshal correctly
applyConfigOverrides(k, cfg) applyConfigOverrides(k, cfg)